intelephense
1.14.41.16.1
lib/stub/memcache/memcache.phplib/stub/memcache/memcache.php+391−27
Index: package/lib/stub/memcache/memcache.php
===================================================================
--- package/lib/stub/memcache/memcache.php
+++ package/lib/stub/memcache/memcache.php
@@ -128,17 +128,22 @@
* @return bool <p>Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.</p>
*/
public function setServerParams($host, $port = 11211, $timeout = 1, $retry_interval = 15, $status = true, callable $failure_callback = null) {}
- public function setFailureCallback() {}
+ /**
+ * @param callable $callback
+ *
+ * @return bool <p>Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.</p>
+ */
+ public function setFailureCallback(callable $callback) {}
/**
* (PECL memcache >= 2.1.0)<br/>
* Returns server status
* @link https://php.net/manual/en/memcache.getserverstatus.php
* @param string $host Point to the host where memcached is listening for connections.
* @param int $port Point to the port where memcached is listening for connections.
- * @return int Returns a the servers status. 0 if server is failed, non-zero otherwise
+ * @return int Returns the servers status. 0 if server is failed, non-zero otherwise
*/
public function getServerStatus($host, $port = 11211) {}
public function findServer() {}
@@ -194,16 +199,34 @@
* @return bool Returns TRUE on success or FALSE on failure.
*/
public function replace($key, $var, $flag = null, $expire = null) {}
- public function cas() {}
+ /**
+ * @param string $key <p>The key that will be associated with the item.</p>
+ * @param mixed $var <p>The variable to store. Strings and integers are stored as is, other types are stored serialized.</p>
+ * @param int $flag [optional] <p>Use <b>MEMCACHE_COMPRESSED</b> to store the item compressed (uses zlib).</p>
+ * @param int $expire [optional] <p>Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).</p>
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+ public function cas($key, $var, $flag = null, $expire = null) {}
- public function append() {}
+ /**
+ * @param string $key <p>The key that will be associated with the item.</p>
+ * @param mixed $var <p>The variable to store. Strings and integers are stored as is, other types are stored serialized.</p>
+ * @param int $flag [optional] <p>Use <b>MEMCACHE_COMPRESSED</b> to store the item compressed (uses zlib).</p>
+ * @param int $expire [optional] <p>Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).</p>
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+ public function append($key, $var, $flag = null, $expire = null) {}
/**
- * @return string
+ * @param string $key <p>The key that will be associated with the item.</p>
+ * @param mixed $var <p>The variable to store. Strings and integers are stored as is, other types are stored serialized.</p>
+ * @param int $flag [optional] <p>Use <b>MEMCACHE_COMPRESSED</b> to store the item compressed (uses zlib).</p>
+ * @param int $expire [optional] <p>Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).</p>
+ * @return bool Returns TRUE on success or FALSE on failure.
*/
- public function prepend() {}
+ public function prepend($key, $var, $flag = null, $expire = null) {}
/**
* (PECL memcache >= 0.2.0)<br/>
* Retrieve item from the server
@@ -216,8 +239,9 @@
* flags are the same as the ones given to for example {@link https://php.net/manual/en/memcache.set.php Memcache::set()}.
* The lowest byte of the int is reserved for pecl/memcache internal usage (e.g. to indicate
* compression and serialization status).
* </p>
+ * @param-out int|array $flags
* @return string|array|false <p>
* Returns the string associated with the <b>key</b> or
* an array of found key-value pairs when <b>key</b> is an {@link https://php.net/manual/en/language.types.array.php array}.
* Returns <b>FALSE</b> on failure, <b>key</b> is not found or
@@ -372,9 +396,9 @@
* </p>
* @param int $timeout [optional] <p>
* Value in seconds which will be used for connecting to the daemon.
* </p>
- * @return bool Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
+ * @return Memcache
*/
function memcache_connect($host, $port, $timeout = 1) {}
/**
@@ -388,33 +412,274 @@
* @return Memcache
*/
function memcache_pconnect($host, $port = null, $timeout = 1) {}
-function memcache_add_server() {}
+/**
+ * (PECL memcache >= 2.0.0)<br/>
+ * Add a memcached server to connection pool
+ * @link https://php.net/manual/en/memcache.addserver.php
+ * @param Memcache $memcache
+ * @param string $host <p>
+ * Point to the host where memcached is listening for connections. This parameter
+ * may also specify other transports like unix:///path/to/memcached.sock
+ * to use UNIX domain sockets, in this case <i>port</i> must also
+ * be set to 0.
+ * </p>
+ * @param int $port [optional] <p>
+ * Point to the port where memcached is listening for connections.
+ * Set this
+ * parameter to 0 when using UNIX domain sockets.
+ * </p>
+ * <p>
+ * Please note: <i>port</i> defaults to
+ * memcache.default_port
+ * if not specified. For this reason it is wise to specify the port
+ * explicitly in this method call.
+ * </p>
+ * @param bool $persistent [optional] <p>
+ * Controls the use of a persistent connection. Default to <b>TRUE</b>.
+ * </p>
+ * @param int $weight [optional] <p>
+ * Number of buckets to create for this server which in turn control its
+ * probability of it being selected. The probability is relative to the
+ * total weight of all servers.
+ * </p>
+ * @param int $timeout [optional] <p>
+ * Value in seconds which will be used for connecting to the daemon. Think
+ * twice before changing the default value of 1 second - you can lose all
+ * the advantages of caching if your connection is too slow.
+ * </p>
+ * @param int $retry_interval [optional] <p>
+ * Controls how often a failed server will be retried, the default value
+ * is 15 seconds. Setting this parameter to -1 disables automatic retry.
+ * Neither this nor the <i>persistent</i> parameter has any
+ * effect when the extension is loaded dynamically via <b>dl</b>.
+ * </p>
+ * <p>
+ * Each failed connection struct has its own timeout and before it has expired
+ * the struct will be skipped when selecting backends to serve a request. Once
+ * expired the connection will be successfully reconnected or marked as failed
+ * for another <i>retry_interval</i> seconds. The typical
+ * effect is that each web server child will retry the connection about every
+ * <i>retry_interval</i> seconds when serving a page.
+ * </p>
+ * @param bool $status [optional] <p>
+ * Controls if the server should be flagged as online. Setting this parameter
+ * to <b>FALSE</b> and <i>retry_interval</i> to -1 allows a failed
+ * server to be kept in the pool so as not to affect the key distribution
+ * algorithm. Requests for this server will then failover or fail immediately
+ * depending on the <i>memcache.allow_failover</i> setting.
+ * Default to <b>TRUE</b>, meaning the server should be considered online.
+ * </p>
+ * @param callable $failure_callback [optional] <p>
+ * Allows the user to specify a callback function to run upon encountering an
+ * error. The callback is run before failover is attempted. The function takes
+ * two parameters, the hostname and port of the failed server.
+ * </p>
+ * @param int $timeoutms [optional] <p>
+ * </p>
+ * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
+ */
+function memcache_add_server($memcache, $host, $port = 11211, $persistent = true, $weight = null, $timeout = 1, $retry_interval = 15, $status = true, callable $failure_callback = null, $timeoutms = null) {}
-function memcache_set_server_params() {}
+/**
+ * (PECL memcache >= 2.1.0)<br/>
+ * Changes server parameters and status at runtime
+ *
+ * @link https://secure.php.net/manual/en/memcache.setserverparams.php
+ *
+ * @param Memcache $memcache
+ * @param string $host <p>Point to the host where memcached is listening for connections.</p>.
+ * @param int $port [optional] <p>
+ * Point to the port where memcached is listening for connections.
+ * </p>
+ * @param int $timeout [optional] <p>
+ * Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow.
+ * </p>
+ * @param int $retry_interval [optional] <p>
+ * Controls how often a failed server will be retried, the default value
+ * is 15 seconds. Setting this parameter to -1 disables automatic retry.
+ * Neither this nor the <b>persistent</b> parameter has any
+ * effect when the extension is loaded dynamically via {@link https://secure.php.net/manual/en/function.dl.php dl()}.
+ * </p>
+ * @param bool $status [optional] <p>
+ * Controls if the server should be flagged as online. Setting this parameter
+ * to <b>FALSE</b> and <b>retry_interval</b> to -1 allows a failed
+ * server to be kept in the pool so as not to affect the key distribution
+ * algorithm. Requests for this server will then failover or fail immediately
+ * depending on the <b>memcache.allow_failover</b> setting.
+ * Default to <b>TRUE</b>, meaning the server should be considered online.
+ * </p>
+ * @param callable $failure_callback [optional] <p>
+ * Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attempted.
+ * The function takes two parameters, the hostname and port of the failed server.
+ * </p>
+ *
+ * @return bool <p>Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.</p>
+ */
+function memcache_set_server_params($memcache, $host, $port = 11211, $timeout = 1, $retry_interval = 15, $status = true, callable $failure_callback = null) {}
-function memcache_set_failure_callback() {}
+/**
+ * @param Memcache $memcache
+ * @param callable $callback
+ *
+ * @return bool <p>Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.</p>
+ */
+function memcache_set_failure_callback($memcache, $callback) {}
-function memcache_get_server_status() {}
+/**
+ * (PECL memcache >= 2.1.0)<br/>
+ * Returns server status
+ *
+ * @link https://php.net/manual/en/memcache.getserverstatus.php
+ *
+ * @param Memcache $memcache
+ * @param string $host Point to the host where memcached is listening for connections.
+ * @param int $port Point to the port where memcached is listening for connections.
+ *
+ * @return int Returns the servers status. 0 if server is failed, non-zero otherwise
+ */
+function memcache_get_server_status($memcache, $host, $port = 11211) {}
-function memcache_get_version() {}
+/**
+ * (PECL memcache >= 0.2.0)<br/>
+ * Return version of the server
+ *
+ * @link https://php.net/manual/en/memcache.getversion.php
+ *
+ * @param Memcache $memcache
+ *
+ * @return string|false Returns a string of server version number or <b>FALSE</b> on failure.
+ */
+function memcache_get_version($memcache) {}
-function memcache_add() {}
+/**
+ * (PECL memcache >= 2.0.0)<br/>
+ * Add an item to the server. If the key already exists, the value will not be added and <b>FALSE</b> will be returned.
+ *
+ * @link https://php.net/manual/en/memcache.add.php
+ *
+ * @param Memcache $memcache
+ * @param string $key The key that will be associated with the item.
+ * @param mixed $var The variable to store. Strings and integers are stored as is, other types are stored serialized.
+ * @param int $flag [optional] <p>
+ * Use <b>MEMCACHE_COMPRESSED</b> to store the item
+ * compressed (uses zlib).
+ * </p>
+ * @param int $expire [optional] <p>Expiration time of the item.
+ * If it's equal to zero, the item will never expire.
+ * You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).</p>
+ *
+ * @return bool Returns <b>TRUE</b> on success or <b>FALSE</b> on failure. Returns <b>FALSE</b> if such key already exist. For the rest Memcache::add() behaves similarly to Memcache::set().
+ */
+function memcache_add($memcache, $key, $var, $flag = null, $expire = null) {}
-function memcache_set() {}
+/**
+ * (PECL memcache >= 0.2.0)<br/>
+ * Stores an item var with key on the memcached server. Parameter expire is expiration time in seconds.
+ * If it's 0, the item never expires (but memcached server doesn't guarantee this item to be stored all the time,
+ * it could be deleted from the cache to make place for other items).
+ * You can use MEMCACHE_COMPRESSED constant as flag value if you want to use on-the-fly compression (uses zlib).
+ *
+ * @link https://php.net/manual/en/memcache.set.php
+ *
+ * @param Memcache $memcache
+ * @param string $key The key that will be associated with the item.
+ * @param mixed $var The variable to store. Strings and integers are stored as is, other types are stored serialized.
+ * @param int $flag [optional] Use MEMCACHE_COMPRESSED to store the item compressed (uses zlib).
+ * @param int $expire [optional] Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).
+ *
+ * @return bool Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
+ */
+function memcache_set($memcache, $key, $var, $flag = null, $expire = null) {}
-function memcache_replace() {}
+/**
+ * (PECL memcache >= 0.2.0)<br/>
+ * Replace value of the existing item
+ *
+ * @link https://php.net/manual/en/memcache.replace.php
+ *
+ * @param Memcache $memcache
+ * @param string $key <p>The key that will be associated with the item.</p>
+ * @param mixed $var <p>The variable to store. Strings and integers are stored as is, other types are stored serialized.</p>
+ * @param int $flag [optional] <p>Use <b>MEMCACHE_COMPRESSED</b> to store the item compressed (uses zlib).</p>
+ * @param int $expire [optional] <p>Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).</p>
+ *
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+function memcache_replace($memcache, $key, $var, $flag = null, $expire = null) {}
-function memcache_cas() {}
+/**
+ * @param Memcache $memcache
+ * @param string $key <p>The key that will be associated with the item.</p>
+ * @param mixed $var <p>The variable to store. Strings and integers are stored as is, other types are stored serialized.</p>
+ * @param int $flag [optional] <p>Use <b>MEMCACHE_COMPRESSED</b> to store the item compressed (uses zlib).</p>
+ * @param int $expire [optional] <p>Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).</p>
+ *
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+function memcache_cas($memcache, $key, $var, $flag = null, $expire = null) {}
-function memcache_append() {}
+/**
+ * @param Memcache $memcache
+ * @param string $key <p>The key that will be associated with the item.</p>
+ * @param mixed $var <p>The variable to store. Strings and integers are stored as is, other types are stored serialized.</p>
+ * @param int $flag [optional] <p>Use <b>MEMCACHE_COMPRESSED</b> to store the item compressed (uses zlib).</p>
+ * @param int $expire [optional] <p>Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).</p>
+ *
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+function memcache_append($memcache, $key, $var, $flag = null, $expire = null) {}
-function memcache_prepend() {}
+/**
+ * @param Memcache $memcache
+ * @param string $key <p>The key that will be associated with the item.</p>
+ * @param mixed $var <p>The variable to store. Strings and integers are stored as is, other types are stored serialized.</p>
+ * @param int $flag [optional] <p>Use <b>MEMCACHE_COMPRESSED</b> to store the item compressed (uses zlib).</p>
+ * @param int $expire [optional] <p>Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).</p>
+ *
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+function memcache_prepend($memcache, $key, $var, $flag = null, $expire = null) {}
-function memcache_get() {}
+/**
+ * (PECL memcache >= 0.2.0)<br/>
+ * Retrieve item from the server
+ *
+ * @link https://php.net/manual/en/memcache.get.php
+ *
+ * @param Memcache $memcache
+ * @param string|array $key <p>
+ * The key or array of keys to fetch.
+ * </p>
+ * @param int|array &$flags [optional] <p>
+ * If present, flags fetched along with the values will be written to this parameter. These
+ * flags are the same as the ones given to for example {@link https://php.net/manual/en/memcache.set.php Memcache::set()}.
+ * The lowest byte of the int is reserved for pecl/memcache internal usage (e.g. to indicate
+ * compression and serialization status).
+ * </p>
+ *
+ * @return string|array|false <p>
+ * Returns the string associated with the <b>key</b> or
+ * an array of found key-value pairs when <b>key</b> is an {@link https://php.net/manual/en/language.types.array.php array}.
+ * Returns <b>FALSE</b> on failure, <b>key</b> is not found or
+ * <b>key</b> is an empty {@link https://php.net/manual/en/language.types.array.php array}.
+ * </p>
+ */
+function memcache_get($memcache, $key, &$flags = null) {}
-function memcache_delete() {}
+/**
+ * (PECL memcache >= 0.2.0)<br/>
+ * Delete item from the server
+ * https://secure.php.net/manual/en/memcache.delete.php
+ *
+ * @param Memcache $memcache
+ * @param string $key The key associated with the item to delete.
+ * @param int $timeout [optional] This deprecated parameter is not supported, and defaults to 0 seconds. Do not use this parameter.
+ *
+ * @return bool Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
+ */
+function memcache_delete($memcache, $key, $timeout = 0) {}
/**
* (PECL memcache >= 0.2.0)<br/>
* Turn debug output on/off
@@ -427,21 +692,120 @@
* returns <b>FALSE</b>.
*/
function memcache_debug($on_off) {}
-function memcache_get_stats() {}
+/**
+ * (PECL memcache >= 0.2.0)<br/>
+ * Get statistics of the server
+ *
+ * @link https://php.net/manual/en/memcache.getstats.php
+ *
+ * @param Memcache $memcache
+ * @param string $type [optional] <p>
+ * The type of statistics to fetch.
+ * Valid values are {reset, malloc, maps, cachedump, slabs, items, sizes}.
+ * According to the memcached protocol spec these additional arguments "are subject to change for the convenience of memcache developers".</p>
+ * @param int $slabid [optional] <p>
+ * Used in conjunction with <b>type</b> set to
+ * cachedump to identify the slab to dump from. The cachedump
+ * command ties up the server and is strictly to be used for
+ * debugging purposes.
+ * </p>
+ * @param int $limit [optional] <p>
+ * Used in conjunction with <b>type</b> set to cachedump to limit the number of entries to dump.
+ * </p>
+ *
+ * @return array|false Returns an associative array of server statistics or <b>FALSE</b> on failure.
+ */
+function memcache_get_stats($memcache, $type = null, $slabid = null, $limit = 100) {}
-function memcache_get_extended_stats() {}
+/**
+ * (PECL memcache >= 2.0.0)<br/>
+ * Get statistics from all servers in pool
+ *
+ * @link https://php.net/manual/en/memcache.getextendedstats.php
+ *
+ * @param Memcache $memcache
+ * @param string $type [optional] <p>The type of statistics to fetch. Valid values are {reset, malloc, maps, cachedump, slabs, items, sizes}. According to the memcached protocol spec these additional arguments "are subject to change for the convenience of memcache developers".</p>
+ * @param int $slabid [optional] <p>
+ * Used in conjunction with <b>type</b> set to
+ * cachedump to identify the slab to dump from. The cachedump
+ * command ties up the server and is strictly to be used for
+ * debugging purposes.
+ * </p>
+ * @param int $limit Used in conjunction with type set to cachedump to limit the number of entries to dump.
+ *
+ * @return array|false Returns a two-dimensional associative array of server statistics or <b>FALSE</b>
+ * Returns a two-dimensional associative array of server statistics or <b>FALSE</b>
+ * on failure.
+ */
+function memcache_get_extended_stats($type = null, $slabid = null, $limit = 100) {}
-function memcache_set_compress_threshold() {}
+/**
+ * (PECL memcache >= 2.0.0)<br/>
+ * Enable automatic compression of large values
+ *
+ * @link https://php.net/manual/en/memcache.setcompressthreshold.php
+ *
+ * @param Memcache $memcache
+ * @param int $thresold <p>Controls the minimum value length before attempting to compress automatically.</p>
+ * @param float $min_saving [optional] <p>Specifies the minimum amount of savings to actually store the value compressed. The supplied value must be between 0 and 1. Default value is 0.2 giving a minimum 20% compression savings.</p>
+ *
+ * @return bool Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
+ */
+function memcache_set_compress_threshold($memcache, $thresold, $min_saving = 0.2) {}
-function memcache_increment() {}
+/**
+ * (PECL memcache >= 0.2.0)<br/>
+ * Increment item's value
+ *
+ * @link https://php.net/manual/en/memcache.increment.php
+ *
+ * @param Memcache $memcache
+ * @param string $key Key of the item to increment.
+ * @param int $value [optional] increment the item by <b>value</b>
+ *
+ * @return int|false Returns new items value on success or <b>FALSE</b> on failure.
+ */
+function memcache_increment($memcache, $key, $value = 1) {}
-function memcache_decrement() {}
+/**
+ * (PECL memcache >= 0.2.0)<br/>
+ * Decrement item's value
+ *
+ * @link https://php.net/manual/en/memcache.decrement.php
+ *
+ * @param Memcache $memcache
+ * @param string $key Key of the item do decrement.
+ * @param int $value Decrement the item by <b>value</b>.
+ *
+ * @return int|false Returns item's new value on success or <b>FALSE</b> on failure.
+ */
+function memcache_decrement($memcache, $key, $value = 1) {}
-function memcache_close() {}
+/**
+ * (PECL memcache >= 0.4.0)<br/>
+ * Close memcached server connection
+ *
+ * @link https://php.net/manual/en/memcache.close.php
+ *
+ * @param Memcache $memcache
+ *
+ * @return bool Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
+ */
+function memcache_close($memcache) {}
-function memcache_flush() {}
+/**
+ * (PECL memcache >= 1.0.0)<br/>
+ * Flush all existing items at the server
+ *
+ * @link https://php.net/manual/en/memcache.flush.php
+ *
+ * @param Memcache $memcache
+ *
+ * @return bool Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
+ */
+function memcache_flush($memcache) {}
define('MEMCACHE_COMPRESSED', 2);
define('MEMCACHE_USER1', 65536);
define('MEMCACHE_USER2', 131072);