+ * $redis->connect('127.0.0.1', 6379);
+ * $redis->connect('127.0.0.1'); // port 6379 by default
+ * $redis->connect('127.0.0.1', 6379, 2.5); // 2.5 sec timeout.
+ * $redis->connect('/tmp/redis.sock'); // unix domain socket.
+ *
+ */
+ public function connect(
+ $host,
+ $port = 6379,
+ $timeout = 0.0,
+ $reserved = null,
+ $retryInterval = 0,
+ $readTimeout = 0.0
+ ) {
+ }
+
+ /**
+ * Connects to a Redis instance.
+ *
+ * @param string $host can be a host, or the path to a unix domain socket
+ * @param int $port optional
+ * @param float $timeout value in seconds (optional, default is 0.0 meaning unlimited)
+ * @param null $reserved should be null if $retry_interval is specified
+ * @param int $retryInterval retry interval in milliseconds.
+ * @param float $readTimeout value in seconds (optional, default is 0 meaning unlimited)
+ *
+ * @return bool TRUE on success, FALSE on error
+ *
+ * @see connect()
+ * @deprecated use Redis::connect()
+ */
+ public function open(
+ $host,
+ $port = 6379,
+ $timeout = 0.0,
+ $reserved = null,
+ $retryInterval = 0,
+ $readTimeout = 0.0
+ ) {
+ }
+
+ /**
+ * A method to determine if a phpredis object thinks it's connected to a server
+ *
+ * @return bool Returns TRUE if phpredis thinks it's connected and FALSE if not
+ */
+ public function isConnected()
+ {
+ }
+
+ /**
+ * Retrieve our host or unix socket that we're connected to
+ *
+ * @return string|bool The host or unix socket we're connected to or FALSE if we're not connected
+ */
+ public function getHost()
+ {
+ }
+
+ /**
+ * Get the port we're connected to
+ *
+ * @return int|bool Returns the port we're connected to or FALSE if we're not connected
+ */
+ public function getPort()
+ {
+ }
+
+ /**
+ * Get the database number phpredis is pointed to
+ *
+ * @return int|bool Returns the database number (int) phpredis thinks it's pointing to
+ * or FALSE if we're not connected
+ */
+ public function getDbNum()
+ {
+ }
+
+ /**
+ * Get the (write) timeout in use for phpredis
+ *
+ * @return float|bool The timeout (DOUBLE) specified in our connect call or FALSE if we're not connected
+ */
+ public function getTimeout()
+ {
+ }
+
+ /**
+ * Get the read timeout specified to phpredis or FALSE if we're not connected
+ *
+ * @return float|bool Returns the read timeout (which can be set using setOption and Redis::OPT_READ_TIMEOUT)
+ * or FALSE if we're not connected
+ */
+ public function getReadTimeout()
+ {
+ }
+
+ /**
+ * Gets the persistent ID that phpredis is using
+ *
+ * @return string|null|bool Returns the persistent id phpredis is using
+ * (which will only be set if connected with pconnect),
+ * NULL if we're not using a persistent ID,
+ * and FALSE if we're not connected
+ */
+ public function getPersistentID()
+ {
+ }
+
+ /**
+ * Get the password used to authenticate the phpredis connection
+ *
+ * @return string|null|bool Returns the password used to authenticate a phpredis session or NULL if none was used,
+ * and FALSE if we're not connected
+ */
+ public function getAuth()
+ {
+ }
+
+ /**
+ * Connects to a Redis instance or reuse a connection already established with pconnect/popen.
+ *
+ * The connection will not be closed on close or end of request until the php process ends.
+ * So be patient on to many open FD's (specially on redis server side) when using persistent connections on
+ * many servers connecting to one redis server.
+ *
+ * Also more than one persistent connection can be made identified by either host + port + timeout
+ * or host + persistentId or unix socket + timeout.
+ *
+ * This feature is not available in threaded versions. pconnect and popen then working like their non persistent
+ * equivalents.
+ *
+ * @param string $host can be a host, or the path to a unix domain socket
+ * @param int $port optional
+ * @param float $timeout value in seconds (optional, default is 0 meaning unlimited)
+ * @param string $persistentId identity for the requested persistent connection
+ * @param int $retryInterval retry interval in milliseconds.
+ * @param float $readTimeout value in seconds (optional, default is 0 meaning unlimited)
+ *
+ * @return bool TRUE on success, FALSE on ertcnror.
+ *
+ * @example
+ *
+ * $redis->pconnect('127.0.0.1', 6379);
+ *
+ * // port 6379 by default - same connection like before
+ * $redis->pconnect('127.0.0.1');
+ *
+ * // 2.5 sec timeout and would be another connection than the two before.
+ * $redis->pconnect('127.0.0.1', 6379, 2.5);
+ *
+ * // x is sent as persistent_id and would be another connection than the three before.
+ * $redis->pconnect('127.0.0.1', 6379, 2.5, 'x');
+ *
+ * // unix domain socket - would be another connection than the four before.
+ * $redis->pconnect('/tmp/redis.sock');
+ *
+ */
+ public function pconnect(
+ $host,
+ $port = 6379,
+ $timeout = 0.0,
+ $persistentId = null,
+ $retryInterval = 0,
+ $readTimeout = 0.0
+ ) {
+ }
+
+ /**
+ * @param string $host
+ * @param int $port
+ * @param float $timeout
+ * @param string $persistentId
+ * @param int $retryInterval
+ * @param float $readTimeout
+ *
+ * @return bool
+ *
+ * @deprecated use Redis::pconnect()
+ * @see pconnect()
+ */
+ public function popen(
+ $host,
+ $port = 6379,
+ $timeout = 0.0,
+ $persistentId = '',
+ $retryInterval = 0,
+ $readTimeout = 0.0
+ ) {
+ }
+
+ /**
+ * Disconnects from the Redis instance.
+ *
+ * Note: Closing a persistent connection requires PhpRedis >= 4.2.0
+ *
+ * @since >= 4.2 Closing a persistent connection requires PhpRedis
+ *
+ * @return bool TRUE on success, FALSE on error
+ */
+ public function close()
+ {
+ }
+
+ /**
+ * Swap one Redis database with another atomically
+ *
+ * Note: Requires Redis >= 4.0.0
+ *
+ * @param int $db1
+ * @param int $db2
+ *
+ * @return bool TRUE on success and FALSE on failure
+ *
+ * @link https://redis.io/commands/swapdb
+ * @since >= 4.0
+ * @example
+ * + * // Swaps DB 0 with DB 1 atomically + * $redis->swapdb(0, 1); + *+ */ + public function swapdb(int $db1, int $db2) + { + } + + /** + * Set client option + * + * @param int $option option name + * @param mixed $value option value + * + * @return bool TRUE on success, FALSE on error + * + * @example + *
+ * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_NONE); // don't serialize data + * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_PHP); // use built-in serialize/unserialize + * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_IGBINARY); // use igBinary serialize/unserialize + * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_MSGPACK); // Use msgpack serialize/unserialize + * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_JSON); // Use json serialize/unserialize + * + * $redis->setOption(Redis::OPT_PREFIX, 'myAppName:'); // use custom prefix on all keys + * + * // Options for the SCAN family of commands, indicating whether to abstract + * // empty results from the user. If set to SCAN_NORETRY (the default), phpredis + * // will just issue one SCAN command at a time, sometimes returning an empty + * // array of results. If set to SCAN_RETRY, phpredis will retry the scan command + * // until keys come back OR Redis returns an iterator of zero + * $redis->setOption(Redis::OPT_SCAN, Redis::SCAN_NORETRY); + * $redis->setOption(Redis::OPT_SCAN, Redis::SCAN_RETRY); + *+ */ + public function setOption($option, $value) + { + } + + /** + * Get client option + * + * @param int $option parameter name + * + * @return mixed|null Parameter value + * + * @see setOption() + * @example + * // return option value + * $redis->getOption(Redis::OPT_SERIALIZER); + */ + public function getOption($option) + { + } + + /** + * Check the current connection status + * + * @return string STRING: +PONG on success. + * Throws a RedisException object on connectivity error, as described above. + * @throws RedisException + * @link https://redis.io/commands/ping + */ + public function ping() + { + } + + /** + * Echo the given string + * + * @param string $message + * + * @return string Returns message + * + * @link https://redis.io/commands/echo + */ + public function echo($message) + { + } + + /** + * Get the value related to the specified key + * + * @param string $key + * + * @return string|mixed|bool If key didn't exist, FALSE is returned. + * Otherwise, the value related to this key is returned + * + * @link https://redis.io/commands/get + * @example + *
+ * $redis->set('key', 'hello');
+ * $redis->get('key');
+ *
+ * // set and get with serializer
+ * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_JSON);
+ *
+ * $redis->set('key', ['asd' => 'as', 'dd' => 123, 'b' => true]);
+ * var_dump($redis->get('key'));
+ * // Output:
+ * array(3) {
+ * 'asd' => string(2) "as"
+ * 'dd' => int(123)
+ * 'b' => bool(true)
+ * }
+ *
+ */
+ public function get($key)
+ {
+ }
+
+ /**
+ * Set the string value in argument as value of the key.
+ *
+ * @since If you're using Redis >= 2.6.12, you can pass extended options as explained in example
+ *
+ * @param string $key
+ * @param string|mixed $value string if not used serializer
+ * @param int|array $timeout [optional] Calling setex() is preferred if you want a timeout.
+ * // Simple key -> value set
+ * $redis->set('key', 'value');
+ *
+ * // Will redirect, and actually make an SETEX call
+ * $redis->set('key','value', 10);
+ *
+ * // Will set the key, if it doesn't exist, with a ttl of 10 seconds
+ * $redis->set('key', 'value', ['nx', 'ex' => 10]);
+ *
+ * // Will set a key, if it does exist, with a ttl of 1000 miliseconds
+ * $redis->set('key', 'value', ['xx', 'px' => 1000]);
+ *
+ *
+ * @return bool TRUE if the command is successful
+ *
+ * @link https://redis.io/commands/set
+ */
+ public function set($key, $value, $timeout = null)
+ {
+ }
+
+ /**
+ * Set the string value in argument as value of the key, with a time to live.
+ *
+ * @param string $key
+ * @param int $ttl
+ * @param string|mixed $value
+ *
+ * @return bool TRUE if the command is successful
+ *
+ * @link https://redis.io/commands/setex
+ * @example $redis->setex('key', 3600, 'value'); // sets key → value, with 1h TTL.
+ */
+ public function setex($key, $ttl, $value)
+ {
+ }
+
+ /**
+ * Set the value and expiration in milliseconds of a key.
+ *
+ * @see setex()
+ * @param string $key
+ * @param int $ttl, in milliseconds.
+ * @param string|mixed $value
+ *
+ * @return bool TRUE if the command is successful
+ *
+ * @link https://redis.io/commands/psetex
+ * @example $redis->psetex('key', 1000, 'value'); // sets key → value, with 1sec TTL.
+ */
+ public function psetex($key, $ttl, $value)
+ {
+ }
+
+ /**
+ * Set the string value in argument as value of the key if the key doesn't already exist in the database.
+ *
+ * @param string $key
+ * @param string|mixed $value
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/setnx
+ * @example
+ *
+ * $redis->setnx('key', 'value'); // return TRUE
+ * $redis->setnx('key', 'value'); // return FALSE
+ *
+ */
+ public function setnx($key, $value)
+ {
+ }
+
+ /**
+ * Remove specified keys.
+ *
+ * @param int|string|array $key1 An array of keys, or an undefined number of parameters, each a key: key1 key2 key3 ... keyN
+ * @param int|string ...$otherKeys
+ *
+ * @return int Number of keys deleted
+ *
+ * @link https://redis.io/commands/del
+ * @example
+ *
+ * $redis->set('key1', 'val1');
+ * $redis->set('key2', 'val2');
+ * $redis->set('key3', 'val3');
+ * $redis->set('key4', 'val4');
+ *
+ * $redis->del('key1', 'key2'); // return 2
+ * $redis->del(['key3', 'key4']); // return 2
+ *
+ */
+ public function del($key1, ...$otherKeys)
+ {
+ }
+
+ /**
+ * @see del()
+ * @deprecated use Redis::del()
+ *
+ * @param string|string[] $key1
+ * @param string $key2
+ * @param string $key3
+ *
+ * @return int Number of keys deleted
+ */
+ public function delete($key1, $key2 = null, $key3 = null)
+ {
+ }
+
+ /**
+ * Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.
+ *
+ * @see del()
+ * @param string|string[] $key1
+ * @param string $key2
+ * @param string $key3
+ *
+ * @return int Number of keys unlinked.
+ *
+ * @link https://redis.io/commands/unlink
+ * @example
+ *
+ * $redis->set('key1', 'val1');
+ * $redis->set('key2', 'val2');
+ * $redis->set('key3', 'val3');
+ * $redis->set('key4', 'val4');
+ * $redis->unlink('key1', 'key2'); // return 2
+ * $redis->unlink(array('key3', 'key4')); // return 2
+ *
+ */
+ public function unlink($key1, $key2 = null, $key3 = null)
+ {
+ }
+
+ /**
+ * Enter and exit transactional mode.
+ *
+ * @param int $mode Redis::MULTI|Redis::PIPELINE
+ * Defaults to Redis::MULTI.
+ * A Redis::MULTI block of commands runs as a single transaction;
+ * a Redis::PIPELINE block is simply transmitted faster to the server, but without any guarantee of atomicity.
+ * discard cancels a transaction.
+ *
+ * @return Redis returns the Redis instance and enters multi-mode.
+ * Once in multi-mode, all subsequent method calls return the same object until exec() is called.
+ *
+ * @link https://redis.io/commands/multi
+ * @example
+ *
+ * $ret = $redis->multi()
+ * ->set('key1', 'val1')
+ * ->get('key1')
+ * ->set('key2', 'val2')
+ * ->get('key2')
+ * ->exec();
+ *
+ * //$ret == array (
+ * // 0 => TRUE,
+ * // 1 => 'val1',
+ * // 2 => TRUE,
+ * // 3 => 'val2');
+ *
+ */
+ public function multi($mode = Redis::MULTI)
+ {
+ }
+
+ /**
+ * @return void|array
+ *
+ * @see multi()
+ * @link https://redis.io/commands/exec
+ */
+ public function exec()
+ {
+ }
+
+ /**
+ * @see multi()
+ * @link https://redis.io/commands/discard
+ */
+ public function discard()
+ {
+ }
+
+ /**
+ * Watches a key for modifications by another client. If the key is modified between WATCH and EXEC,
+ * the MULTI/EXEC transaction will fail (return FALSE). unwatch cancels all the watching of all keys by this client.
+ * @param string|string[] $key a list of keys
+ *
+ * @return void
+ *
+ * @link https://redis.io/commands/watch
+ * @example
+ *
+ * $redis->watch('x');
+ * // long code here during the execution of which other clients could well modify `x`
+ * $ret = $redis->multi()
+ * ->incr('x')
+ * ->exec();
+ * // $ret = FALSE if x has been modified between the call to WATCH and the call to EXEC.
+ *
+ */
+ public function watch($key)
+ {
+ }
+
+ /**
+ * @see watch()
+ * @link https://redis.io/commands/unwatch
+ */
+ public function unwatch()
+ {
+ }
+
+ /**
+ * Subscribe to channels.
+ *
+ * Warning: this function will probably change in the future.
+ *
+ * @param string[] $channels an array of channels to subscribe
+ * @param string|array $callback either a string or an array($instance, 'method_name').
+ * The callback function receives 3 parameters: the redis instance, the channel name, and the message.
+ *
+ * @return mixed|null Any non-null return value in the callback will be returned to the caller.
+ *
+ * @link https://redis.io/commands/subscribe
+ * @example
+ *
+ * function f($redis, $chan, $msg) {
+ * switch($chan) {
+ * case 'chan-1':
+ * ...
+ * break;
+ *
+ * case 'chan-2':
+ * ...
+ * break;
+ *
+ * case 'chan-2':
+ * ...
+ * break;
+ * }
+ * }
+ *
+ * $redis->subscribe(array('chan-1', 'chan-2', 'chan-3'), 'f'); // subscribe to 3 chans
+ *
+ */
+ public function subscribe($channels, $callback)
+ {
+ }
+
+ /**
+ * Subscribe to channels by pattern
+ *
+ * @param array $patterns an array of glob-style patterns to subscribe
+ * @param string|array $callback Either a string or an array with an object and method.
+ * The callback will get four arguments ($redis, $pattern, $channel, $message)
+ * @param mixed $chan Any non-null return value in the callback will be returned to the caller
+ * @param string $msg
+ *
+ * @link https://redis.io/commands/psubscribe
+ * @example
+ *
+ * function psubscribe($redis, $pattern, $chan, $msg) {
+ * echo "Pattern: $pattern\n";
+ * echo "Channel: $chan\n";
+ * echo "Payload: $msg\n";
+ * }
+ *
+ */
+ public function psubscribe($patterns, $callback, $chan, $msg)
+ {
+ }
+
+ /**
+ * Publish messages to channels.
+ *
+ * Warning: this function will probably change in the future.
+ *
+ * @param string $channel a channel to publish to
+ * @param string $message string
+ *
+ * @return int Number of clients that received the message
+ *
+ * @link https://redis.io/commands/publish
+ * @example $redis->publish('chan-1', 'hello, world!'); // send message.
+ */
+ public function publish($channel, $message)
+ {
+ }
+
+ /**
+ * A command allowing you to get information on the Redis pub/sub system
+ *
+ * @param string $keyword String, which can be: "channels", "numsub", or "numpat"
+ * @param string|array $argument Optional, variant.
+ * For the "channels" subcommand, you can pass a string pattern.
+ * For "numsub" an array of channel names
+ *
+ * @return array|int Either an integer or an array.
+ * - channels Returns an array where the members are the matching channels.
+ * - numsub Returns a key/value array where the keys are channel names and
+ * values are their counts.
+ * - numpat Integer return containing the number active pattern subscriptions
+ *
+ * @link https://redis.io/commands/pubsub
+ * @example
+ *
+ * $redis->pubsub('channels'); // All channels
+ * $redis->pubsub('channels', '*pattern*'); // Just channels matching your pattern
+ * $redis->pubsub('numsub', array('chan1', 'chan2')); // Get subscriber counts for 'chan1' and 'chan2'
+ * $redis->pubsub('numpat'); // Get the number of pattern subscribers
+ *
+ */
+ public function pubsub($keyword, $argument)
+ {
+ }
+
+ /**
+ * Stop listening for messages posted to the given channels.
+ *
+ * @param array $channels an array of channels to usubscribe
+ *
+ * @link https://redis.io/commands/unsubscribe
+ */
+ public function unsubscribe($channels = null)
+ {
+ }
+
+ /**
+ * Stop listening for messages posted to the given channels.
+ *
+ * @param array $patterns an array of glob-style patterns to unsubscribe
+ *
+ * @link https://redis.io/commands/punsubscribe
+ */
+ public function punsubscribe($patterns = null)
+ {
+ }
+
+ /**
+ * Verify if the specified key/keys exists
+ *
+ * This function took a single argument and returned TRUE or FALSE in phpredis versions < 4.0.0.
+ *
+ * @since >= 4.0 Returned int, if < 4.0 returned bool
+ *
+ * @param string|string[] $key
+ *
+ * @return int|bool The number of keys tested that do exist
+ *
+ * @link https://redis.io/commands/exists
+ * @link https://github.com/phpredis/phpredis#exists
+ * @example
+ *
+ * $redis->exists('key'); // 1
+ * $redis->exists('NonExistingKey'); // 0
+ *
+ * $redis->mset(['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz']);
+ * $redis->exists(['foo', 'bar', 'baz]); // 3
+ * $redis->exists('foo', 'bar', 'baz'); // 3
+ *
+ */
+ public function exists($key)
+ {
+ }
+
+ /**
+ * Increment the number stored at key by one.
+ *
+ * @param string $key
+ *
+ * @return int the new value
+ *
+ * @link https://redis.io/commands/incr
+ * @example
+ *
+ * $redis->incr('key1'); // key1 didn't exists, set to 0 before the increment and now has the value 1
+ * $redis->incr('key1'); // 2
+ * $redis->incr('key1'); // 3
+ * $redis->incr('key1'); // 4
+ *
+ */
+ public function incr($key)
+ {
+ }
+
+ /**
+ * Increment the float value of a key by the given amount
+ *
+ * @param string $key
+ * @param float $increment
+ *
+ * @return float
+ *
+ * @link https://redis.io/commands/incrbyfloat
+ * @example
+ *
+ * $redis->set('x', 3);
+ * $redis->incrByFloat('x', 1.5); // float(4.5)
+ * $redis->get('x'); // float(4.5)
+ *
+ */
+ public function incrByFloat($key, $increment)
+ {
+ }
+
+ /**
+ * Increment the number stored at key by one.
+ * If the second argument is filled, it will be used as the integer value of the increment.
+ *
+ * @param string $key key
+ * @param int $value value that will be added to key (only for incrBy)
+ *
+ * @return int the new value
+ *
+ * @link https://redis.io/commands/incrby
+ * @example
+ *
+ * $redis->incr('key1'); // key1 didn't exists, set to 0 before the increment and now has the value 1
+ * $redis->incr('key1'); // 2
+ * $redis->incr('key1'); // 3
+ * $redis->incr('key1'); // 4
+ * $redis->incrBy('key1', 10); // 14
+ *
+ */
+ public function incrBy($key, $value)
+ {
+ }
+
+ /**
+ * Decrement the number stored at key by one.
+ *
+ * @param string $key
+ *
+ * @return int the new value
+ *
+ * @link https://redis.io/commands/decr
+ * @example
+ *
+ * $redis->decr('key1'); // key1 didn't exists, set to 0 before the increment and now has the value -1
+ * $redis->decr('key1'); // -2
+ * $redis->decr('key1'); // -3
+ *
+ */
+ public function decr($key)
+ {
+ }
+
+ /**
+ * Decrement the number stored at key by one.
+ * If the second argument is filled, it will be used as the integer value of the decrement.
+ *
+ * @param string $key
+ * @param int $value that will be substracted to key (only for decrBy)
+ *
+ * @return int the new value
+ *
+ * @link https://redis.io/commands/decrby
+ * @example
+ *
+ * $redis->decr('key1'); // key1 didn't exists, set to 0 before the increment and now has the value -1
+ * $redis->decr('key1'); // -2
+ * $redis->decr('key1'); // -3
+ * $redis->decrBy('key1', 10); // -13
+ *
+ */
+ public function decrBy($key, $value)
+ {
+ }
+
+ /**
+ * Adds the string values to the head (left) of the list.
+ * Creates the list if the key didn't exist.
+ * If the key exists and is not a list, FALSE is returned.
+ *
+ * @param string $key
+ * @param string|mixed $value1... Variadic list of values to push in key, if dont used serialized, used string
+ *
+ * @return int|bool The new length of the list in case of success, FALSE in case of Failure
+ *
+ * @link https://redis.io/commands/lpush
+ * @example
+ *
+ * $redis->lPush('l', 'v1', 'v2', 'v3', 'v4') // int(4)
+ * var_dump( $redis->lRange('l', 0, -1) );
+ * // Output:
+ * // array(4) {
+ * // [0]=> string(2) "v4"
+ * // [1]=> string(2) "v3"
+ * // [2]=> string(2) "v2"
+ * // [3]=> string(2) "v1"
+ * // }
+ *
+ */
+ public function lPush($key, ...$value1)
+ {
+ }
+
+ /**
+ * Adds the string values to the tail (right) of the list.
+ * Creates the list if the key didn't exist.
+ * If the key exists and is not a list, FALSE is returned.
+ *
+ * @param string $key
+ * @param string|mixed $value1... Variadic list of values to push in key, if dont used serialized, used string
+ *
+ * @return int|bool The new length of the list in case of success, FALSE in case of Failure
+ *
+ * @link https://redis.io/commands/rpush
+ * @example
+ *
+ * $redis->rPush('l', 'v1', 'v2', 'v3', 'v4'); // int(4)
+ * var_dump( $redis->lRange('l', 0, -1) );
+ * // Output:
+ * // array(4) {
+ * // [0]=> string(2) "v1"
+ * // [1]=> string(2) "v2"
+ * // [2]=> string(2) "v3"
+ * // [3]=> string(2) "v4"
+ * // }
+ *
+ */
+ public function rPush($key, ...$value1)
+ {
+ }
+
+ /**
+ * Adds the string value to the head (left) of the list if the list exists.
+ *
+ * @param string $key
+ * @param string|mixed $value String, value to push in key
+ *
+ * @return int|bool The new length of the list in case of success, FALSE in case of Failure.
+ *
+ * @link https://redis.io/commands/lpushx
+ * @example
+ *
+ * $redis->del('key1');
+ * $redis->lPushx('key1', 'A'); // returns 0
+ * $redis->lPush('key1', 'A'); // returns 1
+ * $redis->lPushx('key1', 'B'); // returns 2
+ * $redis->lPushx('key1', 'C'); // returns 3
+ * // key1 now points to the following list: [ 'A', 'B', 'C' ]
+ *
+ */
+ public function lPushx($key, $value)
+ {
+ }
+
+ /**
+ * Adds the string value to the tail (right) of the list if the ist exists. FALSE in case of Failure.
+ *
+ * @param string $key
+ * @param string|mixed $value String, value to push in key
+ *
+ * @return int|bool The new length of the list in case of success, FALSE in case of Failure.
+ *
+ * @link https://redis.io/commands/rpushx
+ * @example
+ *
+ * $redis->del('key1');
+ * $redis->rPushx('key1', 'A'); // returns 0
+ * $redis->rPush('key1', 'A'); // returns 1
+ * $redis->rPushx('key1', 'B'); // returns 2
+ * $redis->rPushx('key1', 'C'); // returns 3
+ * // key1 now points to the following list: [ 'A', 'B', 'C' ]
+ *
+ */
+ public function rPushx($key, $value)
+ {
+ }
+
+ /**
+ * Returns and removes the first element of the list.
+ *
+ * @param string $key
+ *
+ * @return mixed|bool if command executed successfully BOOL FALSE in case of failure (empty list)
+ *
+ * @link https://redis.io/commands/lpop
+ * @example
+ *
+ * $redis->rPush('key1', 'A');
+ * $redis->rPush('key1', 'B');
+ * $redis->rPush('key1', 'C'); // key1 => [ 'A', 'B', 'C' ]
+ * $redis->lPop('key1'); // key1 => [ 'B', 'C' ]
+ *
+ */
+ public function lPop($key)
+ {
+ }
+
+ /**
+ * Returns and removes the last element of the list.
+ *
+ * @param string $key
+ *
+ * @return mixed|bool if command executed successfully BOOL FALSE in case of failure (empty list)
+ *
+ * @link https://redis.io/commands/rpop
+ * @example
+ *
+ * $redis->rPush('key1', 'A');
+ * $redis->rPush('key1', 'B');
+ * $redis->rPush('key1', 'C'); // key1 => [ 'A', 'B', 'C' ]
+ * $redis->rPop('key1'); // key1 => [ 'A', 'B' ]
+ *
+ */
+ public function rPop($key)
+ {
+ }
+
+ /**
+ * Is a blocking lPop primitive. If at least one of the lists contains at least one element,
+ * the element will be popped from the head of the list and returned to the caller.
+ * Il all the list identified by the keys passed in arguments are empty, blPop will block
+ * during the specified timeout until an element is pushed to one of those lists. This element will be popped.
+ *
+ * @param string|string[] $keys String array containing the keys of the lists OR variadic list of strings
+ * @param int $timeout Timeout is always the required final parameter
+ *
+ * @return array ['listName', 'element']
+ *
+ * @link https://redis.io/commands/blpop
+ * @example
+ *
+ * // Non blocking feature
+ * $redis->lPush('key1', 'A');
+ * $redis->del('key2');
+ *
+ * $redis->blPop('key1', 'key2', 10); // array('key1', 'A')
+ * // OR
+ * $redis->blPop(['key1', 'key2'], 10); // array('key1', 'A')
+ *
+ * $redis->brPop('key1', 'key2', 10); // array('key1', 'A')
+ * // OR
+ * $redis->brPop(['key1', 'key2'], 10); // array('key1', 'A')
+ *
+ * // Blocking feature
+ *
+ * // process 1
+ * $redis->del('key1');
+ * $redis->blPop('key1', 10);
+ * // blocking for 10 seconds
+ *
+ * // process 2
+ * $redis->lPush('key1', 'A');
+ *
+ * // process 1
+ * // array('key1', 'A') is returned
+ *
+ */
+ public function blPop($keys, $timeout)
+ {
+ }
+
+ /**
+ * Is a blocking rPop primitive. If at least one of the lists contains at least one element,
+ * the element will be popped from the head of the list and returned to the caller.
+ * Il all the list identified by the keys passed in arguments are empty, brPop will
+ * block during the specified timeout until an element is pushed to one of those lists. T
+ * his element will be popped.
+ *
+ * @param string|string[] $keys String array containing the keys of the lists OR variadic list of strings
+ * @param int $timeout Timeout is always the required final parameter
+ *
+ * @return array ['listName', 'element']
+ *
+ * @link https://redis.io/commands/brpop
+ * @example
+ *
+ * // Non blocking feature
+ * $redis->lPush('key1', 'A');
+ * $redis->del('key2');
+ *
+ * $redis->blPop('key1', 'key2', 10); // array('key1', 'A')
+ * // OR
+ * $redis->blPop(array('key1', 'key2'), 10); // array('key1', 'A')
+ *
+ * $redis->brPop('key1', 'key2', 10); // array('key1', 'A')
+ * // OR
+ * $redis->brPop(array('key1', 'key2'), 10); // array('key1', 'A')
+ *
+ * // Blocking feature
+ *
+ * // process 1
+ * $redis->del('key1');
+ * $redis->blPop('key1', 10);
+ * // blocking for 10 seconds
+ *
+ * // process 2
+ * $redis->lPush('key1', 'A');
+ *
+ * // process 1
+ * // array('key1', 'A') is returned
+ *
+ */
+ public function brPop(array $keys, $timeout)
+ {
+ }
+
+ /**
+ * Returns the size of a list identified by Key. If the list didn't exist or is empty,
+ * the command returns 0. If the data type identified by Key is not a list, the command return FALSE.
+ *
+ * @param string $key
+ *
+ * @return int|bool The size of the list identified by Key exists.
+ * bool FALSE if the data type identified by Key is not list
+ *
+ * @link https://redis.io/commands/llen
+ * @example
+ *
+ * $redis->rPush('key1', 'A');
+ * $redis->rPush('key1', 'B');
+ * $redis->rPush('key1', 'C'); // key1 => [ 'A', 'B', 'C' ]
+ * $redis->lLen('key1'); // 3
+ * $redis->rPop('key1');
+ * $redis->lLen('key1'); // 2
+ *
+ */
+ public function lLen($key)
+ {
+ }
+
+ /**
+ * @see lLen()
+ * @link https://redis.io/commands/llen
+ * @deprecated use Redis::lLen()
+ *
+ * @param string $key
+ *
+ * @return int The size of the list identified by Key exists
+ */
+ public function lSize($key)
+ {
+ }
+
+ /**
+ * Return the specified element of the list stored at the specified key.
+ * 0 the first element, 1 the second ... -1 the last element, -2 the penultimate ...
+ * Return FALSE in case of a bad index or a key that doesn't point to a list.
+ *
+ * @param string $key
+ * @param int $index
+ *
+ * @return mixed|bool the element at this index
+ *
+ * Bool FALSE if the key identifies a non-string data type, or no value corresponds to this index in the list Key.
+ *
+ * @link https://redis.io/commands/lindex
+ * @example
+ *
+ * $redis->rPush('key1', 'A');
+ * $redis->rPush('key1', 'B');
+ * $redis->rPush('key1', 'C'); // key1 => [ 'A', 'B', 'C' ]
+ * $redis->lIndex('key1', 0); // 'A'
+ * $redis->lIndex('key1', -1); // 'C'
+ * $redis->lIndex('key1', 10); // `FALSE`
+ *
+ */
+ public function lIndex($key, $index)
+ {
+ }
+
+ /**
+ * @see lIndex()
+ * @link https://redis.io/commands/lindex
+ * @deprecated use Redis::lIndex()
+ *
+ * @param string $key
+ * @param int $index
+ * @return mixed|bool the element at this index
+ */
+ public function lGet($key, $index)
+ {
+ }
+
+ /**
+ * Set the list at index with the new value.
+ *
+ * @param string $key
+ * @param int $index
+ * @param string $value
+ *
+ * @return bool TRUE if the new value is setted.
+ * FALSE if the index is out of range, or data type identified by key is not a list.
+ *
+ * @link https://redis.io/commands/lset
+ * @example
+ *
+ * $redis->rPush('key1', 'A');
+ * $redis->rPush('key1', 'B');
+ * $redis->rPush('key1', 'C'); // key1 => [ 'A', 'B', 'C' ]
+ * $redis->lIndex('key1', 0); // 'A'
+ * $redis->lSet('key1', 0, 'X');
+ * $redis->lIndex('key1', 0); // 'X'
+ *
+ */
+ public function lSet($key, $index, $value)
+ {
+ }
+
+ /**
+ * Returns the specified elements of the list stored at the specified key in
+ * the range [start, end]. start and stop are interpretated as indices: 0 the first element,
+ * 1 the second ... -1 the last element, -2 the penultimate ...
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ *
+ * @return array containing the values in specified range.
+ *
+ * @link https://redis.io/commands/lrange
+ * @example
+ *
+ * $redis->rPush('key1', 'A');
+ * $redis->rPush('key1', 'B');
+ * $redis->rPush('key1', 'C');
+ * $redis->lRange('key1', 0, -1); // array('A', 'B', 'C')
+ *
+ */
+ public function lRange($key, $start, $end)
+ {
+ }
+
+ /**
+ * @see lRange()
+ * @link https://redis.io/commands/lrange
+ * @deprecated use Redis::lRange()
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ * @return array
+ */
+ public function lGetRange($key, $start, $end)
+ {
+ }
+
+ /**
+ * Trims an existing list so that it will contain only a specified range of elements.
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $stop
+ *
+ * @return array|bool Bool return FALSE if the key identify a non-list value
+ *
+ * @link https://redis.io/commands/ltrim
+ * @example
+ *
+ * $redis->rPush('key1', 'A');
+ * $redis->rPush('key1', 'B');
+ * $redis->rPush('key1', 'C');
+ * $redis->lRange('key1', 0, -1); // array('A', 'B', 'C')
+ * $redis->lTrim('key1', 0, 1);
+ * $redis->lRange('key1', 0, -1); // array('A', 'B')
+ *
+ */
+ public function lTrim($key, $start, $stop)
+ {
+ }
+
+ /**
+ * @see lTrim()
+ * @link https://redis.io/commands/ltrim
+ * @deprecated use Redis::lTrim()
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $stop
+ */
+ public function listTrim($key, $start, $stop)
+ {
+ }
+
+ /**
+ * Removes the first count occurences of the value element from the list.
+ * If count is zero, all the matching elements are removed. If count is negative,
+ * elements are removed from tail to head.
+ *
+ * @param string $key
+ * @param string $value
+ * @param int $count
+ *
+ * @return int|bool the number of elements to remove
+ * bool FALSE if the value identified by key is not a list.
+ *
+ * @link https://redis.io/commands/lrem
+ * @example
+ *
+ * $redis->lPush('key1', 'A');
+ * $redis->lPush('key1', 'B');
+ * $redis->lPush('key1', 'C');
+ * $redis->lPush('key1', 'A');
+ * $redis->lPush('key1', 'A');
+ *
+ * $redis->lRange('key1', 0, -1); // array('A', 'A', 'C', 'B', 'A')
+ * $redis->lRem('key1', 'A', 2); // 2
+ * $redis->lRange('key1', 0, -1); // array('C', 'B', 'A')
+ *
+ */
+ public function lRem($key, $value, $count)
+ {
+ }
+
+ /**
+ * @see lRem
+ * @link https://redis.io/commands/lremove
+ * @deprecated use Redis::lRem()
+ *
+ * @param string $key
+ * @param string $value
+ * @param int $count
+ */
+ public function lRemove($key, $value, $count)
+ {
+ }
+
+ /**
+ * Insert value in the list before or after the pivot value. the parameter options
+ * specify the position of the insert (before or after). If the list didn't exists,
+ * or the pivot didn't exists, the value is not inserted.
+ *
+ * @param string $key
+ * @param int $position Redis::BEFORE | Redis::AFTER
+ * @param string $pivot
+ * @param string|mixed $value
+ *
+ * @return int The number of the elements in the list, -1 if the pivot didn't exists.
+ *
+ * @link https://redis.io/commands/linsert
+ * @example
+ *
+ * $redis->del('key1');
+ * $redis->lInsert('key1', Redis::AFTER, 'A', 'X'); // 0
+ *
+ * $redis->lPush('key1', 'A');
+ * $redis->lPush('key1', 'B');
+ * $redis->lPush('key1', 'C');
+ *
+ * $redis->lInsert('key1', Redis::BEFORE, 'C', 'X'); // 4
+ * $redis->lRange('key1', 0, -1); // array('A', 'B', 'X', 'C')
+ *
+ * $redis->lInsert('key1', Redis::AFTER, 'C', 'Y'); // 5
+ * $redis->lRange('key1', 0, -1); // array('A', 'B', 'X', 'C', 'Y')
+ *
+ * $redis->lInsert('key1', Redis::AFTER, 'W', 'value'); // -1
+ *
+ */
+ public function lInsert($key, $position, $pivot, $value)
+ {
+ }
+
+ /**
+ * Adds a values to the set value stored at key.
+ *
+ * @param string $key Required key
+ * @param string|mixed ...$value1 Variadic list of values
+ *
+ * @return int|bool The number of elements added to the set.
+ * If this value is already in the set, FALSE is returned
+ *
+ * @link https://redis.io/commands/sadd
+ * @example
+ *
+ * $redis->sAdd('k', 'v1'); // int(1)
+ * $redis->sAdd('k', 'v1', 'v2', 'v3'); // int(2)
+ *
+ */
+ public function sAdd($key, ...$value1)
+ {
+ }
+
+ /**
+ * Removes the specified members from the set value stored at key.
+ *
+ * @param string $key
+ * @param string|mixed ...$member1 Variadic list of members
+ *
+ * @return int The number of elements removed from the set
+ *
+ * @link https://redis.io/commands/srem
+ * @example
+ *
+ * var_dump( $redis->sAdd('k', 'v1', 'v2', 'v3') ); // int(3)
+ * var_dump( $redis->sRem('k', 'v2', 'v3') ); // int(2)
+ * var_dump( $redis->sMembers('k') );
+ * //// Output:
+ * // array(1) {
+ * // [0]=> string(2) "v1"
+ * // }
+ *
+ */
+ public function sRem($key, ...$member1)
+ {
+ }
+
+ /**
+ * @see sRem()
+ * @link https://redis.io/commands/srem
+ * @deprecated use Redis::sRem()
+ *
+ * @param string $key
+ * @param string|mixed ...$member1
+ */
+ public function sRemove($key, ...$member1)
+ {
+ }
+
+ /**
+ * Moves the specified member from the set at srcKey to the set at dstKey.
+ *
+ * @param string $srcKey
+ * @param string $dstKey
+ * @param string|mixed $member
+ *
+ * @return bool If the operation is successful, return TRUE.
+ * If the srcKey and/or dstKey didn't exist, and/or the member didn't exist in srcKey, FALSE is returned.
+ *
+ * @link https://redis.io/commands/smove
+ * @example
+ *
+ * $redis->sAdd('key1' , 'set11');
+ * $redis->sAdd('key1' , 'set12');
+ * $redis->sAdd('key1' , 'set13'); // 'key1' => {'set11', 'set12', 'set13'}
+ * $redis->sAdd('key2' , 'set21');
+ * $redis->sAdd('key2' , 'set22'); // 'key2' => {'set21', 'set22'}
+ * $redis->sMove('key1', 'key2', 'set13'); // 'key1' => {'set11', 'set12'}
+ * // 'key2' => {'set21', 'set22', 'set13'}
+ *
+ */
+ public function sMove($srcKey, $dstKey, $member)
+ {
+ }
+
+ /**
+ * Checks if value is a member of the set stored at the key key.
+ *
+ * @param string $key
+ * @param string|mixed $value
+ *
+ * @return bool TRUE if value is a member of the set at key key, FALSE otherwise
+ *
+ * @link https://redis.io/commands/sismember
+ * @example
+ *
+ * $redis->sAdd('key1' , 'set1');
+ * $redis->sAdd('key1' , 'set2');
+ * $redis->sAdd('key1' , 'set3'); // 'key1' => {'set1', 'set2', 'set3'}
+ *
+ * $redis->sIsMember('key1', 'set1'); // TRUE
+ * $redis->sIsMember('key1', 'setX'); // FALSE
+ *
+ */
+ public function sIsMember($key, $value)
+ {
+ }
+
+ /**
+ * @see sIsMember()
+ * @link https://redis.io/commands/sismember
+ * @deprecated use Redis::sIsMember()
+ *
+ * @param string $key
+ * @param string|mixed $value
+ */
+ public function sContains($key, $value)
+ {
+ }
+
+ /**
+ * Returns the cardinality of the set identified by key.
+ *
+ * @param string $key
+ *
+ * @return int the cardinality of the set identified by key, 0 if the set doesn't exist.
+ *
+ * @link https://redis.io/commands/scard
+ * @example
+ *
+ * $redis->sAdd('key1' , 'set1');
+ * $redis->sAdd('key1' , 'set2');
+ * $redis->sAdd('key1' , 'set3'); // 'key1' => {'set1', 'set2', 'set3'}
+ * $redis->sCard('key1'); // 3
+ * $redis->sCard('keyX'); // 0
+ *
+ */
+ public function sCard($key)
+ {
+ }
+
+ /**
+ * Removes and returns a random element from the set value at Key.
+ *
+ * @param string $key
+ *
+ * @return string|mixed|bool "popped" value
+ * bool FALSE if set identified by key is empty or doesn't exist.
+ *
+ * @link https://redis.io/commands/spop
+ * @example
+ *
+ * $redis->sAdd('key1' , 'set1');
+ * $redis->sAdd('key1' , 'set2');
+ * $redis->sAdd('key1' , 'set3'); // 'key1' => {'set3', 'set1', 'set2'}
+ * $redis->sPop('key1'); // 'set1', 'key1' => {'set3', 'set2'}
+ * $redis->sPop('key1'); // 'set3', 'key1' => {'set2'}
+ *
+ */
+ public function sPop($key)
+ {
+ }
+
+ /**
+ * Returns a random element(s) from the set value at Key, without removing it.
+ *
+ * @param string $key
+ * @param int $count [optional]
+ *
+ * @return string|mixed|array|bool value(s) from the set
+ * bool FALSE if set identified by key is empty or doesn't exist and count argument isn't passed.
+ *
+ * @link https://redis.io/commands/srandmember
+ * @example
+ *
+ * $redis->sAdd('key1' , 'one');
+ * $redis->sAdd('key1' , 'two');
+ * $redis->sAdd('key1' , 'three'); // 'key1' => {'one', 'two', 'three'}
+ *
+ * var_dump( $redis->sRandMember('key1') ); // 'key1' => {'one', 'two', 'three'}
+ *
+ * // string(5) "three"
+ *
+ * var_dump( $redis->sRandMember('key1', 2) ); // 'key1' => {'one', 'two', 'three'}
+ *
+ * // array(2) {
+ * // [0]=> string(2) "one"
+ * // [1]=> string(2) "three"
+ * // }
+ *
+ */
+ public function sRandMember($key, $count = 1)
+ {
+ }
+
+ /**
+ * Returns the members of a set resulting from the intersection of all the sets
+ * held at the specified keys. If just a single key is specified, then this command
+ * produces the members of this set. If one of the keys is missing, FALSE is returned.
+ *
+ * @param string $key1 keys identifying the different sets on which we will apply the intersection.
+ * @param string ...$otherKeys variadic list of keys
+ *
+ * @return array contain the result of the intersection between those keys
+ * If the intersection between the different sets is empty, the return value will be empty array.
+ *
+ * @link https://redis.io/commands/sinter
+ * @example
+ *
+ * $redis->sAdd('key1', 'val1');
+ * $redis->sAdd('key1', 'val2');
+ * $redis->sAdd('key1', 'val3');
+ * $redis->sAdd('key1', 'val4');
+ *
+ * $redis->sAdd('key2', 'val3');
+ * $redis->sAdd('key2', 'val4');
+ *
+ * $redis->sAdd('key3', 'val3');
+ * $redis->sAdd('key3', 'val4');
+ *
+ * var_dump($redis->sInter('key1', 'key2', 'key3'));
+ *
+ * //array(2) {
+ * // [0]=>
+ * // string(4) "val4"
+ * // [1]=>
+ * // string(4) "val3"
+ * //}
+ *
+ */
+ public function sInter($key1, ...$otherKeys)
+ {
+ }
+
+ /**
+ * Performs a sInter command and stores the result in a new set.
+ *
+ * @param string $dstKey the key to store the diff into.
+ * @param string $key1 keys identifying the different sets on which we will apply the intersection.
+ * @param string ...$otherKeys variadic list of keys
+ *
+ * @return int|bool The cardinality of the resulting set, or FALSE in case of a missing key
+ *
+ * @link https://redis.io/commands/sinterstore
+ * @example
+ *
+ * $redis->sAdd('key1', 'val1');
+ * $redis->sAdd('key1', 'val2');
+ * $redis->sAdd('key1', 'val3');
+ * $redis->sAdd('key1', 'val4');
+ *
+ * $redis->sAdd('key2', 'val3');
+ * $redis->sAdd('key2', 'val4');
+ *
+ * $redis->sAdd('key3', 'val3');
+ * $redis->sAdd('key3', 'val4');
+ *
+ * var_dump($redis->sInterStore('output', 'key1', 'key2', 'key3'));
+ * var_dump($redis->sMembers('output'));
+ *
+ * //int(2)
+ * //
+ * //array(2) {
+ * // [0]=>
+ * // string(4) "val4"
+ * // [1]=>
+ * // string(4) "val3"
+ * //}
+ *
+ */
+ public function sInterStore($dstKey, $key1, ...$otherKeys)
+ {
+ }
+
+ /**
+ * Performs the union between N sets and returns it.
+ *
+ * @param string $key1 first key for union
+ * @param string ...$otherKeys variadic list of keys corresponding to sets in redis
+ *
+ * @return array string[] The union of all these sets
+ *
+ * @link https://redis.io/commands/sunionstore
+ * @example
+ *
+ * $redis->sAdd('s0', '1');
+ * $redis->sAdd('s0', '2');
+ * $redis->sAdd('s1', '3');
+ * $redis->sAdd('s1', '1');
+ * $redis->sAdd('s2', '3');
+ * $redis->sAdd('s2', '4');
+ *
+ * var_dump($redis->sUnion('s0', 's1', 's2'));
+ *
+ * array(4) {
+ * // [0]=>
+ * // string(1) "3"
+ * // [1]=>
+ * // string(1) "4"
+ * // [2]=>
+ * // string(1) "1"
+ * // [3]=>
+ * // string(1) "2"
+ * //}
+ *
+ */
+ public function sUnion($key1, ...$otherKeys)
+ {
+ }
+
+ /**
+ * Performs the same action as sUnion, but stores the result in the first key
+ *
+ * @param string $dstKey the key to store the diff into.
+ * @param string $key1 first key for union
+ * @param string ...$otherKeys variadic list of keys corresponding to sets in redis
+ *
+ * @return int Any number of keys corresponding to sets in redis
+ *
+ * @link https://redis.io/commands/sunionstore
+ * @example
+ *
+ * $redis->del('s0', 's1', 's2');
+ *
+ * $redis->sAdd('s0', '1');
+ * $redis->sAdd('s0', '2');
+ * $redis->sAdd('s1', '3');
+ * $redis->sAdd('s1', '1');
+ * $redis->sAdd('s2', '3');
+ * $redis->sAdd('s2', '4');
+ *
+ * var_dump($redis->sUnionStore('dst', 's0', 's1', 's2'));
+ * var_dump($redis->sMembers('dst'));
+ *
+ * //int(4)
+ * //array(4) {
+ * // [0]=>
+ * // string(1) "3"
+ * // [1]=>
+ * // string(1) "4"
+ * // [2]=>
+ * // string(1) "1"
+ * // [3]=>
+ * // string(1) "2"
+ * //}
+ *
+ */
+ public function sUnionStore($dstKey, $key1, ...$otherKeys)
+ {
+ }
+
+ /**
+ * Performs the difference between N sets and returns it.
+ *
+ * @param string $key1 first key for diff
+ * @param string ...$otherKeys variadic list of keys corresponding to sets in redis
+ *
+ * @return array string[] The difference of the first set will all the others
+ *
+ * @link https://redis.io/commands/sdiff
+ * @example
+ *
+ * $redis->del('s0', 's1', 's2');
+ *
+ * $redis->sAdd('s0', '1');
+ * $redis->sAdd('s0', '2');
+ * $redis->sAdd('s0', '3');
+ * $redis->sAdd('s0', '4');
+ *
+ * $redis->sAdd('s1', '1');
+ * $redis->sAdd('s2', '3');
+ *
+ * var_dump($redis->sDiff('s0', 's1', 's2'));
+ *
+ * //array(2) {
+ * // [0]=>
+ * // string(1) "4"
+ * // [1]=>
+ * // string(1) "2"
+ * //}
+ *
+ */
+ public function sDiff($key1, ...$otherKeys)
+ {
+ }
+
+ /**
+ * Performs the same action as sDiff, but stores the result in the first key
+ *
+ * @param string $dstKey the key to store the diff into.
+ * @param string $key1 first key for diff
+ * @param string ...$otherKeys variadic list of keys corresponding to sets in redis
+ *
+ * @return int|bool The cardinality of the resulting set, or FALSE in case of a missing key
+ *
+ * @link https://redis.io/commands/sdiffstore
+ * @example
+ *
+ * $redis->del('s0', 's1', 's2');
+ *
+ * $redis->sAdd('s0', '1');
+ * $redis->sAdd('s0', '2');
+ * $redis->sAdd('s0', '3');
+ * $redis->sAdd('s0', '4');
+ *
+ * $redis->sAdd('s1', '1');
+ * $redis->sAdd('s2', '3');
+ *
+ * var_dump($redis->sDiffStore('dst', 's0', 's1', 's2'));
+ * var_dump($redis->sMembers('dst'));
+ *
+ * //int(2)
+ * //array(2) {
+ * // [0]=>
+ * // string(1) "4"
+ * // [1]=>
+ * // string(1) "2"
+ * //}
+ *
+ */
+ public function sDiffStore($dstKey, $key1, ...$otherKeys)
+ {
+ }
+
+ /**
+ * Returns the contents of a set.
+ *
+ * @param string $key
+ *
+ * @return array An array of elements, the contents of the set
+ *
+ * @link https://redis.io/commands/smembers
+ * @example
+ *
+ * $redis->del('s');
+ * $redis->sAdd('s', 'a');
+ * $redis->sAdd('s', 'b');
+ * $redis->sAdd('s', 'a');
+ * $redis->sAdd('s', 'c');
+ * var_dump($redis->sMembers('s'));
+ *
+ * //array(3) {
+ * // [0]=>
+ * // string(1) "c"
+ * // [1]=>
+ * // string(1) "a"
+ * // [2]=>
+ * // string(1) "b"
+ * //}
+ * // The order is random and corresponds to redis' own internal representation of the set structure.
+ *
+ */
+ public function sMembers($key)
+ {
+ }
+
+ /**
+ * @see sMembers()
+ * @link https://redis.io/commands/smembers
+ * @deprecated use Redis::sMembers()
+ *
+ * @param string $key
+ * @return array An array of elements, the contents of the set
+ */
+ public function sGetMembers($key)
+ {
+ }
+
+ /**
+ * Scan a set for members
+ *
+ * @param string $key The set to search.
+ * @param int $iterator LONG (reference) to the iterator as we go.
+ * @param string $pattern String, optional pattern to match against.
+ * @param int $count How many members to return at a time (Redis might return a different amount)
+ *
+ * @return array|bool PHPRedis will return an array of keys or FALSE when we're done iterating
+ *
+ * @link https://redis.io/commands/sscan
+ * @example
+ *
+ * $iterator = null;
+ * while ($members = $redis->sScan('set', $iterator)) {
+ * foreach ($members as $member) {
+ * echo $member . PHP_EOL;
+ * }
+ * }
+ *
+ */
+ public function sScan($key, &$iterator, $pattern = null, $count = 0)
+ {
+ }
+
+ /**
+ * Sets a value and returns the previous entry at that key.
+ *
+ * @param string $key
+ * @param string|mixed $value
+ *
+ * @return string|mixed A string (mixed, if used serializer), the previous value located at this key
+ *
+ * @link https://redis.io/commands/getset
+ * @example
+ *
+ * $redis->set('x', '42');
+ * $exValue = $redis->getSet('x', 'lol'); // return '42', replaces x by 'lol'
+ * $newValue = $redis->get('x')' // return 'lol'
+ *
+ */
+ public function getSet($key, $value)
+ {
+ }
+
+ /**
+ * Returns a random key
+ *
+ * @return string an existing key in redis
+ *
+ * @link https://redis.io/commands/randomkey
+ * @example
+ * + * $key = $redis->randomKey(); + * $surprise = $redis->get($key); // who knows what's in there. + *+ */ + public function randomKey() + { + } + + /** + * Switches to a given database + * + * @param int $dbIndex + * + * @return bool TRUE in case of success, FALSE in case of failure + * + * @link https://redis.io/commands/select + * @example + *
+ * $redis->select(0); // switch to DB 0
+ * $redis->set('x', '42'); // write 42 to x
+ * $redis->move('x', 1); // move to DB 1
+ * $redis->select(1); // switch to DB 1
+ * $redis->get('x'); // will return 42
+ *
+ */
+ public function select($dbIndex)
+ {
+ }
+
+ /**
+ * Moves a key to a different database.
+ *
+ * @param string $key
+ * @param int $dbIndex
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/move
+ * @example
+ *
+ * $redis->select(0); // switch to DB 0
+ * $redis->set('x', '42'); // write 42 to x
+ * $redis->move('x', 1); // move to DB 1
+ * $redis->select(1); // switch to DB 1
+ * $redis->get('x'); // will return 42
+ *
+ */
+ public function move($key, $dbIndex)
+ {
+ }
+
+ /**
+ * Renames a key
+ *
+ * @param string $srcKey
+ * @param string $dstKey
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/rename
+ * @example
+ *
+ * $redis->set('x', '42');
+ * $redis->rename('x', 'y');
+ * $redis->get('y'); // → 42
+ * $redis->get('x'); // → `FALSE`
+ *
+ */
+ public function rename($srcKey, $dstKey)
+ {
+ }
+
+ /**
+ * @see rename()
+ * @link https://redis.io/commands/rename
+ * @deprecated use Redis::rename()
+ *
+ * @param string $srcKey
+ * @param string $dstKey
+ */
+ public function renameKey($srcKey, $dstKey)
+ {
+ }
+
+ /**
+ * Renames a key
+ *
+ * Same as rename, but will not replace a key if the destination already exists.
+ * This is the same behaviour as setNx.
+ *
+ * @param string $srcKey
+ * @param string $dstKey
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/renamenx
+ * @example
+ *
+ * $redis->set('x', '42');
+ * $redis->rename('x', 'y');
+ * $redis->get('y'); // → 42
+ * $redis->get('x'); // → `FALSE`
+ *
+ */
+ public function renameNx($srcKey, $dstKey)
+ {
+ }
+
+ /**
+ * Sets an expiration date (a timeout) on an item
+ *
+ * @param string $key The key that will disappear
+ * @param int $ttl The key's remaining Time To Live, in seconds
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/expire
+ * @example
+ *
+ * $redis->set('x', '42');
+ * $redis->expire('x', 3); // x will disappear in 3 seconds.
+ * sleep(5); // wait 5 seconds
+ * $redis->get('x'); // will return `FALSE`, as 'x' has expired.
+ *
+ */
+ public function expire($key, $ttl)
+ {
+ }
+
+ /**
+ * Sets an expiration date (a timeout in milliseconds) on an item
+ *
+ * @param string $key The key that will disappear.
+ * @param int $ttl The key's remaining Time To Live, in milliseconds
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/pexpire
+ * @example
+ *
+ * $redis->set('x', '42');
+ * $redis->pExpire('x', 11500); // x will disappear in 11500 milliseconds.
+ * $redis->ttl('x'); // 12
+ * $redis->pttl('x'); // 11500
+ *
+ */
+ public function pExpire($key, $ttl)
+ {
+ }
+
+ /**
+ * @see expire()
+ * @link https://redis.io/commands/expire
+ * @deprecated use Redis::expire()
+ *
+ * @param string $key
+ * @param int $ttl
+ * @return bool
+ */
+ public function setTimeout($key, $ttl)
+ {
+ }
+
+ /**
+ * Sets an expiration date (a timestamp) on an item.
+ *
+ * @param string $key The key that will disappear.
+ * @param int $timestamp Unix timestamp. The key's date of death, in seconds from Epoch time.
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/expireat
+ * @example
+ *
+ * $redis->set('x', '42');
+ * $now = time(NULL); // current timestamp
+ * $redis->expireAt('x', $now + 3); // x will disappear in 3 seconds.
+ * sleep(5); // wait 5 seconds
+ * $redis->get('x'); // will return `FALSE`, as 'x' has expired.
+ *
+ */
+ public function expireAt($key, $timestamp)
+ {
+ }
+
+ /**
+ * Sets an expiration date (a timestamp) on an item. Requires a timestamp in milliseconds
+ *
+ * @param string $key The key that will disappear
+ * @param int $timestamp Unix timestamp. The key's date of death, in seconds from Epoch time
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/pexpireat
+ * @example
+ *
+ * $redis->set('x', '42');
+ * $redis->pExpireAt('x', 1555555555005);
+ * echo $redis->ttl('x'); // 218270121
+ * echo $redis->pttl('x'); // 218270120575
+ *
+ */
+ public function pExpireAt($key, $timestamp)
+ {
+ }
+
+ /**
+ * Returns the keys that match a certain pattern.
+ *
+ * @param string $pattern pattern, using '*' as a wildcard
+ *
+ * @return array string[] The keys that match a certain pattern.
+ *
+ * @link https://redis.io/commands/keys
+ * @example
+ *
+ * $allKeys = $redis->keys('*'); // all keys will match this.
+ * $keyWithUserPrefix = $redis->keys('user*');
+ *
+ */
+ public function keys($pattern)
+ {
+ }
+
+ /**
+ * @see keys()
+ * @deprecated use Redis::keys()
+ *
+ * @param string $pattern
+ * @link https://redis.io/commands/keys
+ */
+ public function getKeys($pattern)
+ {
+ }
+
+ /**
+ * Returns the current database's size
+ *
+ * @return int DB size, in number of keys
+ *
+ * @link https://redis.io/commands/dbsize
+ * @example
+ * + * $count = $redis->dbSize(); + * echo "Redis has $count keys\n"; + *+ */ + public function dbSize() + { + } + + /** + * Authenticate the connection using a password. + * Warning: The password is sent in plain-text over the network. + * + * @param string $password + * + * @return bool TRUE if the connection is authenticated, FALSE otherwise + * + * @link https://redis.io/commands/auth + * @example $redis->auth('foobared'); + */ + public function auth($password) + { + } + + /** + * Starts the background rewrite of AOF (Append-Only File) + * + * @return bool TRUE in case of success, FALSE in case of failure + * + * @link https://redis.io/commands/bgrewriteaof + * @example $redis->bgrewriteaof(); + */ + public function bgrewriteaof() + { + } + + /** + * Changes the slave status + * Either host and port, or no parameter to stop being a slave. + * + * @param string $host [optional] + * @param int $port [optional] + * + * @return bool TRUE in case of success, FALSE in case of failure + * + * @link https://redis.io/commands/slaveof + * @example + *
+ * $redis->slaveof('10.0.1.7', 6379);
+ * // ...
+ * $redis->slaveof();
+ *
+ */
+ public function slaveof($host = '127.0.0.1', $port = 6379)
+ {
+ }
+
+ /**
+ * Access the Redis slowLog
+ *
+ * @param string $operation This can be either GET, LEN, or RESET
+ * @param int|null $length If executing a SLOWLOG GET command, you can pass an optional length.
+ *
+ * @return mixed The return value of SLOWLOG will depend on which operation was performed.
+ * - SLOWLOG GET: Array of slowLog entries, as provided by Redis
+ * - SLOGLOG LEN: Integer, the length of the slowLog
+ * - SLOWLOG RESET: Boolean, depending on success
+ *
+ * @example
+ *
+ * // Get ten slowLog entries
+ * $redis->slowLog('get', 10);
+ * // Get the default number of slowLog entries
+ *
+ * $redis->slowLog('get');
+ * // Reset our slowLog
+ * $redis->slowLog('reset');
+ *
+ * // Retrieve slowLog length
+ * $redis->slowLog('len');
+ *
+ *
+ * @link https://redis.io/commands/slowlog
+ */
+ public function slowLog(string $operation, int $length = null)
+ {
+ }
+
+
+ /**
+ * Describes the object pointed to by a key.
+ * The information to retrieve (string) and the key (string).
+ * Info can be one of the following:
+ * - "encoding"
+ * - "refcount"
+ * - "idletime"
+ *
+ * @param string $string
+ * @param string $key
+ *
+ * @return string|int|bool for "encoding", int for "refcount" and "idletime", FALSE if the key doesn't exist.
+ *
+ * @link https://redis.io/commands/object
+ * @example
+ *
+ * $redis->lPush('l', 'Hello, world!');
+ * $redis->object("encoding", "l"); // → ziplist
+ * $redis->object("refcount", "l"); // → 1
+ * $redis->object("idletime", "l"); // → 400 (in seconds, with a precision of 10 seconds).
+ *
+ */
+ public function object($string = '', $key = '')
+ {
+ }
+
+ /**
+ * Performs a synchronous save.
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ * If a save is already running, this command will fail and return FALSE.
+ *
+ * @link https://redis.io/commands/save
+ * @example $redis->save();
+ */
+ public function save()
+ {
+ }
+
+ /**
+ * Performs a background save.
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ * If a save is already running, this command will fail and return FALSE
+ *
+ * @link https://redis.io/commands/bgsave
+ * @example $redis->bgSave();
+ */
+ public function bgsave()
+ {
+ }
+
+ /**
+ * Returns the timestamp of the last disk save.
+ *
+ * @return int timestamp
+ *
+ * @link https://redis.io/commands/lastsave
+ * @example $redis->lastSave();
+ */
+ public function lastSave()
+ {
+ }
+
+ /**
+ * Blocks the current client until all the previous write commands are successfully transferred and
+ * acknowledged by at least the specified number of slaves.
+ *
+ * @param int $numSlaves Number of slaves that need to acknowledge previous write commands.
+ * @param int $timeout Timeout in milliseconds.
+ *
+ * @return int The command returns the number of slaves reached by all the writes performed in the
+ * context of the current connection
+ *
+ * @link https://redis.io/commands/wait
+ * @example $redis->wait(2, 1000);
+ */
+ public function wait($numSlaves, $timeout)
+ {
+ }
+
+ /**
+ * Returns the type of data pointed by a given key.
+ *
+ * @param string $key
+ *
+ * @return int
+ * Depending on the type of the data pointed by the key,
+ * this method will return the following value:
+ * - string: Redis::REDIS_STRING
+ * - set: Redis::REDIS_SET
+ * - list: Redis::REDIS_LIST
+ * - zset: Redis::REDIS_ZSET
+ * - hash: Redis::REDIS_HASH
+ * - other: Redis::REDIS_NOT_FOUND
+ *
+ * @link https://redis.io/commands/type
+ * @example $redis->type('key');
+ */
+ public function type($key)
+ {
+ }
+
+ /**
+ * Append specified string to the string stored in specified key.
+ *
+ * @param string $key
+ * @param string|mixed $value
+ *
+ * @return int Size of the value after the append
+ *
+ * @link https://redis.io/commands/append
+ * @example
+ *
+ * $redis->set('key', 'value1');
+ * $redis->append('key', 'value2'); // 12
+ * $redis->get('key'); // 'value1value2'
+ *
+ */
+ public function append($key, $value)
+ {
+ }
+
+ /**
+ * Return a substring of a larger string
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ *
+ * @return string the substring
+ *
+ * @link https://redis.io/commands/getrange
+ * @example
+ *
+ * $redis->set('key', 'string value');
+ * $redis->getRange('key', 0, 5); // 'string'
+ * $redis->getRange('key', -5, -1); // 'value'
+ *
+ */
+ public function getRange($key, $start, $end)
+ {
+ }
+
+ /**
+ * Return a substring of a larger string
+ *
+ * @deprecated
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ */
+ public function substr($key, $start, $end)
+ {
+ }
+
+ /**
+ * Changes a substring of a larger string.
+ *
+ * @param string $key
+ * @param int $offset
+ * @param string $value
+ *
+ * @return int the length of the string after it was modified
+ *
+ * @link https://redis.io/commands/setrange
+ * @example
+ *
+ * $redis->set('key', 'Hello world');
+ * $redis->setRange('key', 6, "redis"); // returns 11
+ * $redis->get('key'); // "Hello redis"
+ *
+ */
+ public function setRange($key, $offset, $value)
+ {
+ }
+
+ /**
+ * Get the length of a string value.
+ *
+ * @param string $key
+ * @return int
+ *
+ * @link https://redis.io/commands/strlen
+ * @example
+ *
+ * $redis->set('key', 'value');
+ * $redis->strlen('key'); // 5
+ *
+ */
+ public function strlen($key)
+ {
+ }
+
+ /**
+ * Return the position of the first bit set to 1 or 0 in a string. The position is returned, thinking of the
+ * string as an array of bits from left to right, where the first byte's most significant bit is at position 0,
+ * the second byte's most significant bit is at position 8, and so forth.
+ *
+ * @param string $key
+ * @param int $bit
+ * @param int $start
+ * @param int $end
+ *
+ * @return int The command returns the position of the first bit set to 1 or 0 according to the request.
+ * If we look for set bits (the bit argument is 1) and the string is empty or composed of just
+ * zero bytes, -1 is returned. If we look for clear bits (the bit argument is 0) and the string
+ * only contains bit set to 1, the function returns the first bit not part of the string on the
+ * right. So if the string is three bytes set to the value 0xff the command BITPOS key 0 will
+ * return 24, since up to bit 23 all the bits are 1. Basically, the function considers the right
+ * of the string as padded with zeros if you look for clear bits and specify no range or the
+ * start argument only. However, this behavior changes if you are looking for clear bits and
+ * specify a range with both start and end. If no clear bit is found in the specified range, the
+ * function returns -1 as the user specified a clear range and there are no 0 bits in that range.
+ *
+ * @link https://redis.io/commands/bitpos
+ * @example
+ *
+ * $redis->set('key', '\xff\xff');
+ * $redis->bitpos('key', 1); // int(0)
+ * $redis->bitpos('key', 1, 1); // int(8)
+ * $redis->bitpos('key', 1, 3); // int(-1)
+ * $redis->bitpos('key', 0); // int(16)
+ * $redis->bitpos('key', 0, 1); // int(16)
+ * $redis->bitpos('key', 0, 1, 5); // int(-1)
+ *
+ */
+ public function bitpos($key, $bit, $start = 0, $end = null)
+ {
+ }
+
+ /**
+ * Return a single bit out of a larger string
+ *
+ * @param string $key
+ * @param int $offset
+ *
+ * @return int the bit value (0 or 1)
+ *
+ * @link https://redis.io/commands/getbit
+ * @example
+ *
+ * $redis->set('key', "\x7f"); // this is 0111 1111
+ * $redis->getBit('key', 0); // 0
+ * $redis->getBit('key', 1); // 1
+ *
+ */
+ public function getBit($key, $offset)
+ {
+ }
+
+ /**
+ * Changes a single bit of a string.
+ *
+ * @param string $key
+ * @param int $offset
+ * @param bool|int $value bool or int (1 or 0)
+ *
+ * @return int 0 or 1, the value of the bit before it was set
+ *
+ * @link https://redis.io/commands/setbit
+ * @example
+ *
+ * $redis->set('key', "*"); // ord("*") = 42 = 0x2f = "0010 1010"
+ * $redis->setBit('key', 5, 1); // returns 0
+ * $redis->setBit('key', 7, 1); // returns 0
+ * $redis->get('key'); // chr(0x2f) = "/" = b("0010 1111")
+ *
+ */
+ public function setBit($key, $offset, $value)
+ {
+ }
+
+ /**
+ * Count bits in a string
+ *
+ * @param string $key
+ *
+ * @return int The number of bits set to 1 in the value behind the input key
+ *
+ * @link https://redis.io/commands/bitcount
+ * @example
+ *
+ * $redis->set('bit', '345'); // // 11 0011 0011 0100 0011 0101
+ * var_dump( $redis->bitCount('bit', 0, 0) ); // int(4)
+ * var_dump( $redis->bitCount('bit', 1, 1) ); // int(3)
+ * var_dump( $redis->bitCount('bit', 2, 2) ); // int(4)
+ * var_dump( $redis->bitCount('bit', 0, 2) ); // int(11)
+ *
+ */
+ public function bitCount($key)
+ {
+ }
+
+ /**
+ * Bitwise operation on multiple keys.
+ *
+ * @param string $operation either "AND", "OR", "NOT", "XOR"
+ * @param string $retKey return key
+ * @param string $key1 first key
+ * @param string ...$otherKeys variadic list of keys
+ *
+ * @return int The size of the string stored in the destination key
+ *
+ * @link https://redis.io/commands/bitop
+ * @example
+ *
+ * $redis->set('bit1', '1'); // 11 0001
+ * $redis->set('bit2', '2'); // 11 0010
+ *
+ * $redis->bitOp('AND', 'bit', 'bit1', 'bit2'); // bit = 110000
+ * $redis->bitOp('OR', 'bit', 'bit1', 'bit2'); // bit = 110011
+ * $redis->bitOp('NOT', 'bit', 'bit1', 'bit2'); // bit = 110011
+ * $redis->bitOp('XOR', 'bit', 'bit1', 'bit2'); // bit = 11
+ *
+ */
+ public function bitOp($operation, $retKey, $key1, ...$otherKeys)
+ {
+ }
+
+ /**
+ * Removes all entries from the current database.
+ *
+ * @return bool Always TRUE
+ * @link https://redis.io/commands/flushdb
+ * @example $redis->flushDB();
+ */
+ public function flushDB()
+ {
+ }
+
+ /**
+ * Removes all entries from all databases.
+ *
+ * @return bool Always TRUE
+ *
+ * @link https://redis.io/commands/flushall
+ * @example $redis->flushAll();
+ */
+ public function flushAll()
+ {
+ }
+
+ /**
+ * Sort
+ *
+ * @param string $key
+ * @param array $option array(key => value, ...) - optional, with the following keys and values:
+ * - 'by' => 'some_pattern_*',
+ * - 'limit' => array(0, 1),
+ * - 'get' => 'some_other_pattern_*' or an array of patterns,
+ * - 'sort' => 'asc' or 'desc',
+ * - 'alpha' => TRUE,
+ * - 'store' => 'external-key'
+ *
+ * @return array
+ * An array of values, or a number corresponding to the number of elements stored if that was used
+ *
+ * @link https://redis.io/commands/sort
+ * @example
+ *
+ * $redis->del('s');
+ * $redis->sadd('s', 5);
+ * $redis->sadd('s', 4);
+ * $redis->sadd('s', 2);
+ * $redis->sadd('s', 1);
+ * $redis->sadd('s', 3);
+ *
+ * var_dump($redis->sort('s')); // 1,2,3,4,5
+ * var_dump($redis->sort('s', array('sort' => 'desc'))); // 5,4,3,2,1
+ * var_dump($redis->sort('s', array('sort' => 'desc', 'store' => 'out'))); // (int)5
+ *
+ */
+ public function sort($key, $option = null)
+ {
+ }
+
+ /**
+ * Returns an associative array of strings and integers
+ *
+ * @param string $option Optional. The option to provide redis.
+ * SERVER | CLIENTS | MEMORY | PERSISTENCE | STATS | REPLICATION | CPU | CLASTER | KEYSPACE | COMANDSTATS
+ *
+ * Returns an associative array of strings and integers, with the following keys:
+ * - redis_version
+ * - redis_git_sha1
+ * - redis_git_dirty
+ * - arch_bits
+ * - multiplexing_api
+ * - process_id
+ * - uptime_in_seconds
+ * - uptime_in_days
+ * - lru_clock
+ * - used_cpu_sys
+ * - used_cpu_user
+ * - used_cpu_sys_children
+ * - used_cpu_user_children
+ * - connected_clients
+ * - connected_slaves
+ * - client_longest_output_list
+ * - client_biggest_input_buf
+ * - blocked_clients
+ * - used_memory
+ * - used_memory_human
+ * - used_memory_peak
+ * - used_memory_peak_human
+ * - mem_fragmentation_ratio
+ * - mem_allocator
+ * - loading
+ * - aof_enabled
+ * - changes_since_last_save
+ * - bgsave_in_progress
+ * - last_save_time
+ * - total_connections_received
+ * - total_commands_processed
+ * - expired_keys
+ * - evicted_keys
+ * - keyspace_hits
+ * - keyspace_misses
+ * - hash_max_zipmap_entries
+ * - hash_max_zipmap_value
+ * - pubsub_channels
+ * - pubsub_patterns
+ * - latest_fork_usec
+ * - vm_enabled
+ * - role
+ *
+ * @return string
+ *
+ * @link https://redis.io/commands/info
+ * @example
+ *
+ * $redis->info();
+ *
+ * or
+ *
+ * $redis->info("COMMANDSTATS"); //Information on the commands that have been run (>=2.6 only)
+ * $redis->info("CPU"); // just CPU information from Redis INFO
+ *
+ */
+ public function info($option = null)
+ {
+ }
+
+ /**
+ * Resets the statistics reported by Redis using the INFO command (`info()` function).
+ * These are the counters that are reset:
+ * - Keyspace hits
+ * - Keyspace misses
+ * - Number of commands processed
+ * - Number of connections received
+ * - Number of expired keys
+ *
+ * @return bool `TRUE` in case of success, `FALSE` in case of failure.
+ *
+ * @example $redis->resetStat();
+ * @link https://redis.io/commands/config-resetstat
+ */
+ public function resetStat()
+ {
+ }
+
+ /**
+ * Returns the time to live left for a given key, in seconds. If the key doesn't exist, FALSE is returned.
+ *
+ * @param string $key
+ *
+ * @return int|bool the time left to live in seconds
+ *
+ * @link https://redis.io/commands/ttl
+ * @example
+ *
+ * $redis->setex('key', 123, 'test');
+ * $redis->ttl('key'); // int(123)
+ *
+ */
+ public function ttl($key)
+ {
+ }
+
+ /**
+ * Returns a time to live left for a given key, in milliseconds.
+ *
+ * If the key doesn't exist, FALSE is returned.
+ *
+ * @param string $key
+ *
+ * @return int|bool the time left to live in milliseconds
+ *
+ * @link https://redis.io/commands/pttl
+ * @example
+ *
+ * $redis->setex('key', 123, 'test');
+ * $redis->pttl('key'); // int(122999)
+ *
+ */
+ public function pttl($key)
+ {
+ }
+
+ /**
+ * Remove the expiration timer from a key.
+ *
+ * @param string $key
+ *
+ * @return bool TRUE if a timeout was removed, FALSE if the key didn’t exist or didn’t have an expiration timer.
+ *
+ * @link https://redis.io/commands/persist
+ * @example $redis->persist('key');
+ */
+ public function persist($key)
+ {
+ }
+
+ /**
+ * Sets multiple key-value pairs in one atomic command.
+ * MSETNX only returns TRUE if all the keys were set (see SETNX).
+ *
+ * @param array $array Pairs: array(key => value, ...)
+ *
+ * @return bool TRUE in case of success, FALSE in case of failure
+ *
+ * @link https://redis.io/commands/mset
+ * @example
+ *
+ * $redis->mset(array('key0' => 'value0', 'key1' => 'value1'));
+ * var_dump($redis->get('key0'));
+ * var_dump($redis->get('key1'));
+ * // Output:
+ * // string(6) "value0"
+ * // string(6) "value1"
+ *
+ */
+ public function mset(array $array)
+ {
+ }
+
+ /**
+ * Get the values of all the specified keys.
+ * If one or more keys dont exist, the array will contain FALSE at the position of the key.
+ *
+ * @param array $keys Array containing the list of the keys
+ *
+ * @return array Array containing the values related to keys in argument
+ *
+ * @deprecated use Redis::mGet()
+ * @example
+ *
+ * $redis->set('key1', 'value1');
+ * $redis->set('key2', 'value2');
+ * $redis->set('key3', 'value3');
+ * $redis->getMultiple(array('key1', 'key2', 'key3')); // array('value1', 'value2', 'value3');
+ * $redis->getMultiple(array('key0', 'key1', 'key5')); // array(`FALSE`, 'value2', `FALSE`);
+ *
+ */
+ public function getMultiple(array $keys)
+ {
+ }
+
+ /**
+ * Returns the values of all specified keys.
+ *
+ * For every key that does not hold a string value or does not exist,
+ * the special value false is returned. Because of this, the operation never fails.
+ *
+ * @param array $array
+ *
+ * @return array
+ *
+ * @link https://redis.io/commands/mget
+ * @example
+ *
+ * $redis->del('x', 'y', 'z', 'h'); // remove x y z
+ * $redis->mset(array('x' => 'a', 'y' => 'b', 'z' => 'c'));
+ * $redis->hset('h', 'field', 'value');
+ * var_dump($redis->mget(array('x', 'y', 'z', 'h')));
+ * // Output:
+ * // array(3) {
+ * // [0]=> string(1) "a"
+ * // [1]=> string(1) "b"
+ * // [2]=> string(1) "c"
+ * // [3]=> bool(false)
+ * // }
+ *
+ */
+ public function mget(array $array)
+ {
+ }
+
+ /**
+ * @see mset()
+ * @param array $array
+ * @return int 1 (if the keys were set) or 0 (no key was set)
+ *
+ * @link https://redis.io/commands/msetnx
+ */
+ public function msetnx(array $array)
+ {
+ }
+
+ /**
+ * Pops a value from the tail of a list, and pushes it to the front of another list.
+ * Also return this value.
+ *
+ * @since redis >= 1.1
+ *
+ * @param string $srcKey
+ * @param string $dstKey
+ *
+ * @return string|mixed|bool The element that was moved in case of success, FALSE in case of failure.
+ *
+ * @link https://redis.io/commands/rpoplpush
+ * @example
+ *
+ * $redis->del('x', 'y');
+ *
+ * $redis->lPush('x', 'abc');
+ * $redis->lPush('x', 'def');
+ * $redis->lPush('y', '123');
+ * $redis->lPush('y', '456');
+ *
+ * // move the last of x to the front of y.
+ * var_dump($redis->rpoplpush('x', 'y'));
+ * var_dump($redis->lRange('x', 0, -1));
+ * var_dump($redis->lRange('y', 0, -1));
+ *
+ * //Output:
+ * //
+ * //string(3) "abc"
+ * //array(1) {
+ * // [0]=>
+ * // string(3) "def"
+ * //}
+ * //array(3) {
+ * // [0]=>
+ * // string(3) "abc"
+ * // [1]=>
+ * // string(3) "456"
+ * // [2]=>
+ * // string(3) "123"
+ * //}
+ *
+ */
+ public function rpoplpush($srcKey, $dstKey)
+ {
+ }
+
+ /**
+ * A blocking version of rpoplpush, with an integral timeout in the third parameter.
+ *
+ * @param string $srcKey
+ * @param string $dstKey
+ * @param int $timeout
+ *
+ * @return string|mixed|bool The element that was moved in case of success, FALSE in case of timeout
+ *
+ * @link https://redis.io/commands/brpoplpush
+ */
+ public function brpoplpush($srcKey, $dstKey, $timeout)
+ {
+ }
+
+ /**
+ * Adds the specified member with a given score to the sorted set stored at key
+ *
+ * @param string $key Required key
+ * @param array $options Options if needed
+ * @param float $score1 Required score
+ * @param string|mixed $value1 Required value
+ * @param float $score2 Optional score
+ * @param string|mixed $value2 Optional value
+ * @param float $scoreN Optional score
+ * @param string|mixed $valueN Optional value
+ *
+ * @return int Number of values added
+ *
+ * @link https://redis.io/commands/zadd
+ * @example
+ *
+ *
+ * $redis->zAdd('z', 1, 'v1', 2, 'v2', 3, 'v3', 4, 'v4' ); // int(2)
+ * $redis->zRem('z', 'v2', 'v3'); // int(2)
+ * $redis->zAdd('z', ['NX'], 5, 'v5'); // int(1)
+ * $redis->zAdd('z', ['NX'], 6, 'v5'); // int(0)
+ * $redis->zAdd('z', 7, 'v6'); // int(1)
+ * $redis->zAdd('z', 8, 'v6'); // int(0)
+ *
+ * var_dump( $redis->zRange('z', 0, -1) );
+ * // Output:
+ * // array(4) {
+ * // [0]=> string(2) "v1"
+ * // [1]=> string(2) "v4"
+ * // [2]=> string(2) "v5"
+ * // [3]=> string(2) "v8"
+ * // }
+ *
+ * var_dump( $redis->zRange('z', 0, -1, true) );
+ * // Output:
+ * // array(4) {
+ * // ["v1"]=> float(1)
+ * // ["v4"]=> float(4)
+ * // ["v5"]=> float(5)
+ * // ["v6"]=> float(8)
+ *
+ *
+ */
+ public function zAdd($key, $options, $score1, $value1, $score2 = null, $value2 = null, $scoreN = null, $valueN = null)
+ {
+ }
+
+ /**
+ * Returns a range of elements from the ordered set stored at the specified key,
+ * with values in the range [start, end]. start and stop are interpreted as zero-based indices:
+ * 0 the first element,
+ * 1 the second ...
+ * -1 the last element,
+ * -2 the penultimate ...
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ * @param bool $withscores
+ *
+ * @return array Array containing the values in specified range.
+ *
+ * @link https://redis.io/commands/zrange
+ * @example
+ *
+ * $redis->zAdd('key1', 0, 'val0');
+ * $redis->zAdd('key1', 2, 'val2');
+ * $redis->zAdd('key1', 10, 'val10');
+ * $redis->zRange('key1', 0, -1); // array('val0', 'val2', 'val10')
+ * // with scores
+ * $redis->zRange('key1', 0, -1, true); // array('val0' => 0, 'val2' => 2, 'val10' => 10)
+ *
+ */
+ public function zRange($key, $start, $end, $withscores = null)
+ {
+ }
+
+ /**
+ * Deletes a specified member from the ordered set.
+ *
+ * @param string $key
+ * @param string|mixed $member1
+ * @param string|mixed ...$otherMembers
+ *
+ * @return int Number of deleted values
+ *
+ * @link https://redis.io/commands/zrem
+ * @example
+ *
+ * $redis->zAdd('z', 1, 'v1', 2, 'v2', 3, 'v3', 4, 'v4' ); // int(2)
+ * $redis->zRem('z', 'v2', 'v3'); // int(2)
+ * var_dump( $redis->zRange('z', 0, -1) );
+ * //// Output:
+ * // array(2) {
+ * // [0]=> string(2) "v1"
+ * // [1]=> string(2) "v4"
+ * // }
+ *
+ */
+ public function zRem($key, $member1, ...$otherMembers)
+ {
+ }
+
+ /**
+ * @see zRem()
+ * @link https://redis.io/commands/zrem
+ * @deprecated use Redis::zRem()
+ *
+ * @param string $key
+ * @param string|mixed $member1
+ * @param string|mixed ...$otherMembers
+ *
+ * @return int Number of deleted values
+ */
+ public function zDelete($key, $member1, ...$otherMembers)
+ {
+ }
+
+ /**
+ * Returns the elements of the sorted set stored at the specified key in the range [start, end]
+ * in reverse order. start and stop are interpretated as zero-based indices:
+ * 0 the first element,
+ * 1 the second ...
+ * -1 the last element,
+ * -2 the penultimate ...
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ * @param bool $withscore
+ *
+ * @return array Array containing the values in specified range.
+ *
+ * @link https://redis.io/commands/zrevrange
+ * @example
+ *
+ * $redis->zAdd('key', 0, 'val0');
+ * $redis->zAdd('key', 2, 'val2');
+ * $redis->zAdd('key', 10, 'val10');
+ * $redis->zRevRange('key', 0, -1); // array('val10', 'val2', 'val0')
+ *
+ * // with scores
+ * $redis->zRevRange('key', 0, -1, true); // array('val10' => 10, 'val2' => 2, 'val0' => 0)
+ *
+ */
+ public function zRevRange($key, $start, $end, $withscore = null)
+ {
+ }
+
+ /**
+ * Returns the elements of the sorted set stored at the specified key which have scores in the
+ * range [start,end]. Adding a parenthesis before start or end excludes it from the range.
+ * +inf and -inf are also valid limits.
+ *
+ * zRevRangeByScore returns the same items in reverse order, when the start and end parameters are swapped.
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ * @param array $options Two options are available:
+ * - withscores => TRUE,
+ * - and limit => array($offset, $count)
+ *
+ * @return array Array containing the values in specified range.
+ *
+ * @link https://redis.io/commands/zrangebyscore
+ * @example
+ *
+ * $redis->zAdd('key', 0, 'val0');
+ * $redis->zAdd('key', 2, 'val2');
+ * $redis->zAdd('key', 10, 'val10');
+ * $redis->zRangeByScore('key', 0, 3); // array('val0', 'val2')
+ * $redis->zRangeByScore('key', 0, 3, array('withscores' => TRUE); // array('val0' => 0, 'val2' => 2)
+ * $redis->zRangeByScore('key', 0, 3, array('limit' => array(1, 1)); // array('val2')
+ * $redis->zRangeByScore('key', 0, 3, array('withscores' => TRUE, 'limit' => array(1, 1)); // array('val2' => 2)
+ *
+ */
+ public function zRangeByScore($key, $start, $end, array $options = array())
+ {
+ }
+
+ /**
+ * @see zRangeByScore()
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ * @param array $options
+ *
+ * @return array
+ */
+ public function zRevRangeByScore($key, $start, $end, array $options = array())
+ {
+ }
+
+ /**
+ * Returns a lexigraphical range of members in a sorted set, assuming the members have the same score. The
+ * min and max values are required to start with '(' (exclusive), '[' (inclusive), or be exactly the values
+ * '-' (negative inf) or '+' (positive inf). The command must be called with either three *or* five
+ * arguments or will return FALSE.
+ *
+ * @param string $key The ZSET you wish to run against.
+ * @param int $min The minimum alphanumeric value you wish to get.
+ * @param int $max The maximum alphanumeric value you wish to get.
+ * @param int $offset Optional argument if you wish to start somewhere other than the first element.
+ * @param int $limit Optional argument if you wish to limit the number of elements returned.
+ *
+ * @return array|bool Array containing the values in the specified range.
+ *
+ * @link https://redis.io/commands/zrangebylex
+ * @example
+ *
+ * foreach (array('a', 'b', 'c', 'd', 'e', 'f', 'g') as $char) {
+ * $redis->zAdd('key', $char);
+ * }
+ *
+ * $redis->zRangeByLex('key', '-', '[c'); // array('a', 'b', 'c')
+ * $redis->zRangeByLex('key', '-', '(c'); // array('a', 'b')
+ * $redis->zRangeByLex('key', '-', '[c'); // array('b', 'c')
+ *
+ */
+ public function zRangeByLex($key, $min, $max, $offset = null, $limit = null)
+ {
+ }
+
+ /**
+ * @see zRangeByLex()
+ * @param string $key
+ * @param int $min
+ * @param int $max
+ * @param int $offset
+ * @param int $limit
+ *
+ * @return array
+ *
+ * @link https://redis.io/commands/zrevrangebylex
+ */
+ public function zRevRangeByLex($key, $min, $max, $offset = null, $limit = null)
+ {
+ }
+
+ /**
+ * Returns the number of elements of the sorted set stored at the specified key which have
+ * scores in the range [start,end]. Adding a parenthesis before start or end excludes it
+ * from the range. +inf and -inf are also valid limits.
+ *
+ * @param string $key
+ * @param string $start
+ * @param string $end
+ *
+ * @return int the size of a corresponding zRangeByScore
+ *
+ * @link https://redis.io/commands/zcount
+ * @example
+ *
+ * $redis->zAdd('key', 0, 'val0');
+ * $redis->zAdd('key', 2, 'val2');
+ * $redis->zAdd('key', 10, 'val10');
+ * $redis->zCount('key', 0, 3); // 2, corresponding to array('val0', 'val2')
+ *
+ */
+ public function zCount($key, $start, $end)
+ {
+ }
+
+ /**
+ * Deletes the elements of the sorted set stored at the specified key which have scores in the range [start,end].
+ *
+ * @param string $key
+ * @param float|string $start double or "+inf" or "-inf" string
+ * @param float|string $end double or "+inf" or "-inf" string
+ *
+ * @return int The number of values deleted from the sorted set
+ *
+ * @link https://redis.io/commands/zremrangebyscore
+ * @example
+ *
+ * $redis->zAdd('key', 0, 'val0');
+ * $redis->zAdd('key', 2, 'val2');
+ * $redis->zAdd('key', 10, 'val10');
+ * $redis->zRemRangeByScore('key', 0, 3); // 2
+ *
+ */
+ public function zRemRangeByScore($key, $start, $end)
+ {
+ }
+
+ /**
+ * @see zRemRangeByScore()
+ * @deprecated use Redis::zRemRangeByScore()
+ *
+ * @param string $key
+ * @param float $start
+ * @param float $end
+ */
+ public function zDeleteRangeByScore($key, $start, $end)
+ {
+ }
+
+ /**
+ * Deletes the elements of the sorted set stored at the specified key which have rank in the range [start,end].
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ *
+ * @return int The number of values deleted from the sorted set
+ *
+ * @link https://redis.io/commands/zremrangebyrank
+ * @example
+ *
+ * $redis->zAdd('key', 1, 'one');
+ * $redis->zAdd('key', 2, 'two');
+ * $redis->zAdd('key', 3, 'three');
+ * $redis->zRemRangeByRank('key', 0, 1); // 2
+ * $redis->zRange('key', 0, -1, array('withscores' => TRUE)); // array('three' => 3)
+ *
+ */
+ public function zRemRangeByRank($key, $start, $end)
+ {
+ }
+
+ /**
+ * @see zRemRangeByRank()
+ * @link https://redis.io/commands/zremrangebyscore
+ * @deprecated use Redis::zRemRangeByRank()
+ *
+ * @param string $key
+ * @param int $start
+ * @param int $end
+ */
+ public function zDeleteRangeByRank($key, $start, $end)
+ {
+ }
+
+ /**
+ * Returns the cardinality of an ordered set.
+ *
+ * @param string $key
+ *
+ * @return int the set's cardinality
+ *
+ * @link https://redis.io/commands/zsize
+ * @example
+ *
+ * $redis->zAdd('key', 0, 'val0');
+ * $redis->zAdd('key', 2, 'val2');
+ * $redis->zAdd('key', 10, 'val10');
+ * $redis->zCard('key'); // 3
+ *
+ */
+ public function zCard($key)
+ {
+ }
+
+ /**
+ * @see zCard()
+ * @deprecated use Redis::zCard()
+ *
+ * @param string $key
+ * @return int
+ */
+ public function zSize($key)
+ {
+ }
+
+ /**
+ * Returns the score of a given member in the specified sorted set.
+ *
+ * @param string $key
+ * @param string|mixed $member
+ *
+ * @return float|bool false if member or key not exists
+ *
+ * @link https://redis.io/commands/zscore
+ * @example
+ *
+ * $redis->zAdd('key', 2.5, 'val2');
+ * $redis->zScore('key', 'val2'); // 2.5
+ *
+ */
+ public function zScore($key, $member)
+ {
+ }
+
+ /**
+ * Returns the rank of a given member in the specified sorted set, starting at 0 for the item
+ * with the smallest score. zRevRank starts at 0 for the item with the largest score.
+ *
+ * @param string $key
+ * @param string|mixed $member
+ *
+ * @return int|bool the item's score, or false if key or member is not exists
+ *
+ * @link https://redis.io/commands/zrank
+ * @example
+ *
+ * $redis->del('z');
+ * $redis->zAdd('key', 1, 'one');
+ * $redis->zAdd('key', 2, 'two');
+ * $redis->zRank('key', 'one'); // 0
+ * $redis->zRank('key', 'two'); // 1
+ * $redis->zRevRank('key', 'one'); // 1
+ * $redis->zRevRank('key', 'two'); // 0
+ *
+ */
+ public function zRank($key, $member)
+ {
+ }
+
+ /**
+ * @see zRank()
+ * @param string $key
+ * @param string|mixed $member
+ *
+ * @return int|bool the item's score, false - if key or member is not exists
+ *
+ * @link https://redis.io/commands/zrevrank
+ */
+ public function zRevRank($key, $member)
+ {
+ }
+
+ /**
+ * Increments the score of a member from a sorted set by a given amount.
+ *
+ * @param string $key
+ * @param float $value (double) value that will be added to the member's score
+ * @param string $member
+ *
+ * @return float the new value
+ *
+ * @link https://redis.io/commands/zincrby
+ * @example
+ *
+ * $redis->del('key');
+ * $redis->zIncrBy('key', 2.5, 'member1'); // key or member1 didn't exist, so member1's score is to 0
+ * // before the increment and now has the value 2.5
+ * $redis->zIncrBy('key', 1, 'member1'); // 3.5
+ *
+ */
+ public function zIncrBy($key, $value, $member)
+ {
+ }
+
+ /**
+ * Creates an union of sorted sets given in second argument.
+ * The result of the union will be stored in the sorted set defined by the first argument.
+ * The third optionnel argument defines weights to apply to the sorted sets in input.
+ * In this case, the weights will be multiplied by the score of each element in the sorted set
+ * before applying the aggregation. The forth argument defines the AGGREGATE option which
+ * specify how the results of the union are aggregated.
+ *
+ * @param string $output
+ * @param array $zSetKeys
+ * @param array $weights
+ * @param string $aggregateFunction Either "SUM", "MIN", or "MAX": defines the behaviour to use on
+ * duplicate entries during the zUnionStore
+ *
+ * @return int The number of values in the new sorted set
+ *
+ * @link https://redis.io/commands/zunionstore
+ * @example
+ *
+ * $redis->del('k1');
+ * $redis->del('k2');
+ * $redis->del('k3');
+ * $redis->del('ko1');
+ * $redis->del('ko2');
+ * $redis->del('ko3');
+ *
+ * $redis->zAdd('k1', 0, 'val0');
+ * $redis->zAdd('k1', 1, 'val1');
+ *
+ * $redis->zAdd('k2', 2, 'val2');
+ * $redis->zAdd('k2', 3, 'val3');
+ *
+ * $redis->zUnionStore('ko1', array('k1', 'k2')); // 4, 'ko1' => array('val0', 'val1', 'val2', 'val3')
+ *
+ * // Weighted zUnionStore
+ * $redis->zUnionStore('ko2', array('k1', 'k2'), array(1, 1)); // 4, 'ko2' => array('val0', 'val1', 'val2', 'val3')
+ * $redis->zUnionStore('ko3', array('k1', 'k2'), array(5, 1)); // 4, 'ko3' => array('val0', 'val2', 'val3', 'val1')
+ *
+ */
+ public function zUnionStore($output, $zSetKeys, array $weights = null, $aggregateFunction = 'SUM')
+ {
+ }
+
+ /**
+ * @see zUnionStore
+ * @deprecated use Redis::zUnionStore()
+ *
+ * @param string $Output
+ * @param array $ZSetKeys
+ * @param array|null $Weights
+ * @param string $aggregateFunction
+ */
+ public function zUnion($Output, $ZSetKeys, array $Weights = null, $aggregateFunction = 'SUM')
+ {
+ }
+
+ /**
+ * Creates an intersection of sorted sets given in second argument.
+ * The result of the union will be stored in the sorted set defined by the first argument.
+ * The third optional argument defines weights to apply to the sorted sets in input.
+ * In this case, the weights will be multiplied by the score of each element in the sorted set
+ * before applying the aggregation. The forth argument defines the AGGREGATE option which
+ * specify how the results of the union are aggregated.
+ *
+ * @param string $output
+ * @param array $zSetKeys
+ * @param array $weights
+ * @param string $aggregateFunction Either "SUM", "MIN", or "MAX":
+ * defines the behaviour to use on duplicate entries during the zInterStore.
+ *
+ * @return int The number of values in the new sorted set.
+ *
+ * @link https://redis.io/commands/zinterstore
+ * @example
+ *
+ * $redis->del('k1');
+ * $redis->del('k2');
+ * $redis->del('k3');
+ *
+ * $redis->del('ko1');
+ * $redis->del('ko2');
+ * $redis->del('ko3');
+ * $redis->del('ko4');
+ *
+ * $redis->zAdd('k1', 0, 'val0');
+ * $redis->zAdd('k1', 1, 'val1');
+ * $redis->zAdd('k1', 3, 'val3');
+ *
+ * $redis->zAdd('k2', 2, 'val1');
+ * $redis->zAdd('k2', 3, 'val3');
+ *
+ * $redis->zInterStore('ko1', array('k1', 'k2')); // 2, 'ko1' => array('val1', 'val3')
+ * $redis->zInterStore('ko2', array('k1', 'k2'), array(1, 1)); // 2, 'ko2' => array('val1', 'val3')
+ *
+ * // Weighted zInterStore
+ * $redis->zInterStore('ko3', array('k1', 'k2'), array(1, 5), 'min'); // 2, 'ko3' => array('val1', 'val3')
+ * $redis->zInterStore('ko4', array('k1', 'k2'), array(1, 5), 'max'); // 2, 'ko4' => array('val3', 'val1')
+ *
+ */
+ public function zInterStore($output, $zSetKeys, array $weights = null, $aggregateFunction = 'SUM')
+ {
+ }
+
+ /**
+ * @see zInterStore
+ * @deprecated use Redis::zInterStore()
+ *
+ * @param $Output
+ * @param $ZSetKeys
+ * @param array|null $Weights
+ * @param string $aggregateFunction
+ */
+ public function zInter($Output, $ZSetKeys, array $Weights = null, $aggregateFunction = 'SUM')
+ {
+ }
+
+ /**
+ * Scan a sorted set for members, with optional pattern and count
+ *
+ * @param string $key String, the set to scan.
+ * @param int $iterator Long (reference), initialized to NULL.
+ * @param string $pattern String (optional), the pattern to match.
+ * @param int $count How many keys to return per iteration (Redis might return a different number).
+ *
+ * @return array|bool PHPRedis will return matching keys from Redis, or FALSE when iteration is complete
+ *
+ * @link https://redis.io/commands/zscan
+ * @example
+ *
+ * $iterator = null;
+ * while ($members = $redis-zscan('zset', $iterator)) {
+ * foreach ($members as $member => $score) {
+ * echo $member . ' => ' . $score . PHP_EOL;
+ * }
+ * }
+ *
+ */
+ public function zScan($key, &$iterator, $pattern = null, $count = 0)
+ {
+ }
+
+ /**
+ * Block until Redis can pop the highest or lowest scoring members from one or more ZSETs.
+ * There are two commands (BZPOPMIN and BZPOPMAX for popping the lowest and highest scoring elements respectively.)
+ *
+ * @param string|array $key1
+ * @param string|array $key2 ...
+ * @param int $timeout
+ *
+ * @return array Either an array with the key member and score of the higest or lowest element or an empty array
+ * if the timeout was reached without an element to pop.
+ *
+ * @since >= 5.0
+ * @link https://redis.io/commands/bzpopmax
+ * @example
+ *
+ * // Wait up to 5 seconds to pop the *lowest* scoring member from sets `zs1` and `zs2`.
+ * $redis->bzPopMin(['zs1', 'zs2'], 5);
+ * $redis->bzPopMin('zs1', 'zs2', 5);
+ *
+ * // Wait up to 5 seconds to pop the *highest* scoring member from sets `zs1` and `zs2`
+ * $redis->bzPopMax(['zs1', 'zs2'], 5);
+ * $redis->bzPopMax('zs1', 'zs2', 5);
+ *
+ */
+ public function bzPopMax($key1, $key2, $timeout)
+ {
+ }
+
+ /**
+ * @param string|array $key1
+ * @param string|array $key2 ...
+ * @param int $timeout
+ *
+ * @return array Either an array with the key member and score of the higest or lowest element or an empty array
+ * if the timeout was reached without an element to pop.
+ *
+ * @see bzPopMax
+ * @since >= 5.0
+ * @link https://redis.io/commands/bzpopmin
+ */
+ public function bzPopMin($key1, $key2, $timeout)
+ {
+ }
+
+ /**
+ * Adds a value to the hash stored at key. If this value is already in the hash, FALSE is returned.
+ *
+ * @param string $key
+ * @param string $hashKey
+ * @param string $value
+ *
+ * @return int|bool
+ * - 1 if value didn't exist and was added successfully,
+ * - 0 if the value was already present and was replaced, FALSE if there was an error.
+ *
+ * @link https://redis.io/commands/hset
+ * @example
+ *
+ * $redis->del('h')
+ * $redis->hSet('h', 'key1', 'hello'); // 1, 'key1' => 'hello' in the hash at "h"
+ * $redis->hGet('h', 'key1'); // returns "hello"
+ *
+ * $redis->hSet('h', 'key1', 'plop'); // 0, value was replaced.
+ * $redis->hGet('h', 'key1'); // returns "plop"
+ *
+ */
+ public function hSet($key, $hashKey, $value)
+ {
+ }
+
+ /**
+ * Adds a value to the hash stored at key only if this field isn't already in the hash.
+ *
+ * @param string $key
+ * @param string $hashKey
+ * @param string $value
+ *
+ * @return bool TRUE if the field was set, FALSE if it was already present.
+ *
+ * @link https://redis.io/commands/hsetnx
+ * @example
+ *
+ * $redis->del('h')
+ * $redis->hSetNx('h', 'key1', 'hello'); // TRUE, 'key1' => 'hello' in the hash at "h"
+ * $redis->hSetNx('h', 'key1', 'world'); // FALSE, 'key1' => 'hello' in the hash at "h". No change since the field
+ * wasn't replaced.
+ *
+ */
+ public function hSetNx($key, $hashKey, $value)
+ {
+ }
+
+ /**
+ * Gets a value from the hash stored at key.
+ * If the hash table doesn't exist, or the key doesn't exist, FALSE is returned.
+ *
+ * @param string $key
+ * @param string $hashKey
+ *
+ * @return string The value, if the command executed successfully BOOL FALSE in case of failure
+ *
+ * @link https://redis.io/commands/hget
+ */
+ public function hGet($key, $hashKey)
+ {
+ }
+
+ /**
+ * Returns the length of a hash, in number of items
+ *
+ * @param string $key
+ *
+ * @return int|false the number of items in a hash, FALSE if the key doesn't exist or isn't a hash
+ *
+ * @link https://redis.io/commands/hlen
+ * @example
+ *
+ * $redis->del('h')
+ * $redis->hSet('h', 'key1', 'hello');
+ * $redis->hSet('h', 'key2', 'plop');
+ * $redis->hLen('h'); // returns 2
+ *
+ */
+ public function hLen($key)
+ {
+ }
+
+ /**
+ * Removes a values from the hash stored at key.
+ * If the hash table doesn't exist, or the key doesn't exist, FALSE is returned.
+ *
+ * @param string $key
+ * @param string $hashKey1
+ * @param string ...$otherHashKeys
+ *
+ * @return int|false Number of deleted fields
+ *
+ * @link https://redis.io/commands/hdel
+ * @example
+ *
+ * $redis->hMSet('h',
+ * array(
+ * 'f1' => 'v1',
+ * 'f2' => 'v2',
+ * 'f3' => 'v3',
+ * 'f4' => 'v4',
+ * ));
+ *
+ * var_dump( $redis->hDel('h', 'f1') ); // int(1)
+ * var_dump( $redis->hDel('h', 'f2', 'f3') ); // int(2)
+ * s
+ * var_dump( $redis->hGetAll('h') );
+ * //// Output:
+ * // array(1) {
+ * // ["f4"]=> string(2) "v4"
+ * // }
+ *
+ */
+ public function hDel($key, $hashKey1, ...$otherHashKeys)
+ {
+ }
+
+ /**
+ * Returns the keys in a hash, as an array of strings.
+ *
+ * @param string $key
+ *
+ * @return array An array of elements, the keys of the hash. This works like PHP's array_keys().
+ *
+ * @link https://redis.io/commands/hkeys
+ * @example
+ *
+ * $redis->del('h');
+ * $redis->hSet('h', 'a', 'x');
+ * $redis->hSet('h', 'b', 'y');
+ * $redis->hSet('h', 'c', 'z');
+ * $redis->hSet('h', 'd', 't');
+ * var_dump($redis->hKeys('h'));
+ *
+ * // Output:
+ * // array(4) {
+ * // [0]=>
+ * // string(1) "a"
+ * // [1]=>
+ * // string(1) "b"
+ * // [2]=>
+ * // string(1) "c"
+ * // [3]=>
+ * // string(1) "d"
+ * // }
+ * // The order is random and corresponds to redis' own internal representation of the set structure.
+ *
+ */
+ public function hKeys($key)
+ {
+ }
+
+ /**
+ * Returns the values in a hash, as an array of strings.
+ *
+ * @param string $key
+ *
+ * @return array An array of elements, the values of the hash. This works like PHP's array_values().
+ *
+ * @link https://redis.io/commands/hvals
+ * @example
+ *
+ * $redis->del('h');
+ * $redis->hSet('h', 'a', 'x');
+ * $redis->hSet('h', 'b', 'y');
+ * $redis->hSet('h', 'c', 'z');
+ * $redis->hSet('h', 'd', 't');
+ * var_dump($redis->hVals('h'));
+ *
+ * // Output
+ * // array(4) {
+ * // [0]=>
+ * // string(1) "x"
+ * // [1]=>
+ * // string(1) "y"
+ * // [2]=>
+ * // string(1) "z"
+ * // [3]=>
+ * // string(1) "t"
+ * // }
+ * // The order is random and corresponds to redis' own internal representation of the set structure.
+ *
+ */
+ public function hVals($key)
+ {
+ }
+
+ /**
+ * Returns the whole hash, as an array of strings indexed by strings.
+ *
+ * @param string $key
+ *
+ * @return array An array of elements, the contents of the hash.
+ *
+ * @link https://redis.io/commands/hgetall
+ * @example
+ *
+ * $redis->del('h');
+ * $redis->hSet('h', 'a', 'x');
+ * $redis->hSet('h', 'b', 'y');
+ * $redis->hSet('h', 'c', 'z');
+ * $redis->hSet('h', 'd', 't');
+ * var_dump($redis->hGetAll('h'));
+ *
+ * // Output:
+ * // array(4) {
+ * // ["a"]=>
+ * // string(1) "x"
+ * // ["b"]=>
+ * // string(1) "y"
+ * // ["c"]=>
+ * // string(1) "z"
+ * // ["d"]=>
+ * // string(1) "t"
+ * // }
+ * // The order is random and corresponds to redis' own internal representation of the set structure.
+ *
+ */
+ public function hGetAll($key)
+ {
+ }
+
+ /**
+ * Verify if the specified member exists in a key.
+ *
+ * @param string $key
+ * @param string $hashKey
+ *
+ * @return bool If the member exists in the hash table, return TRUE, otherwise return FALSE.
+ *
+ * @link https://redis.io/commands/hexists
+ * @example
+ *
+ * $redis->hSet('h', 'a', 'x');
+ * $redis->hExists('h', 'a'); // TRUE
+ * $redis->hExists('h', 'NonExistingKey'); // FALSE
+ *
+ */
+ public function hExists($key, $hashKey)
+ {
+ }
+
+ /**
+ * Increments the value of a member from a hash by a given amount.
+ *
+ * @param string $key
+ * @param string $hashKey
+ * @param int $value (integer) value that will be added to the member's value
+ *
+ * @return int the new value
+ *
+ * @link https://redis.io/commands/hincrby
+ * @example
+ *
+ * $redis->del('h');
+ * $redis->hIncrBy('h', 'x', 2); // returns 2: h[x] = 2 now.
+ * $redis->hIncrBy('h', 'x', 1); // h[x] ← 2 + 1. Returns 3
+ *
+ */
+ public function hIncrBy($key, $hashKey, $value)
+ {
+ }
+
+ /**
+ * Increment the float value of a hash field by the given amount
+ *
+ * @param string $key
+ * @param string $field
+ * @param float $increment
+ *
+ * @return float
+ *
+ * @link https://redis.io/commands/hincrbyfloat
+ * @example
+ *
+ * $redis = new Redis();
+ * $redis->connect('127.0.0.1');
+ * $redis->hset('h', 'float', 3);
+ * $redis->hset('h', 'int', 3);
+ * var_dump( $redis->hIncrByFloat('h', 'float', 1.5) ); // float(4.5)
+ *
+ * var_dump( $redis->hGetAll('h') );
+ *
+ * // Output
+ * array(2) {
+ * ["float"]=>
+ * string(3) "4.5"
+ * ["int"]=>
+ * string(1) "3"
+ * }
+ *
+ */
+ public function hIncrByFloat($key, $field, $increment)
+ {
+ }
+
+ /**
+ * Fills in a whole hash. Non-string values are converted to string, using the standard (string) cast.
+ * NULL values are stored as empty strings
+ *
+ * @param string $key
+ * @param array $hashKeys key → value array
+ *
+ * @return bool
+ *
+ * @link https://redis.io/commands/hmset
+ * @example
+ *
+ * $redis->del('user:1');
+ * $redis->hMSet('user:1', array('name' => 'Joe', 'salary' => 2000));
+ * $redis->hIncrBy('user:1', 'salary', 100); // Joe earns 100 more now.
+ *
+ */
+ public function hMSet($key, $hashKeys)
+ {
+ }
+
+ /**
+ * Retirieve the values associated to the specified fields in the hash.
+ *
+ * @param string $key
+ * @param array $hashKeys
+ *
+ * @return array Array An array of elements, the values of the specified fields in the hash,
+ * with the hash keys as array keys.
+ *
+ * @link https://redis.io/commands/hmget
+ * @example
+ *
+ * $redis->del('h');
+ * $redis->hSet('h', 'field1', 'value1');
+ * $redis->hSet('h', 'field2', 'value2');
+ * $redis->hmGet('h', array('field1', 'field2')); // returns array('field1' => 'value1', 'field2' => 'value2')
+ *
+ */
+ public function hMGet($key, $hashKeys)
+ {
+ }
+
+ /**
+ * Scan a HASH value for members, with an optional pattern and count.
+ *
+ * @param string $key
+ * @param int $iterator
+ * @param string $pattern Optional pattern to match against.
+ * @param int $count How many keys to return in a go (only a sugestion to Redis).
+ *
+ * @return array An array of members that match our pattern.
+ *
+ * @link https://redis.io/commands/hscan
+ * @example
+ *
+ * // $iterator = null;
+ * // while($elements = $redis->hscan('hash', $iterator)) {
+ * // foreach($elements as $key => $value) {
+ * // echo $key . ' => ' . $value . PHP_EOL;
+ * // }
+ * // }
+ *
+ */
+ public function hScan($key, &$iterator, $pattern = null, $count = 0)
+ {
+ }
+
+ /**
+ * Get the string length of the value associated with field in the hash stored at key
+ *
+ * @param string $key
+ * @param string $field
+ *
+ * @return int the string length of the value associated with field, or zero when field is not present in the hash
+ * or key does not exist at all.
+ *
+ * @link https://redis.io/commands/hstrlen
+ * @since >= 3.2
+ */
+ public function hStrLen(string $key, string $field)
+ {
+ }
+
+ /**
+ * Add one or more geospatial items to the specified key.
+ * This function must be called with at least one longitude, latitude, member triplet.
+ *
+ * @param string $key
+ * @param float $longitude
+ * @param float $latitude
+ * @param string $member
+ *
+ * @return int The number of elements added to the geospatial key
+ *
+ * @link https://redis.io/commands/geoadd
+ * @since >=3.2
+ *
+ * @example
+ *
+ * $redis->del("myplaces");
+ *
+ * // Since the key will be new, $result will be 2
+ * $result = $redis->geoAdd(
+ * "myplaces",
+ * -122.431, 37.773, "San Francisco",
+ * -157.858, 21.315, "Honolulu"
+ * ); // 2
+ *
+ */
+ public function geoadd($key, $longitude, $latitude, $member)
+ {
+ }
+
+ /**
+ * Retrieve Geohash strings for one or more elements of a geospatial index.
+
+ * @param string $key
+ * @param string ...$member variadic list of members
+ *
+ * @return array One or more Redis Geohash encoded strings
+ *
+ * @link https://redis.io/commands/geohash
+ * @since >=3.2
+ *
+ * @example
+ *
+ * $redis->geoAdd("hawaii", -157.858, 21.306, "Honolulu", -156.331, 20.798, "Maui");
+ * $hashes = $redis->geoHash("hawaii", "Honolulu", "Maui");
+ * var_dump($hashes);
+ * // Output: array(2) {
+ * // [0]=>
+ * // string(11) "87z9pyek3y0"
+ * // [1]=>
+ * // string(11) "8e8y6d5jps0"
+ * // }
+ *
+ */
+ public function geohash($key, ...$member)
+ {
+ }
+
+ /**
+ * Return longitude, latitude positions for each requested member.
+ *
+ * @param string $key
+ * @param string $member
+ * @return array One or more longitude/latitude positions
+ *
+ * @link https://redis.io/commands/geopos
+ * @since >=3.2
+ *
+ * @example
+ *
+ * $redis->geoAdd("hawaii", -157.858, 21.306, "Honolulu", -156.331, 20.798, "Maui");
+ * $positions = $redis->geoPos("hawaii", "Honolulu", "Maui");
+ * var_dump($positions);
+ *
+ * // Output:
+ * array(2) {
+ * [0]=> array(2) {
+ * [0]=> string(22) "-157.85800248384475708"
+ * [1]=> string(19) "21.3060004581273077"
+ * }
+ * [1]=> array(2) {
+ * [0]=> string(22) "-156.33099943399429321"
+ * [1]=> string(20) "20.79799924753607598"
+ * }
+ * }
+ *
+ */
+ public function geopos(string $key, string $member)
+ {
+ }
+
+ /**
+ * Return the distance between two members in a geospatial set.
+ *
+ * If units are passed it must be one of the following values:
+ * - 'm' => Meters
+ * - 'km' => Kilometers
+ * - 'mi' => Miles
+ * - 'ft' => Feet
+ *
+ * @param string $key
+ * @param string $member1
+ * @param string $member2
+ * @param string|null $unit
+ *
+ * @return float The distance between the two passed members in the units requested (meters by default)
+ *
+ * @link https://redis.io/commands/geodist
+ * @since >=3.2
+ *
+ * @example
+ *
+ * $redis->geoAdd("hawaii", -157.858, 21.306, "Honolulu", -156.331, 20.798, "Maui");
+ *
+ * $meters = $redis->geoDist("hawaii", "Honolulu", "Maui");
+ * $kilometers = $redis->geoDist("hawaii", "Honolulu", "Maui", 'km');
+ * $miles = $redis->geoDist("hawaii", "Honolulu", "Maui", 'mi');
+ * $feet = $redis->geoDist("hawaii", "Honolulu", "Maui", 'ft');
+ *
+ * echo "Distance between Honolulu and Maui:\n";
+ * echo " meters : $meters\n";
+ * echo " kilometers: $kilometers\n";
+ * echo " miles : $miles\n";
+ * echo " feet : $feet\n";
+ *
+ * // Bad unit
+ * $inches = $redis->geoDist("hawaii", "Honolulu", "Maui", 'in');
+ * echo "Invalid unit returned:\n";
+ * var_dump($inches);
+ *
+ * // Output
+ * Distance between Honolulu and Maui:
+ * meters : 168275.204
+ * kilometers: 168.2752
+ * miles : 104.5616
+ * feet : 552084.0028
+ * Invalid unit returned:
+ * bool(false)
+ *
+ */
+ public function geodist($key, $member1, $member2, $unit = null)
+ {
+ }
+
+ /**
+ * Return members of a set with geospatial information that are within the radius specified by the caller.
+ *
+ * @param $key
+ * @param $longitude
+ * @param $latitude
+ * @param $radius
+ * @param $unit
+ * @param array|null $options
+ * + * |Key |Value |Description | + * |------------|---------------|---------------------------------------------------| + * |COUNT |integer > 0 |Limit how many results are returned | + * | |WITHCOORD |Return longitude and latitude of matching members | + * | |WITHDIST |Return the distance from the center | + * | |WITHHASH |Return the raw geohash-encoded score | + * | |ASC |Sort results in ascending order | + * | |DESC |Sort results in descending order | + * |STORE |key |Store results in key | + * |STOREDIST |key |Store the results as distances in key | + *+ * Note: It doesn't make sense to pass both ASC and DESC options but if both are passed + * the last one passed will be used. + * Note: When using STORE[DIST] in Redis Cluster, the store key must has to the same slot as + * the query key or you will get a CROSSLOT error. + * @return mixed When no STORE option is passed, this function returns an array of results. + * If it is passed this function returns the number of stored entries. + * + * @link https://redis.io/commands/georadius + * @since >= 3.2 + * @example + *
+ * // Add some cities
+ * $redis->geoAdd("hawaii", -157.858, 21.306, "Honolulu", -156.331, 20.798, "Maui");
+ *
+ * echo "Within 300 miles of Honolulu:\n";
+ * var_dump($redis->geoRadius("hawaii", -157.858, 21.306, 300, 'mi'));
+ *
+ * echo "\nWithin 300 miles of Honolulu with distances:\n";
+ * $options = ['WITHDIST'];
+ * var_dump($redis->geoRadius("hawaii", -157.858, 21.306, 300, 'mi', $options));
+ *
+ * echo "\nFirst result within 300 miles of Honolulu with distances:\n";
+ * $options['count'] = 1;
+ * var_dump($redis->geoRadius("hawaii", -157.858, 21.306, 300, 'mi', $options));
+ *
+ * echo "\nFirst result within 300 miles of Honolulu with distances in descending sort order:\n";
+ * $options[] = 'DESC';
+ * var_dump($redis->geoRadius("hawaii", -157.858, 21.306, 300, 'mi', $options));
+ *
+ * // Output
+ * Within 300 miles of Honolulu:
+ * array(2) {
+ * [0]=> string(8) "Honolulu"
+ * [1]=> string(4) "Maui"
+ * }
+ *
+ * Within 300 miles of Honolulu with distances:
+ * array(2) {
+ * [0]=>
+ * array(2) {
+ * [0]=>
+ * string(8) "Honolulu"
+ * [1]=>
+ * string(6) "0.0002"
+ * }
+ * [1]=>
+ * array(2) {
+ * [0]=>
+ * string(4) "Maui"
+ * [1]=>
+ * string(8) "104.5615"
+ * }
+ * }
+ *
+ * First result within 300 miles of Honolulu with distances:
+ * array(1) {
+ * [0]=>
+ * array(2) {
+ * [0]=>
+ * string(8) "Honolulu"
+ * [1]=>
+ * string(6) "0.0002"
+ * }
+ * }
+ *
+ * First result within 300 miles of Honolulu with distances in descending sort order:
+ * array(1) {
+ * [0]=>
+ * array(2) {
+ * [0]=>
+ * string(4) "Maui"
+ * [1]=>
+ * string(8) "104.5615"
+ * }
+ * }
+ *
+ */
+ public function georadius($key, $longitude, $latitude, $radius, $unit, array $options = null)
+ {
+ }
+
+ /**
+ * This method is identical to geoRadius except that instead of passing a longitude and latitude as the "source"
+ * you pass an existing member in the geospatial set
+ *
+ * @param string $key
+ * @param string $member
+ * @param $radius
+ * @param $units
+ * @param array|null $options see georadius
+ *
+ * @return array The zero or more entries that are close enough to the member given the distance and radius specified
+ *
+ * @link https://redis.io/commands/georadiusbymember
+ * @since >= 3.2
+ * @see georadius
+ * @example
+ *
+ * $redis->geoAdd("hawaii", -157.858, 21.306, "Honolulu", -156.331, 20.798, "Maui");
+ *
+ * echo "Within 300 miles of Honolulu:\n";
+ * var_dump($redis->geoRadiusByMember("hawaii", "Honolulu", 300, 'mi'));
+ *
+ * echo "\nFirst match within 300 miles of Honolulu:\n";
+ * var_dump($redis->geoRadiusByMember("hawaii", "Honolulu", 300, 'mi', ['count' => 1]));
+ *
+ * // Output
+ * Within 300 miles of Honolulu:
+ * array(2) {
+ * [0]=> string(8) "Honolulu"
+ * [1]=> string(4) "Maui"
+ * }
+ *
+ * First match within 300 miles of Honolulu:
+ * array(1) {
+ * [0]=> string(8) "Honolulu"
+ * }
+ *
+ */
+ public function georadiusbymember($key, $member, $radius, $units, array $options = null)
+ {
+ }
+
+ /**
+ * Get or Set the redis config keys.
+ *
+ * @param string $operation either `GET` or `SET`
+ * @param string $key for `SET`, glob-pattern for `GET`
+ * @param string|mixed $value optional string (only for `SET`)
+ *
+ * @return array Associative array for `GET`, key -> value
+ *
+ * @link https://redis.io/commands/config-get
+ * @example
+ *
+ * $redis->config("GET", "*max-*-entries*");
+ * $redis->config("SET", "dir", "/var/run/redis/dumps/");
+ *
+ */
+ public function config($operation, $key, $value)
+ {
+ }
+
+ /**
+ * Evaluate a LUA script serverside
+ *
+ * @param string $script
+ * @param array $args
+ * @param int $numKeys
+ *
+ * @return mixed What is returned depends on what the LUA script itself returns, which could be a scalar value
+ * (int/string), or an array. Arrays that are returned can also contain other arrays, if that's how it was set up in
+ * your LUA script. If there is an error executing the LUA script, the getLastError() function can tell you the
+ * message that came back from Redis (e.g. compile error).
+ *
+ * @link https://redis.io/commands/eval
+ * @example
+ *
+ * $redis->eval("return 1"); // Returns an integer: 1
+ * $redis->eval("return {1,2,3}"); // Returns Array(1,2,3)
+ * $redis->del('mylist');
+ * $redis->rpush('mylist','a');
+ * $redis->rpush('mylist','b');
+ * $redis->rpush('mylist','c');
+ * // Nested response: Array(1,2,3,Array('a','b','c'));
+ * $redis->eval("return {1,2,3,redis.call('lrange','mylist',0,-1)}}");
+ *
+ */
+ public function eval($script, $args = array(), $numKeys = 0)
+ {
+ }
+
+ /**
+ * @see eval()
+ * @deprecated use Redis::eval()
+ *
+ * @param string $script
+ * @param array $args
+ * @param int $numKeys
+ * @return mixed @see eval()
+ */
+ public function evaluate($script, $args = array(), $numKeys = 0)
+ {
+ }
+
+ /**
+ * Evaluate a LUA script serverside, from the SHA1 hash of the script instead of the script itself.
+ * In order to run this command Redis will have to have already loaded the script, either by running it or via
+ * the SCRIPT LOAD command.
+ *
+ * @param string $scriptSha
+ * @param array $args
+ * @param int $numKeys
+ *
+ * @return mixed @see eval()
+ *
+ * @see eval()
+ * @link https://redis.io/commands/evalsha
+ * @example
+ *
+ * $script = 'return 1';
+ * $sha = $redis->script('load', $script);
+ * $redis->evalSha($sha); // Returns 1
+ *
+ */
+ public function evalSha($scriptSha, $args = array(), $numKeys = 0)
+ {
+ }
+
+ /**
+ * @see evalSha()
+ * @deprecated use Redis::evalSha()
+ *
+ * @param string $scriptSha
+ * @param array $args
+ * @param int $numKeys
+ */
+ public function evaluateSha($scriptSha, $args = array(), $numKeys = 0)
+ {
+ }
+
+ /**
+ * Execute the Redis SCRIPT command to perform various operations on the scripting subsystem.
+ * @param string $command load | flush | kill | exists
+ * @param string $script
+ *
+ * @return mixed
+ *
+ * @link https://redis.io/commands/script-load
+ * @link https://redis.io/commands/script-kill
+ * @link https://redis.io/commands/script-flush
+ * @link https://redis.io/commands/script-exists
+ * @example
+ *
+ * $redis->script('load', $script);
+ * $redis->script('flush');
+ * $redis->script('kill');
+ * $redis->script('exists', $script1, [$script2, $script3, ...]);
+ *
+ *
+ * SCRIPT LOAD will return the SHA1 hash of the passed script on success, and FALSE on failure.
+ * SCRIPT FLUSH should always return TRUE
+ * SCRIPT KILL will return true if a script was able to be killed and false if not
+ * SCRIPT EXISTS will return an array with TRUE or FALSE for each passed script
+ */
+ public function script($command, $script)
+ {
+ }
+
+ /**
+ * The last error message (if any)
+ *
+ * @return string|null A string with the last returned script based error message, or NULL if there is no error
+ *
+ * @example
+ *
+ * $redis->eval('this-is-not-lua');
+ * $err = $redis->getLastError();
+ * // "ERR Error compiling script (new function): user_script:1: '=' expected near '-'"
+ *
+ */
+ public function getLastError()
+ {
+ }
+
+ /**
+ * Clear the last error message
+ *
+ * @return bool true
+ *
+ * @example
+ *
+ * $redis->set('x', 'a');
+ * $redis->incr('x');
+ * $err = $redis->getLastError();
+ * // "ERR value is not an integer or out of range"
+ * $redis->clearLastError();
+ * $err = $redis->getLastError();
+ * // NULL
+ *
+ */
+ public function clearLastError()
+ {
+ }
+
+ /**
+ * Issue the CLIENT command with various arguments.
+ * The Redis CLIENT command can be used in four ways:
+ * - CLIENT LIST
+ * - CLIENT GETNAME
+ * - CLIENT SETNAME [name]
+ * - CLIENT KILL [ip:port]
+ *
+ * @param string $command
+ * @param string $value
+ * @return mixed This will vary depending on which client command was executed:
+ * - CLIENT LIST will return an array of arrays with client information.
+ * - CLIENT GETNAME will return the client name or false if none has been set
+ * - CLIENT SETNAME will return true if it can be set and false if not
+ * - CLIENT KILL will return true if the client can be killed, and false if not
+ *
+ * Note: phpredis will attempt to reconnect so you can actually kill your own connection but may not notice losing it!
+ *
+ * @link https://redis.io/commands/client-list
+ * @link https://redis.io/commands/client-getname
+ * @link https://redis.io/commands/client-setname
+ * @link https://redis.io/commands/client-kill
+ *
+ * @example
+ *
+ * $redis->client('list'); // Get a list of clients
+ * $redis->client('getname'); // Get the name of the current connection
+ * $redis->client('setname', 'somename'); // Set the name of the current connection
+ * $redis->client('kill', ); // Kill the process at ip:port
+ *
+ */
+ public function client($command, $value = '')
+ {
+ }
+
+ /**
+ * A utility method to prefix the value with the prefix setting for phpredis.
+ *
+ * @param mixed $value The value you wish to prefix
+ *
+ * @return string If a prefix is set up, the value now prefixed.
+ * If there is no prefix, the value will be returned unchanged.
+ *
+ * @example
+ *
+ * $redis->setOption(Redis::OPT_PREFIX, 'my-prefix:');
+ * $redis->_prefix('my-value'); // Will return 'my-prefix:my-value'
+ *
+ */
+ public function _prefix($value)
+ {
+ }
+
+ /**
+ * A utility method to unserialize data with whatever serializer is set up. If there is no serializer set, the
+ * value will be returned unchanged. If there is a serializer set up, and the data passed in is malformed, an
+ * exception will be thrown. This can be useful if phpredis is serializing values, and you return something from
+ * redis in a LUA script that is serialized.
+ *
+ * @param string $value The value to be unserialized
+ *
+ * @return mixed
+ * @example
+ *
+ * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_PHP);
+ * $redis->_unserialize('a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}'); // Will return Array(1,2,3)
+ *
+ */
+ public function _unserialize($value)
+ {
+ }
+
+ /**
+ * A utility method to serialize values manually. This method allows you to serialize a value with whatever
+ * serializer is configured, manually. This can be useful for serialization/unserialization of data going in
+ * and out of EVAL commands as phpredis can't automatically do this itself. Note that if no serializer is
+ * set, phpredis will change Array values to 'Array', and Objects to 'Object'.
+ *
+ * @param mixed $value The value to be serialized.
+ *
+ * @return mixed
+ * @example
+ *
+ * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_NONE);
+ * $redis->_serialize("foo"); // returns "foo"
+ * $redis->_serialize(Array()); // Returns "Array"
+ * $redis->_serialize(new stdClass()); // Returns "Object"
+ *
+ * $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_PHP);
+ * $redis->_serialize("foo"); // Returns 's:3:"foo";'
+ *
+ */
+ public function _serialize($value)
+ {
+ }
+
+ /**
+ * Dump a key out of a redis database, the value of which can later be passed into redis using the RESTORE command.
+ * The data that comes out of DUMP is a binary representation of the key as Redis stores it.
+ * @param string $key
+ *
+ * @return string|bool The Redis encoded value of the key, or FALSE if the key doesn't exist
+ *
+ * @link https://redis.io/commands/dump
+ * @example
+ *
+ * $redis->set('foo', 'bar');
+ * $val = $redis->dump('foo'); // $val will be the Redis encoded key value
+ *
+ */
+ public function dump($key)
+ {
+ }
+
+ /**
+ * Restore a key from the result of a DUMP operation.
+ *
+ * @param string $key The key name
+ * @param int $ttl How long the key should live (if zero, no expire will be set on the key)
+ * @param string $value (binary). The Redis encoded key value (from DUMP)
+ *
+ * @return bool
+ *
+ * @link https://redis.io/commands/restore
+ * @example
+ *
+ * $redis->set('foo', 'bar');
+ * $val = $redis->dump('foo');
+ * $redis->restore('bar', 0, $val); // The key 'bar', will now be equal to the key 'foo'
+ *
+ */
+ public function restore($key, $ttl, $value)
+ {
+ }
+
+ /**
+ * Migrates a key to a different Redis instance.
+ *
+ * @param string $host The destination host
+ * @param int $port The TCP port to connect to.
+ * @param string $key The key to migrate.
+ * @param int $db The target DB.
+ * @param int $timeout The maximum amount of time given to this transfer.
+ * @param bool $copy Should we send the COPY flag to redis.
+ * @param bool $replace Should we send the REPLACE flag to redis.
+ *
+ * @return bool
+ *
+ * @link https://redis.io/commands/migrate
+ * @example
+ *
+ * $redis->migrate('backup', 6379, 'foo', 0, 3600);
+ *
+ */
+ public function migrate($host, $port, $key, $db, $timeout, $copy = false, $replace = false)
+ {
+ }
+
+ /**
+ * Return the current Redis server time.
+ *
+ * @return array If successfull, the time will come back as an associative array with element zero being the
+ * unix timestamp, and element one being microseconds.
+ *
+ * @link https://redis.io/commands/time
+ * @example
+ *
+ * var_dump( $redis->time() );
+ * // array(2) {
+ * // [0] => string(10) "1342364352"
+ * // [1] => string(6) "253002"
+ * // }
+ *
+ */
+ public function time()
+ {
+ }
+
+ /**
+ * Scan the keyspace for keys
+ *
+ * @param int $iterator Iterator, initialized to NULL.
+ * @param string $pattern Pattern to match.
+ * @param int $count Count of keys per iteration (only a suggestion to Redis).
+ *
+ * @return array|bool This function will return an array of keys or FALSE if there are no more keys.
+ *
+ * @link https://redis.io/commands/scan
+ * @example
+ *
+ * $iterator = null;
+ * while(false !== ($keys = $redis->scan($iterator))) {
+ * foreach($keys as $key) {
+ * echo $key . PHP_EOL;
+ * }
+ * }
+ *
+ */
+ public function scan(&$iterator, $pattern = null, $count = 0)
+ {
+ }
+
+ /**
+ * Adds all the element arguments to the HyperLogLog data structure stored at the key.
+ *
+ * @param string $key
+ * @param array $elements
+ *
+ * @return bool
+ *
+ * @link https://redis.io/commands/pfadd
+ * @example $redis->pfAdd('key', array('elem1', 'elem2'))
+ */
+ public function pfAdd($key, array $elements)
+ {
+ }
+
+ /**
+ * When called with a single key, returns the approximated cardinality computed by the HyperLogLog data
+ * structure stored at the specified variable, which is 0 if the variable does not exist.
+ *
+ * @param string|array $key
+ *
+ * @return int
+ *
+ * @link https://redis.io/commands/pfcount
+ * @example
+ *
+ * $redis->pfAdd('key1', array('elem1', 'elem2'));
+ * $redis->pfAdd('key2', array('elem3', 'elem2'));
+ * $redis->pfCount('key1'); // int(2)
+ * $redis->pfCount(array('key1', 'key2')); // int(3)
+ */
+ public function pfCount($key)
+ {
+ }
+
+ /**
+ * Merge multiple HyperLogLog values into an unique value that will approximate the cardinality
+ * of the union of the observed Sets of the source HyperLogLog structures.
+ *
+ * @param string $destKey
+ * @param array $sourceKeys
+ *
+ * @return bool
+ *
+ * @link https://redis.io/commands/pfmerge
+ * @example
+ *
+ * $redis->pfAdd('key1', array('elem1', 'elem2'));
+ * $redis->pfAdd('key2', array('elem3', 'elem2'));
+ * $redis->pfMerge('key3', array('key1', 'key2'));
+ * $redis->pfCount('key3'); // int(3)
+ */
+ public function pfMerge($destKey, array $sourceKeys)
+ {
+ }
+
+ /**
+ * Send arbitrary things to the redis server.
+ *
+ * @param string $command Required command to send to the server.
+ * @param mixed $arguments Optional variable amount of arguments to send to the server.
+ *
+ * @return mixed
+ *
+ * @example
+ *
+ * $redis->rawCommand('SET', 'key', 'value'); // bool(true)
+ * $redis->rawCommand('GET", 'key'); // string(5) "value"
+ *
+ */
+ public function rawCommand($command, $arguments)
+ {
+ }
+
+ /**
+ * Detect whether we're in ATOMIC/MULTI/PIPELINE mode.
+ *
+ * @return int Either Redis::ATOMIC, Redis::MULTI or Redis::PIPELINE
+ *
+ * @example $redis->getMode();
+ */
+ public function getMode()
+ {
+ }
+
+ /**
+ * Acknowledge one or more messages on behalf of a consumer group.
+ *
+ * @param string $stream
+ * @param string $group
+ * @param array $messages
+ *
+ * @return int The number of messages Redis reports as acknowledged.
+ *
+ * @link https://redis.io/commands/xack
+ * @example
+ *
+ * $redis->xAck('stream', 'group1', ['1530063064286-0', '1530063064286-1']);
+ *
+ */
+ public function xAck($stream, $group, $messages)
+ {
+ }
+
+ /**
+ * Add a message to a stream
+ *
+ * @param string $key
+ * @param string $id
+ * @param array $messages
+ * @param int $maxLen
+ * @param bool $isApproximate
+ *
+ * @return string The added message ID.
+ *
+ * @link https://redis.io/commands/xadd
+ * @example
+ *
+ * $redis->xAdd('mystream', "*", ['field' => 'value']);
+ * $redis->xAdd('mystream', "*", ['field' => 'value'], 10);
+ * $redis->xAdd('mystream', "*", ['field' => 'value'], 10, true);
+ *
+ */
+ public function xAdd($key, $id, $messages, $maxLen = 0, $isApproximate = false)
+ {
+ }
+
+ /**
+ * Claim ownership of one or more pending messages
+ *
+ * @param string $key
+ * @param string $group
+ * @param string $consumer
+ * @param int $minIdleTime
+ * @param array $ids
+ * @param array $options ['IDLE' => $value, 'TIME' => $value, 'RETRYCOUNT' => $value, 'FORCE', 'JUSTID']
+ *
+ * @return array Either an array of message IDs along with corresponding data, or just an array of IDs
+ * (if the 'JUSTID' option was passed).
+ *
+ * @link https://redis.io/commands/xclaim
+ * @example
+ *
+ * $ids = ['1530113681011-0', '1530113681011-1', '1530113681011-2'];
+ *
+ * // Without any options
+ * $redis->xClaim('mystream', 'group1', 'myconsumer1', 0, $ids);
+ *
+ * // With options
+ * $redis->xClaim(
+ * 'mystream', 'group1', 'myconsumer2', 0, $ids,
+ * [
+ * 'IDLE' => time() * 1000,
+ * 'RETRYCOUNT' => 5,
+ * 'FORCE',
+ * 'JUSTID'
+ * ]
+ * );
+ *
+ */
+ public function xClaim($key, $group, $consumer, $minIdleTime, $ids, $options = [])
+ {
+ }
+
+ /**
+ * Delete one or more messages from a stream
+ *
+ * @param string $key
+ * @param array $ids
+ *
+ * @return int The number of messages removed
+ *
+ * @link https://redis.io/commands/xdel
+ * @example
+ *
+ * $redis->xDel('mystream', ['1530115304877-0', '1530115305731-0']);
+ *
+ */
+ public function xDel($key, $ids)
+ {
+ }
+
+ /**
+ * @param string $operation e.g.: 'HELP', 'SETID', 'DELGROUP', 'CREATE', 'DELCONSUMER'
+ * @param string $key
+ * @param string $group
+ * @param string $msgId
+ * @param bool $mkStream
+ *
+ * @return mixed This command returns different types depending on the specific XGROUP command executed.
+ *
+ * @link https://redis.io/commands/xgroup
+ * @example
+ *
+ * $redis->xGroup('CREATE', 'mystream', 'mygroup', 0);
+ * $redis->xGroup('CREATE', 'mystream', 'mygroup', 0, true); // create stream
+ * $redis->xGroup('DESTROY', 'mystream', 'mygroup');
+ *
+ */
+ public function xGroup($operation, $key, $group, $msgId = '', $mkStream = false)
+ {
+ }
+
+ /**
+ * Get information about a stream or consumer groups
+ *
+ * @param string $operation e.g.: 'CONSUMERS', 'GROUPS', 'STREAM', 'HELP'
+ * @param string $stream
+ * @param string $group
+ *
+ * @return mixed This command returns different types depending on which subcommand is used.
+ *
+ * @link https://redis.io/commands/xinfo
+ * @example
+ *
+ * $redis->xInfo('STREAM', 'mystream');
+ *
+ */
+ public function xInfo($operation, $stream, $group)
+ {
+ }
+
+ /**
+ * Get the length of a given stream.
+ *
+ * @param string $stream
+ *
+ * @return int The number of messages in the stream.
+ *
+ * @link https://redis.io/commands/xlen
+ * @example
+ *
+ * $redis->xLen('mystream');
+ *
+ */
+ public function xLen($stream)
+ {
+ }
+
+ /**
+ * Get information about pending messages in a given stream
+ *
+ * @param string $stream
+ * @param string $group
+ * @param string $start
+ * @param string $end
+ * @param int $count
+ * @param string $consumer
+ *
+ * @return array Information about the pending messages, in various forms depending on
+ * the specific invocation of XPENDING.
+ *
+ * @link https://redis.io/commands/xpending
+ * @example
+ *
+ * $redis->xPending('mystream', 'mygroup');
+ * $redis->xPending('mystream', 'mygroup', '-', '+', 1, 'consumer-1');
+ *
+ */
+ public function xPending($stream, $group, $start = null, $end = null, $count = null, $consumer = null)
+ {
+ }
+
+ /**
+ * Get a range of messages from a given stream
+ *
+ * @param string $stream
+ * @param string $start
+ * @param string $end
+ * @param int $count
+ *
+ * @return array The messages in the stream within the requested range.
+ *
+ * @link https://redis.io/commands/xrange
+ * @example
+ *
+ * // Get everything in this stream
+ * $redis->xRange('mystream', '-', '+');
+ * // Only the first two messages
+ * $redis->xRange('mystream', '-', '+', 2);
+ *
+ */
+ public function xRange($stream, $start, $end, $count = null)
+ {
+ }
+
+ /**
+ * Read data from one or more streams and only return IDs greater than sent in the command.
+ *
+ * @param array $streams
+ * @param int|string $count
+ * @param int|string $block
+ *
+ * @return array The messages in the stream newer than the IDs passed to Redis (if any)
+ *
+ * @link https://redis.io/commands/xread
+ * @example
+ *
+ * $redis->xRead(['stream1' => '1535222584555-0', 'stream2' => '1535222584555-0']);
+ *
+ */
+ public function xRead($streams, $count = null, $block = null)
+ {
+ }
+
+ /**
+ * This method is similar to xRead except that it supports reading messages for a specific consumer group.
+ *
+ * @param string $group
+ * @param string $consumer
+ * @param array $streams
+ * @param int|null $count
+ * @param int|null $block
+ *
+ * @return array The messages delivered to this consumer group (if any).
+ *
+ * @link https://redis.io/commands/xreadgroup
+ * @example
+ *
+ * // Consume messages for 'mygroup', 'consumer1'
+ * $redis->xReadGroup('mygroup', 'consumer1', ['s1' => 0, 's2' => 0]);
+ * // Read a single message as 'consumer2' for up to a second until a message arrives.
+ * $redis->xReadGroup('mygroup', 'consumer2', ['s1' => 0, 's2' => 0], 1, 1000);
+ *
+ */
+ public function xReadGroup($group, $consumer, $streams, $count = null, $block = null)
+ {
+ }
+
+ /**
+ * This is identical to xRange except the results come back in reverse order.
+ * Also note that Redis reverses the order of "start" and "end".
+ *
+ * @param string $stream
+ * @param string $end
+ * @param string $start
+ * @param int $count
+ *
+ * @return array The messages in the range specified
+ *
+ * @link https://redis.io/commands/xrevrange
+ * @example
+ *
+ * $redis->xRevRange('mystream', '+', '-');
+ *
+ */
+ public function xRevRange($stream, $end, $start, $count = null)
+ {
+ }
+
+ /**
+ * Trim the stream length to a given maximum.
+ * If the "approximate" flag is pasesed, Redis will use your size as a hint but only trim trees in whole nodes
+ * (this is more efficient)
+ *
+ * @param string $stream
+ * @param int $maxLen
+ * @param bool $isApproximate
+ *
+ * @return int The number of messages trimed from the stream.
+ *
+ * @link https://redis.io/commands/xtrim
+ * @example
+ *
+ * // Trim to exactly 100 messages
+ * $redis->xTrim('mystream', 100);
+ * // Let Redis approximate the trimming
+ * $redis->xTrim('mystream', 100, true);
+ *
+ */
+ public function xTrim($stream, $maxLen, $isApproximate)
+ {
+ }
+
+ /**
+ * Adds a values to the set value stored at key.
+ *
+ * @param string $key Required key
+ * @param array $values Required values
+ *
+ * @return int|bool The number of elements added to the set.
+ * If this value is already in the set, FALSE is returned
+ *
+ * @link https://redis.io/commands/sadd
+ * @link https://github.com/phpredis/phpredis/commit/3491b188e0022f75b938738f7542603c7aae9077
+ * @since phpredis 2.2.8
+ * @example
+ *
+ * $redis->sAddArray('k', array('v1')); // boolean
+ * $redis->sAddArray('k', array('v1', 'v2', 'v3')); // boolean
+ *
+ */
+ public function sAddArray($key, array $values)
+ {
+ }
+}
+
+class RedisException extends Exception
+{
+}
+
+/**
+ * @mixin \Redis
+ */
+class RedisArray
+{
+ /**
+ * Constructor
+ *
+ * @param string|array $hosts Name of the redis array from redis.ini or array of hosts to construct the array with
+ * @param array $opts Array of options
+ *
+ * @link https://github.com/nicolasff/phpredis/blob/master/arrays.markdown
+ */
+ public function __construct($hosts, array $opts = null)
+ {
+ }
+
+ /**
+ * @return array list of hosts for the selected array
+ */
+ public function _hosts()
+ {
+ }
+
+ /**
+ * @return string the name of the function used to extract key parts during consistent hashing
+ */
+ public function _function()
+ {
+ }
+
+ /**
+ * @param string $key The key for which you want to lookup the host
+ *
+ * @return string the host to be used for a certain key
+ */
+ public function _target($key)
+ {
+ }
+
+ /**
+ * Use this function when a new node is added and keys need to be rehashed.
+ */
+ public function _rehash()
+ {
+ }
+
+ /**
+ * Returns an associative array of strings and integers, with the following keys:
+ * - redis_version
+ * - redis_git_sha1
+ * - redis_git_dirty
+ * - redis_build_id
+ * - redis_mode
+ * - os
+ * - arch_bits
+ * - multiplexing_api
+ * - atomicvar_api
+ * - gcc_version
+ * - process_id
+ * - run_id
+ * - tcp_port
+ * - uptime_in_seconds
+ * - uptime_in_days
+ * - hz
+ * - lru_clock
+ * - executable
+ * - config_file
+ * - connected_clients
+ * - client_longest_output_list
+ * - client_biggest_input_buf
+ * - blocked_clients
+ * - used_memory
+ * - used_memory_human
+ * - used_memory_rss
+ * - used_memory_rss_human
+ * - used_memory_peak
+ * - used_memory_peak_human
+ * - used_memory_peak_perc
+ * - used_memory_peak
+ * - used_memory_overhead
+ * - used_memory_startup
+ * - used_memory_dataset
+ * - used_memory_dataset_perc
+ * - total_system_memory
+ * - total_system_memory_human
+ * - used_memory_lua
+ * - used_memory_lua_human
+ * - maxmemory
+ * - maxmemory_human
+ * - maxmemory_policy
+ * - mem_fragmentation_ratio
+ * - mem_allocator
+ * - active_defrag_running
+ * - lazyfree_pending_objects
+ * - mem_fragmentation_ratio
+ * - loading
+ * - rdb_changes_since_last_save
+ * - rdb_bgsave_in_progress
+ * - rdb_last_save_time
+ * - rdb_last_bgsave_status
+ * - rdb_last_bgsave_time_sec
+ * - rdb_current_bgsave_time_sec
+ * - rdb_last_cow_size
+ * - aof_enabled
+ * - aof_rewrite_in_progress
+ * - aof_rewrite_scheduled
+ * - aof_last_rewrite_time_sec
+ * - aof_current_rewrite_time_sec
+ * - aof_last_bgrewrite_status
+ * - aof_last_write_status
+ * - aof_last_cow_size
+ * - changes_since_last_save
+ * - aof_current_size
+ * - aof_base_size
+ * - aof_pending_rewrite
+ * - aof_buffer_length
+ * - aof_rewrite_buffer_length
+ * - aof_pending_bio_fsync
+ * - aof_delayed_fsync
+ * - loading_start_time
+ * - loading_total_bytes
+ * - loading_loaded_bytes
+ * - loading_loaded_perc
+ * - loading_eta_seconds
+ * - total_connections_received
+ * - total_commands_processed
+ * - instantaneous_ops_per_sec
+ * - total_net_input_bytes
+ * - total_net_output_bytes
+ * - instantaneous_input_kbps
+ * - instantaneous_output_kbps
+ * - rejected_connections
+ * - maxclients
+ * - sync_full
+ * - sync_partial_ok
+ * - sync_partial_err
+ * - expired_keys
+ * - evicted_keys
+ * - keyspace_hits
+ * - keyspace_misses
+ * - pubsub_channels
+ * - pubsub_patterns
+ * - latest_fork_usec
+ * - migrate_cached_sockets
+ * - slave_expires_tracked_keys
+ * - active_defrag_hits
+ * - active_defrag_misses
+ * - active_defrag_key_hits
+ * - active_defrag_key_misses
+ * - role
+ * - master_replid
+ * - master_replid2
+ * - master_repl_offset
+ * - second_repl_offset
+ * - repl_backlog_active
+ * - repl_backlog_size
+ * - repl_backlog_first_byte_offset
+ * - repl_backlog_histlen
+ * - master_host
+ * - master_port
+ * - master_link_status
+ * - master_last_io_seconds_ago
+ * - master_sync_in_progress
+ * - slave_repl_offset
+ * - slave_priority
+ * - slave_read_only
+ * - master_sync_left_bytes
+ * - master_sync_last_io_seconds_ago
+ * - master_link_down_since_seconds
+ * - connected_slaves
+ * - min-slaves-to-write
+ * - min-replicas-to-write
+ * - min_slaves_good_slaves
+ * - used_cpu_sys
+ * - used_cpu_user
+ * - used_cpu_sys_children
+ * - used_cpu_user_children
+ * - cluster_enabled
+ *
+ * @link https://redis.io/commands/info
+ * @return array
+ * @example
+ *
+ * $redis->info();
+ *
+ */
+ public function info() {
+ }
+}
diff --git a/.phan/internal_stubs/memcache.phan_php b/.phan/internal_stubs/memcache.phan_php
new file mode 100644
index 000000000..080129f49
--- /dev/null
+++ b/.phan/internal_stubs/memcache.phan_php
@@ -0,0 +1,460 @@
+
+ * Open memcached server connection
+ * @link https://php.net/manual/en/memcache.connect.php
+ * @param string $host
+ * 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 port must also
+ * be set to 0.
+ *
+ * @param int $port [optional]
+ * Point to the port where memcached is listening for connections. Set this
+ * parameter to 0 when using UNIX domain sockets.
+ *
+ *
+ * Please note: port defaults to
+ * {@link https://php.net/manual/ru/memcache.ini.php#ini.memcache.default-port memcache.default_port}
+ * if not specified. For this reason it is wise to specify the port
+ * explicitly in this method call.
+ *
+ * @param int $timeout [optional] 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.
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+ public function connect ($host, $port, $timeout = 1) {}
+
+ /**
+ * (PECL memcache >= 2.0.0)
+ * Add a memcached server to connection pool
+ * @link https://php.net/manual/en/memcache.addserver.php
+ * @param string $host
+ * 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 port must also
+ * be set to 0.
+ *
+ * @param int $port [optional]
+ * Point to the port where memcached is listening for connections.
+ * Set this
+ * parameter to 0 when using UNIX domain sockets.
+ *
+ *
+ * Please note: port defaults to
+ * memcache.default_port
+ * if not specified. For this reason it is wise to specify the port
+ * explicitly in this method call.
+ *
+ * @param bool $persistent [optional]
+ * Controls the use of a persistent connection. Default to TRUE.
+ *
+ * @param int $weight [optional]
+ * 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.
+ *
+ * @param int $timeout [optional]
+ * 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.
+ *
+ * @param int $retry_interval [optional]
+ * 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 persistent parameter has any
+ * effect when the extension is loaded dynamically via dl.
+ *
+ *
+ * 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 retry_interval seconds. The typical
+ * effect is that each web server child will retry the connection about every
+ * retry_interval seconds when serving a page.
+ *
+ * @param bool $status [optional]
+ * Controls if the server should be flagged as online. Setting this parameter
+ * to FALSE and retry_interval 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 memcache.allow_failover setting.
+ * Default to TRUE, meaning the server should be considered online.
+ *
+ * @param callable $failure_callback [optional]
+ * 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.
+ *
+ * @param int $timeoutms [optional]
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ */
+ public function addServer ($host, $port = 11211, $persistent = true, $weight = null, $timeout = 1, $retry_interval = 15, $status = true, callable $failure_callback = null, $timeoutms = null) {}
+
+ /**
+ * (PECL memcache >= 2.1.0)
+ * Changes server parameters and status at runtime
+ * @link https://secure.php.net/manual/en/memcache.setserverparams.php
+ * @param string $host Point to the host where memcached is listening for connections.
+ * Point to the port where memcached is listening for connections.
+ *
+ * @param int $timeout [optional]
+ * 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.
+ *
+ * @param int $retry_interval [optional]
+ * 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 persistent parameter has any
+ * effect when the extension is loaded dynamically via {@link https://secure.php.net/manual/en/function.dl.php dl()}.
+ *
+ * @param bool $status [optional]
+ * Controls if the server should be flagged as online. Setting this parameter
+ * to FALSE and retry_interval 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 memcache.allow_failover setting.
+ * Default to TRUE, meaning the server should be considered online.
+ *
+ * @param callable $failure_callback [optional]
+ * 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.
+ *
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+ public function setServerParams ($host, $port = 11211, $timeout = 1, $retry_interval = 15, $status = true, callable $failure_callback = null) {}
+
+ /**
+ *
+ */
+ public function setFailureCallback () {}
+
+ /**
+ * (PECL memcache >= 2.1.0)
+ * 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
+ */
+ public function getServerStatus ($host, $port = 11211) {}
+
+ /**
+ *
+ */
+ public function findServer () {}
+
+ /**
+ * (PECL memcache >= 0.2.0)
+ * Return version of the server
+ * @link https://php.net/manual/en/memcache.getversion.php
+ * @return string|false Returns a string of server version number or FALSE on failure.
+ */
+ public function getVersion () {}
+
+ /**
+ * (PECL memcache >= 2.0.0)
+ * Add an item to the server. If the key already exists, the value will not be added and FALSE will be returned.
+ * @link https://php.net/manual/en/memcache.add.php
+ * @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 TRUE on success or FALSE on failure. Returns FALSE if such key already exist. For the rest Memcache::add() behaves similarly to Memcache::set().
+ */
+ public function add ($key , $var, $flag = null, $expire = null) {}
+
+ /**
+ * (PECL memcache >= 0.2.0)
+ * 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 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 TRUE on success or FALSE on failure.
+ */
+ public function set ($key, $var, $flag = null, $expire = null) {}
+
+ /**
+ * (PECL memcache >= 0.2.0)
+ * Replace value of the existing item
+ * @link https://php.net/manual/en/memcache.replace.php
+ * @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 TRUE on success or FALSE on failure.
+ */
+ public function replace ($key, $var, $flag = null, $expire = null) {}
+
+ public function cas () {}
+
+ public function append () {}
+
+ /**
+ * @return string
+ */
+ public function prepend () {}
+
+ /**
+ * (PECL memcache >= 0.2.0)
+ * Retrieve item from the server
+ * @link https://php.net/manual/en/memcache.get.php
+ * @param string|array $key
+ * The key or array of keys to fetch.
+ *
+ * @param int|array $flags [optional]
+ * 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).
+ *
+ * @return string|array|false
+ * Returns the string associated with the key or
+ * an array of found key-value pairs when key is an {@link https://php.net/manual/en/language.types.array.php array}.
+ * Returns FALSE on failure, key is not found or
+ * key is an empty {@link https://php.net/manual/en/language.types.array.php array}.
+ *
+ */
+ public function get ($key, &$flags = null) {}
+
+ /**
+ * (PECL memcache >= 0.2.0)
+ * Delete item from the server
+ * https://secure.php.net/manual/ru/memcache.delete.php
+ * @param $key string The key associated with the item to delete.
+ * @param $timeout int [optional] This deprecated parameter is not supported, and defaults to 0 seconds. Do not use this parameter.
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+ public function delete ($key, $timeout = 0 ) {}
+
+ /**
+ * (PECL memcache >= 0.2.0)
+ * Get statistics of the server
+ * @link https://php.net/manual/ru/memcache.getstats.php
+ * @param string $type [optional]
+ * 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".
+ * @param int $slabid [optional]
+ * Used in conjunction with type 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.
+ *
+ * @param int $limit [optional]
+ * Used in conjunction with type set to cachedump to limit the number of entries to dump.
+ *
+ * @return array|false Returns an associative array of server statistics or FALSE on failure.
+ */
+ public function getStats ($type = null, $slabid = null, $limit = 100) {}
+
+ /**
+ * (PECL memcache >= 2.0.0)
+ * Get statistics from all servers in pool
+ * @link https://php.net/manual/en/memcache.getextendedstats.php
+ * @param string $type [optional] 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".
+ * @param int $slabid [optional]
+ * Used in conjunction with type 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.
+ *
+ * @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 FALSE
+ * Returns a two-dimensional associative array of server statistics or FALSE
+ * on failure.
+ */
+ public function getExtendedStats ($type = null, $slabid = null, $limit = 100) {}
+
+ /**
+ * (PECL memcache >= 2.0.0)
+ * Enable automatic compression of large values
+ * @link https://php.net/manual/en/memcache.setcompressthreshold.php
+ * @param int $thresold Controls the minimum value length before attempting to compress automatically.
+ * @param float $min_saving [optional] 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.
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+ public function setCompressThreshold ($thresold, $min_saving = 0.2) {}
+ /**
+ * (PECL memcache >= 0.2.0)
+ * Increment item's value
+ * @link https://php.net/manual/en/memcache.increment.php
+ * @param $key string Key of the item to increment.
+ * @param $value int [optional] increment the item by value
+ * @return int|false Returns new items value on success or FALSE on failure.
+ */
+ public function increment ($key, $value = 1) {}
+
+ /**
+ * (PECL memcache >= 0.2.0)
+ * Decrement item's value
+ * @link https://php.net/manual/en/memcache.decrement.php
+ * @param $key string Key of the item do decrement.
+ * @param $value int Decrement the item by value.
+ * @return int|false Returns item's new value on success or FALSE on failure.
+ */
+ public function decrement ($key, $value = 1) {}
+
+ /**
+ * (PECL memcache >= 0.4.0)
+ * Close memcached server connection
+ * @link https://php.net/manual/en/memcache.close.php
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+ public function close () {}
+
+ /**
+ * (PECL memcache >= 1.0.0)
+ * Flush all existing items at the server
+ * @link https://php.net/manual/en/memcache.flush.php
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+ public function flush () {}
+
+}
+
+/**
+ * Represents a connection to a set of memcache servers.
+ * @link https://php.net/manual/en/class.memcache.php
+ */
+class Memcache extends MemcachePool {
+
+
+ /**
+ * (PECL memcache >= 0.4.0)
+ * Open memcached server persistent connection
+ * @link https://php.net/manual/en/memcache.pconnect.php
+ * @param string $host
+ * 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 port must also
+ * be set to 0.
+ *
+ * @param int $port [optional]
+ * Point to the port where memcached is listening for connections. Set this
+ * parameter to 0 when using UNIX domain sockets.
+ *
+ * @param int $timeout [optional]
+ * 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.
+ *
+ * @return mixed a Memcache object or FALSE on failure.
+ */
+ public function pconnect ($host, $port, $timeout = 1) {}
+}
+
+// string $host [, int $port [, int $timeout ]]
+
+/**
+ * (PECL memcache >= 0.2.0)
+ * Memcache::connect — Open memcached server connection
+ * @link https://php.net/manual/en/memcache.connect.php
+ * @param string $host
+ * 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 port must also be set to 0.
+ *
+ * @param int $port [optional]
+ * Point to the port where memcached is listening for connections.
+ * Set this parameter to 0 when using UNIX domain sockets.
+ * Note: port defaults to memcache.default_port if not specified.
+ * For this reason it is wise to specify the port explicitly in this method call.
+ *
+ * @param int $timeout [optional]
+ * Value in seconds which will be used for connecting to the daemon.
+ *
+ * @return bool Returns TRUE on success or FALSE on failure.
+ */
+function memcache_connect ($host, $port, $timeout = 1) {}
+
+/**
+ * (PECL memcache >= 0.4.0)
+ * Memcache::pconnect — Open memcached server persistent connection
+ *
+ * @link https://php.net/manual/en/memcache.pconnect.php#example-5242
+ * @param $host
+ * @param null $port
+ * @param int $timeout
+ * @return Memcache
+ */
+function memcache_pconnect ($host, $port=null, $timeout=1) {}
+
+function memcache_add_server () {}
+
+function memcache_set_server_params () {}
+
+function memcache_set_failure_callback () {}
+
+function memcache_get_server_status () {}
+
+function memcache_get_version () {}
+
+function memcache_add () {}
+
+function memcache_set () {}
+
+function memcache_replace () {}
+
+function memcache_cas () {}
+
+function memcache_append () {}
+
+function memcache_prepend () {}
+
+function memcache_get () {}
+
+function memcache_delete () {}
+
+/**
+ * (PECL memcache >= 0.2.0)
+ * Turn debug output on/off
+ * @link https://php.net/manual/en/function.memcache-debug.php
+ * @param bool $on_off
+ * Turns debug output on if equals to TRUE.
+ * Turns debug output off if equals to FALSE.
+ *
+ * @return bool TRUE if PHP was built with --enable-debug option, otherwise
+ * returns FALSE.
+ */
+function memcache_debug ($on_off) {}
+
+function memcache_get_stats () {}
+
+function memcache_get_extended_stats () {}
+
+function memcache_set_compress_threshold () {}
+
+function memcache_increment () {}
+
+function memcache_decrement () {}
+
+function memcache_close () {}
+
+function memcache_flush () {}
+
+define ('MEMCACHE_COMPRESSED', 2);
+define ('MEMCACHE_USER1', 65536);
+define ('MEMCACHE_USER2', 131072);
+define ('MEMCACHE_USER3', 262144);
+define ('MEMCACHE_USER4', 524288);
+define ('MEMCACHE_HAVE_SESSION', 1);
+
+// End of memcache v.3.0.8
+?>
diff --git a/.phan/internal_stubs/memcached.phan_php b/.phan/internal_stubs/memcached.phan_php
new file mode 100644
index 000000000..f734bcbe5
--- /dev/null
+++ b/.phan/internal_stubs/memcached.phan_php
@@ -0,0 +1,1308 @@
+Enables or disables payload compression. When enabled,
+ * item values longer than a certain threshold (currently 100 bytes) will be
+ * compressed during storage and decompressed during retrieval
+ * transparently.
+ * Type: boolean, default: TRUE.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_COMPRESSION = -1001;
+ const OPT_COMPRESSION_TYPE = -1004;
+
+ /**
+ * This can be used to create a "domain" for your item keys. The value
+ * specified here will be prefixed to each of the keys. It cannot be
+ * longer than 128 characters and will reduce the
+ * maximum available key size. The prefix is applied only to the item keys,
+ * not to the server keys.
+ * Type: string, default: "".
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_PREFIX_KEY = -1002;
+
+ /**
+ *
+ * Specifies the serializer to use for serializing non-scalar values.
+ * The valid serializers are Memcached::SERIALIZER_PHP
+ * or Memcached::SERIALIZER_IGBINARY. The latter is
+ * supported only when memcached is configured with
+ * --enable-memcached-igbinary option and the
+ * igbinary extension is loaded.
+ *
+ * Type: integer, default: Memcached::SERIALIZER_PHP.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_SERIALIZER = -1003;
+
+ /**
+ * Indicates whether igbinary serializer support is available.
+ * Type: boolean.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HAVE_IGBINARY = 0;
+
+ /**
+ * Indicates whether JSON serializer support is available.
+ * Type: boolean.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HAVE_JSON = 0;
+ const HAVE_SESSION = 1;
+ const HAVE_SASL = 0;
+
+ /**
+ * Specifies the hashing algorithm used for the item keys. The valid
+ * values are supplied via Memcached::HASH_* constants.
+ * Each hash algorithm has its advantages and its disadvantages. Go with the
+ * default if you don't know or don't care.
+ * Type: integer, default: Memcached::HASH_DEFAULT
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_HASH = 2;
+
+ /**
+ * The default (Jenkins one-at-a-time) item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_DEFAULT = 0;
+
+ /**
+ * MD5 item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_MD5 = 1;
+
+ /**
+ * CRC item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_CRC = 2;
+
+ /**
+ * FNV1_64 item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_FNV1_64 = 3;
+
+ /**
+ * FNV1_64A item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_FNV1A_64 = 4;
+
+ /**
+ * FNV1_32 item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_FNV1_32 = 5;
+
+ /**
+ * FNV1_32A item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_FNV1A_32 = 6;
+
+ /**
+ * Hsieh item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_HSIEH = 7;
+
+ /**
+ * Murmur item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const HASH_MURMUR = 8;
+
+ /**
+ * Specifies the method of distributing item keys to the servers.
+ * Currently supported methods are modulo and consistent hashing. Consistent
+ * hashing delivers better distribution and allows servers to be added to
+ * the cluster with minimal cache losses.
+ * Type: integer, default: Memcached::DISTRIBUTION_MODULA.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_DISTRIBUTION = 9;
+
+ /**
+ * Modulo-based key distribution algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const DISTRIBUTION_MODULA = 0;
+
+ /**
+ * Consistent hashing key distribution algorithm (based on libketama).
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const DISTRIBUTION_CONSISTENT = 1;
+ const DISTRIBUTION_VIRTUAL_BUCKET = 6;
+
+ /**
+ * Enables or disables compatibility with libketama-like behavior. When
+ * enabled, the item key hashing algorithm is set to MD5 and distribution is
+ * set to be weighted consistent hashing distribution. This is useful
+ * because other libketama-based clients (Python, Ruby, etc.) with the same
+ * server configuration will be able to access the keys transparently.
+ *
+ *
+ * It is highly recommended to enable this option if you want to use
+ * consistent hashing, and it may be enabled by default in future
+ * releases.
+ *
+ * Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_LIBKETAMA_COMPATIBLE = 16;
+ const OPT_LIBKETAMA_HASH = 17;
+ const OPT_TCP_KEEPALIVE = 32;
+
+ /**
+ * Enables or disables buffered I/O. Enabling buffered I/O causes
+ * storage commands to "buffer" instead of being sent. Any action that
+ * retrieves data causes this buffer to be sent to the remote connection.
+ * Quitting the connection or closing down the connection will also cause
+ * the buffered data to be pushed to the remote connection.
+ * Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_BUFFER_WRITES = 10;
+
+ /**
+ * Enable the use of the binary protocol. Please note that you cannot
+ * toggle this option on an open connection.
+ * Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_BINARY_PROTOCOL = 18;
+
+ /**
+ * Enables or disables asynchronous I/O. This is the fastest transport
+ * available for storage functions.
+ * Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_NO_BLOCK = 0;
+
+ /**
+ * Enables or disables the no-delay feature for connecting sockets (may
+ * be faster in some environments).
+ * Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_TCP_NODELAY = 1;
+
+ /**
+ * The maximum socket send buffer in bytes.
+ * Type: integer, default: varies by platform/kernel
+ * configuration.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_SOCKET_SEND_SIZE = 4;
+
+ /**
+ * The maximum socket receive buffer in bytes.
+ * Type: integer, default: varies by platform/kernel
+ * configuration.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_SOCKET_RECV_SIZE = 5;
+
+ /**
+ * In non-blocking mode this set the value of the timeout during socket
+ * connection, in milliseconds.
+ * Type: integer, default: 1000.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_CONNECT_TIMEOUT = 14;
+
+ /**
+ * The amount of time, in seconds, to wait until retrying a failed
+ * connection attempt.
+ * Type: integer, default: 0.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_RETRY_TIMEOUT = 15;
+
+ /**
+ * Socket sending timeout, in microseconds. In cases where you cannot
+ * use non-blocking I/O this will allow you to still have timeouts on the
+ * sending of data.
+ * Type: integer, default: 0.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_SEND_TIMEOUT = 19;
+
+ /**
+ * Socket reading timeout, in microseconds. In cases where you cannot
+ * use non-blocking I/O this will allow you to still have timeouts on the
+ * reading of data.
+ * Type: integer, default: 0.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_RECV_TIMEOUT = 20;
+
+ /**
+ * Timeout for connection polling, in milliseconds.
+ * Type: integer, default: 1000.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_POLL_TIMEOUT = 8;
+
+ /**
+ * Enables or disables caching of DNS lookups.
+ * Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_CACHE_LOOKUPS = 6;
+
+ /**
+ * Specifies the failure limit for server connection attempts. The
+ * server will be removed after this many continuous connection
+ * failures.
+ * Type: integer, default: 0.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const OPT_SERVER_FAILURE_LIMIT = 21;
+ const OPT_AUTO_EJECT_HOSTS = 28;
+ const OPT_HASH_WITH_PREFIX_KEY = 25;
+ const OPT_NOREPLY = 26;
+ const OPT_SORT_HOSTS = 12;
+ const OPT_VERIFY_KEY = 13;
+ const OPT_USE_UDP = 27;
+ const OPT_NUMBER_OF_REPLICAS = 29;
+ const OPT_RANDOMIZE_REPLICA_READ = 30;
+ const OPT_CORK = 31;
+ const OPT_REMOVE_FAILED_SERVERS = 35;
+ const OPT_DEAD_TIMEOUT = 36;
+ const OPT_SERVER_TIMEOUT_LIMIT = 37;
+ const OPT_MAX = 38;
+ const OPT_IO_BYTES_WATERMARK = 23;
+ const OPT_IO_KEY_PREFETCH = 24;
+ const OPT_IO_MSG_WATERMARK = 22;
+ const OPT_LOAD_FROM_FILE = 34;
+ const OPT_SUPPORT_CAS = 7;
+ const OPT_TCP_KEEPIDLE = 33;
+ const OPT_USER_DATA = 11;
+
+
+ /**
+ * The operation was successful.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_SUCCESS = 0;
+
+ /**
+ * The operation failed in some fashion.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_FAILURE = 1;
+
+ /**
+ * DNS lookup failed.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_HOST_LOOKUP_FAILURE = 2;
+
+ /**
+ * Failed to read network data.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_UNKNOWN_READ_FAILURE = 7;
+
+ /**
+ * Bad command in memcached protocol.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_PROTOCOL_ERROR = 8;
+
+ /**
+ * Error on the client side.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_CLIENT_ERROR = 9;
+
+ /**
+ * Error on the server side.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_SERVER_ERROR = 10;
+
+ /**
+ * Failed to write network data.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_WRITE_FAILURE = 5;
+
+ /**
+ * Failed to do compare-and-swap: item you are trying to store has been
+ * modified since you last fetched it.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_DATA_EXISTS = 12;
+
+ /**
+ * Item was not stored: but not because of an error. This normally
+ * means that either the condition for an "add" or a "replace" command
+ * wasn't met, or that the item is in a delete queue.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_NOTSTORED = 14;
+
+ /**
+ * Item with this key was not found (with "get" operation or "cas"
+ * operations).
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_NOTFOUND = 16;
+
+ /**
+ * Partial network data read error.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_PARTIAL_READ = 18;
+
+ /**
+ * Some errors occurred during multi-get.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_SOME_ERRORS = 19;
+
+ /**
+ * Server list is empty.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_NO_SERVERS = 20;
+
+ /**
+ * End of result set.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_END = 21;
+
+ /**
+ * System error.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_ERRNO = 26;
+
+ /**
+ * The operation was buffered.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_BUFFERED = 32;
+
+ /**
+ * The operation timed out.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_TIMEOUT = 31;
+
+ /**
+ * Bad key.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_BAD_KEY_PROVIDED = 33;
+ const RES_STORED = 15;
+ const RES_DELETED = 22;
+ const RES_STAT = 24;
+ const RES_ITEM = 25;
+ const RES_NOT_SUPPORTED = 28;
+ const RES_FETCH_NOTFINISHED = 30;
+ const RES_SERVER_MARKED_DEAD = 35;
+ const RES_UNKNOWN_STAT_KEY = 36;
+ const RES_INVALID_HOST_PROTOCOL = 34;
+ const RES_MEMORY_ALLOCATION_FAILURE = 17;
+ const RES_E2BIG = 37;
+ const RES_KEY_TOO_BIG = 39;
+ const RES_SERVER_TEMPORARILY_DISABLED = 47;
+ const RES_SERVER_MEMORY_ALLOCATION_FAILURE = 48;
+ const RES_AUTH_PROBLEM = 40;
+ const RES_AUTH_FAILURE = 41;
+ const RES_AUTH_CONTINUE = 42;
+ const RES_CONNECTION_FAILURE = 3;
+ const RES_CONNECTION_BIND_FAILURE = 4;
+ const RES_READ_FAILURE = 6;
+ const RES_DATA_DOES_NOT_EXIST = 13;
+ const RES_VALUE = 23;
+ const RES_FAIL_UNIX_SOCKET = 27;
+ const RES_NO_KEY_PROVIDED = 29;
+ const RES_INVALID_ARGUMENTS = 38;
+ const RES_PARSE_ERROR = 43;
+ const RES_PARSE_USER_ERROR = 44;
+ const RES_DEPRECATED = 45;
+ const RES_IN_PROGRESS = 46;
+ const RES_MAXIMUM_RETURN = 49;
+
+
+
+ /**
+ * Failed to create network socket.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_CONNECTION_SOCKET_CREATE_FAILURE = 11;
+
+ /**
+ * Payload failure: could not compress/decompress or serialize/unserialize the value.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const RES_PAYLOAD_FAILURE = -1001;
+
+ /**
+ * The default PHP serializer.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const SERIALIZER_PHP = 1;
+
+ /**
+ * The igbinary serializer.
+ * Instead of textual representation it stores PHP data structures in a
+ * compact binary form, resulting in space and time gains.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const SERIALIZER_IGBINARY = 2;
+
+ /**
+ * The JSON serializer. Requires PHP 5.2.10+.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const SERIALIZER_JSON = 3;
+ const SERIALIZER_JSON_ARRAY = 4;
+ const COMPRESSION_FASTLZ = 2;
+ const COMPRESSION_ZLIB = 1;
+
+ /**
+ * A flag for Memcached::getMulti and
+ * Memcached::getMultiByKey to ensure that the keys are
+ * returned in the same order as they were requested in. Non-existing keys
+ * get a default value of NULL.
+ * @link https://php.net/manual/en/memcached.constants.php
+ */
+ const GET_PRESERVE_ORDER = 1;
+ const GET_ERROR_RETURN_VALUE = false;
+
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Create a Memcached instance
+ * @link https://php.net/manual/en/memcached.construct.php
+ * @param $persistent_id [optional]
+ * @param $callback [optional]
+ */
+ public function __construct ($persistent_id = '', $on_new_object_cb = null) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Return the result code of the last operation
+ * @link https://php.net/manual/en/memcached.getresultcode.php
+ * @return int Result code of the last Memcached operation.
+ */
+ public function getResultCode () {}
+
+ /**
+ * (PECL memcached >= 1.0.0)
+ * Return the message describing the result of the last operation
+ * @link https://php.net/manual/en/memcached.getresultmessage.php
+ * @return string Message describing the result of the last Memcached operation.
+ */
+ public function getResultMessage () {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Retrieve an item
+ * @link https://php.net/manual/en/memcached.get.php
+ * @param string $key
+ * The key of the item to retrieve.
+ *
+ * @param callable $cache_cb [optional]
+ * Read-through caching callback or NULL.
+ *
+ * @param int $flags [optional]
+ * The flags for the get operation.
+ *
+ * @return mixed the value stored in the cache or FALSE otherwise.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTFOUND if the key does not exist.
+ */
+ public function get ($key, callable $cache_cb = null, $flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Retrieve an item from a specific server
+ * @link https://php.net/manual/en/memcached.getbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key of the item to fetch.
+ *
+ * @param callable $cache_cb [optional]
+ * Read-through caching callback or NULL
+ *
+ * @param int $flags [optional]
+ * The flags for the get operation.
+ *
+ * @return mixed the value stored in the cache or FALSE otherwise.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTFOUND if the key does not exist.
+ */
+ public function getByKey ($server_key, $key, callable $cache_cb = null, $flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Retrieve multiple items
+ * @link https://php.net/manual/en/memcached.getmulti.php
+ * @param array $keys
+ * Array of keys to retrieve.
+ *
+ * @param int $flags [optional]
+ * The flags for the get operation.
+ *
+ * @return mixed the array of found items or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function getMulti (array $keys, $flags = null) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Retrieve multiple items from a specific server
+ * @link https://php.net/manual/en/memcached.getmultibykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param array $keys
+ * Array of keys to retrieve.
+ *
+ * @param int $flags [optional]
+ * The flags for the get operation.
+ *
+ * @return array|false the array of found items or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function getMultiByKey ($server_key, array $keys, $flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Request multiple items
+ * @link https://php.net/manual/en/memcached.getdelayed.php
+ * @param array $keys
+ * Array of keys to request.
+ *
+ * @param bool $with_cas [optional]
+ * Whether to request CAS token values also.
+ *
+ * @param callable $value_cb [optional]
+ * The result callback or NULL.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function getDelayed (array $keys, $with_cas = null, callable $value_cb = null) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Request multiple items from a specific server
+ * @link https://php.net/manual/en/memcached.getdelayedbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param array $keys
+ * Array of keys to request.
+ *
+ * @param bool $with_cas [optional]
+ * Whether to request CAS token values also.
+ *
+ * @param callable $value_cb [optional]
+ * The result callback or NULL.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function getDelayedByKey ($server_key, array $keys, $with_cas = null, callable $value_cb = null) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Fetch the next result
+ * @link https://php.net/manual/en/memcached.fetch.php
+ * @return array|false the next result or FALSE otherwise.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_END if result set is exhausted.
+ */
+ public function fetch () {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Fetch all the remaining results
+ * @link https://php.net/manual/en/memcached.fetchall.php
+ * @return array|false the results or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function fetchAll () {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Store an item
+ * @link https://php.net/manual/en/memcached.set.php
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param mixed $value
+ * The value to store.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function set ($key, $value, $expiration = 0, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Store an item on a specific server
+ * @link https://php.net/manual/en/memcached.setbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param mixed $value
+ * The value to store.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function setByKey ($server_key, $key, $value, $expiration = 0, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Set a new expiration on an item
+ * @link https://php.net/manual/en/memcached.touch.php
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param int $expiration
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function touch ($key, $expiration = 0) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Set a new expiration on an item on a specific server
+ * @link https://php.net/manual/en/memcached.touchbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param int $expiration
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function touchByKey ($server_key, $key, $expiration) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Store multiple items
+ * @link https://php.net/manual/en/memcached.setmulti.php
+ * @param array $items
+ * An array of key/value pairs to store on the server.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function setMulti (array $items, $expiration = 0, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Store multiple items on a specific server
+ * @link https://php.net/manual/en/memcached.setmultibykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param array $items
+ * An array of key/value pairs to store on the server.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function setMultiByKey ($server_key, array $items, $expiration = 0, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Compare and swap an item
+ * @link https://php.net/manual/en/memcached.cas.php
+ * @param float $cas_token
+ * Unique value associated with the existing item. Generated by memcache.
+ *
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param mixed $value
+ * The value to store.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_DATA_EXISTS if the item you are trying
+ * to store has been modified since you last fetched it.
+ */
+ public function cas ($cas_token, $key, $value, $expiration = 0, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Compare and swap an item on a specific server
+ * @link https://php.net/manual/en/memcached.casbykey.php
+ * @param float $cas_token
+ * Unique value associated with the existing item. Generated by memcache.
+ *
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param mixed $value
+ * The value to store.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_DATA_EXISTS if the item you are trying
+ * to store has been modified since you last fetched it.
+ */
+ public function casByKey ($cas_token, $server_key, $key, $value, $expiration = 0, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Add an item under a new key
+ * @link https://php.net/manual/en/memcached.add.php
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param mixed $value
+ * The value to store.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTSTORED if the key already exists.
+ */
+ public function add ($key, $value, $expiration = 0, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Add an item under a new key on a specific server
+ * @link https://php.net/manual/en/memcached.addbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param mixed $value
+ * The value to store.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTSTORED if the key already exists.
+ */
+ public function addByKey ($server_key, $key, $value, $expiration = 0, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Append data to an existing item
+ * @link https://php.net/manual/en/memcached.append.php
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param string $value
+ * The string to append.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTSTORED if the key does not exist.
+ */
+ public function append ($key, $value) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Append data to an existing item on a specific server
+ * @link https://php.net/manual/en/memcached.appendbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param string $value
+ * The string to append.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTSTORED if the key does not exist.
+ */
+ public function appendByKey ($server_key, $key, $value) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Prepend data to an existing item
+ * @link https://php.net/manual/en/memcached.prepend.php
+ * @param string $key
+ * The key of the item to prepend the data to.
+ *
+ * @param string $value
+ * The string to prepend.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTSTORED if the key does not exist.
+ */
+ public function prepend ($key, $value) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Prepend data to an existing item on a specific server
+ * @link https://php.net/manual/en/memcached.prependbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key of the item to prepend the data to.
+ *
+ * @param string $value
+ * The string to prepend.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTSTORED if the key does not exist.
+ */
+ public function prependByKey ($server_key, $key, $value) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Replace the item under an existing key
+ * @link https://php.net/manual/en/memcached.replace.php
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param mixed $value
+ * The value to store.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTSTORED if the key does not exist.
+ */
+ public function replace ($key, $value, $expiration = null, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Replace the item under an existing key on a specific server
+ * @link https://php.net/manual/en/memcached.replacebykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key under which to store the value.
+ *
+ * @param mixed $value
+ * The value to store.
+ *
+ * @param int $expiration [optional]
+ * The expiration time, defaults to 0. See Expiration Times for more info.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTSTORED if the key does not exist.
+ */
+ public function replaceByKey ($server_key, $key, $value, $expiration = null, $udf_flags = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Delete an item
+ * @link https://php.net/manual/en/memcached.delete.php
+ * @param string $key
+ * The key to be deleted.
+ *
+ * @param int $time [optional]
+ * The amount of time the server will wait to delete the item.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTFOUND if the key does not exist.
+ */
+ public function delete ($key, $time = 0) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Delete multiple items
+ * @link https://php.net/manual/en/memcached.deletemulti.php
+ * @param array $keys
+ * The keys to be deleted.
+ *
+ * @param int $time [optional]
+ * The amount of time the server will wait to delete the items.
+ *
+ * @return array Returns array indexed by keys and where values are indicating whether operation succeeded or not.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTFOUND if the key does not exist.
+ */
+ public function deleteMulti (array $keys, $time = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Delete an item from a specific server
+ * @link https://php.net/manual/en/memcached.deletebykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key to be deleted.
+ *
+ * @param int $time [optional]
+ * The amount of time the server will wait to delete the item.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTFOUND if the key does not exist.
+ */
+ public function deleteByKey ($server_key, $key, $time = 0) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Delete multiple items from a specific server
+ * @link https://php.net/manual/en/memcached.deletemultibykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param array $keys
+ * The keys to be deleted.
+ *
+ * @param int $time [optional]
+ * The amount of time the server will wait to delete the items.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * The Memcached::getResultCode will return
+ * Memcached::RES_NOTFOUND if the key does not exist.
+ */
+ public function deleteMultiByKey ($server_key, array $keys, $time = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Increment numeric item's value
+ * @link https://php.net/manual/en/memcached.increment.php
+ * @param string $key
+ * The key of the item to increment.
+ *
+ * @param int $offset [optional]
+ * The amount by which to increment the item's value.
+ *
+ * @param int $initial_value [optional]
+ * The value to set the item to if it doesn't currently exist.
+ *
+ * @param int $expiry [optional]
+ * The expiry time to set on the item.
+ *
+ * @return int|false new item's value on success or FALSE on failure.
+ */
+ public function increment ($key, $offset = 1, $initial_value = 0, $expiry = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Decrement numeric item's value
+ * @link https://php.net/manual/en/memcached.decrement.php
+ * @param string $key
+ * The key of the item to decrement.
+ *
+ * @param int $offset [optional]
+ * The amount by which to decrement the item's value.
+ *
+ * @param int $initial_value [optional]
+ * The value to set the item to if it doesn't currently exist.
+ *
+ * @param int $expiry [optional]
+ * The expiry time to set on the item.
+ *
+ * @return int|false item's new value on success or FALSE on failure.
+ */
+ public function decrement ($key, $offset = 1, $initial_value = 0, $expiry = 0) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Increment numeric item's value, stored on a specific server
+ * @link https://php.net/manual/en/memcached.incrementbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key of the item to increment.
+ *
+ * @param int $offset [optional]
+ * The amount by which to increment the item's value.
+ *
+ * @param int $initial_value [optional]
+ * The value to set the item to if it doesn't currently exist.
+ *
+ * @param int $expiry [optional]
+ * The expiry time to set on the item.
+ *
+ * @return int|false new item's value on success or FALSE on failure.
+ */
+ public function incrementByKey ($server_key, $key, $offset = 1, $initial_value = 0, $expiry = 0) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Decrement numeric item's value, stored on a specific server
+ * @link https://php.net/manual/en/memcached.decrementbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @param string $key
+ * The key of the item to decrement.
+ *
+ * @param int $offset [optional]
+ * The amount by which to decrement the item's value.
+ *
+ * @param int $initial_value [optional]
+ * The value to set the item to if it doesn't currently exist.
+ *
+ * @param int $expiry [optional]
+ * The expiry time to set on the item.
+ *
+ * @return int|false item's new value on success or FALSE on failure.
+ */
+ public function decrementByKey ($server_key, $key, $offset = 1, $initial_value = 0, $expiry = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Add a server to the server pool
+ * @link https://php.net/manual/en/memcached.addserver.php
+ * @param string $host
+ * The hostname of the memcache server. If the hostname is invalid, data-related
+ * operations will set
+ * Memcached::RES_HOST_LOOKUP_FAILURE result code.
+ *
+ * @param int $port
+ * The port on which memcache is running. Usually, this is
+ * 11211.
+ *
+ * @param int $weight [optional]
+ * The weight of the server relative to the total weight of all the
+ * servers in the pool. This controls the probability of the server being
+ * selected for operations. This is used only with consistent distribution
+ * option and usually corresponds to the amount of memory available to
+ * memcache on that server.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ */
+ public function addServer ($host, $port, $weight = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.1)
+ * Add multiple servers to the server pool
+ * @link https://php.net/manual/en/memcached.addservers.php
+ * @param array $servers
+ * @return bool TRUE on success or FALSE on failure.
+ */
+ public function addServers (array $servers) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Get the list of the servers in the pool
+ * @link https://php.net/manual/en/memcached.getserverlist.php
+ * @return array The list of all servers in the server pool.
+ */
+ public function getServerList () {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Map a key to a server
+ * @link https://php.net/manual/en/memcached.getserverbykey.php
+ * @param string $server_key
+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
+ *
+ * @return array an array containing three keys of host,
+ * port, and weight on success or FALSE
+ * on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function getServerByKey ($server_key) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Clears all servers from the server list
+ * @link https://php.net/manual/en/memcached.resetserverlist.php
+ * @return bool TRUE on success or FALSE on failure.
+ */
+ public function resetServerList () {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Close any open connections
+ * @link https://php.net/manual/en/memcached.quit.php
+ * @return bool TRUE on success or FALSE on failure.
+ */
+ public function quit () {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Get server pool statistics
+ * @link https://php.net/manual/en/memcached.getstats.php
+ * @param string $type
+ * @return array Array of server statistics, one entry per server.
+ */
+ public function getStats ($type = null) {}
+
+ /**
+ * (PECL memcached >= 0.1.5)
+ * Get server pool version info
+ * @link https://php.net/manual/en/memcached.getversion.php
+ * @return array Array of server versions, one entry per server.
+ */
+ public function getVersion () {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Gets the keys stored on all the servers
+ * @link https://php.net/manual/en/memcached.getallkeys.php
+ * @return array|false the keys stored on all the servers on success or FALSE on failure.
+ */
+ public function getAllKeys () {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Invalidate all items in the cache
+ * @link https://php.net/manual/en/memcached.flush.php
+ * @param int $delay [optional]
+ * Numer of seconds to wait before invalidating the items.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * Use Memcached::getResultCode if necessary.
+ */
+ public function flush ($delay = 0) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Retrieve a Memcached option value
+ * @link https://php.net/manual/en/memcached.getoption.php
+ * @param int $option
+ * One of the Memcached::OPT_* constants.
+ *
+ * @return mixed the value of the requested option, or FALSE on
+ * error.
+ */
+ public function getOption ($option) {}
+
+ /**
+ * (PECL memcached >= 0.1.0)
+ * Set a Memcached option
+ * @link https://php.net/manual/en/memcached.setoption.php
+ * @param int $option
+ * @param mixed $value
+ * @return bool TRUE on success or FALSE on failure.
+ */
+ public function setOption ($option, $value) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Set Memcached options
+ * @link https://php.net/manual/en/memcached.setoptions.php
+ * @param array $options
+ * An associative array of options where the key is the option to set and
+ * the value is the new value for the option.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ */
+ public function setOptions (array $options) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Set the credentials to use for authentication
+ * @link https://secure.php.net/manual/en/memcached.setsaslauthdata.php
+ * @param string $username
+ * The username to use for authentication.
+ *
+ * @param string $password
+ * The password to use for authentication.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ */
+ public function setSaslAuthData (string $username , string $password) {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Check if a persitent connection to memcache is being used
+ * @link https://php.net/manual/en/memcached.ispersistent.php
+ * @return bool true if Memcache instance uses a persistent connection, false otherwise.
+ */
+ public function isPersistent () {}
+
+ /**
+ * (PECL memcached >= 2.0.0)
+ * Check if the instance was recently created
+ * @link https://php.net/manual/en/memcached.ispristine.php
+ * @return bool the true if instance is recently created, false otherwise.
+ */
+ public function isPristine () {}
+
+ public function flushBuffers () {}
+
+ public function setEncodingKey ( $key ) {}
+
+ public function getLastDisconnectedServer () {}
+
+ public function getLastErrorErrno () {}
+
+ public function getLastErrorCode () {}
+
+ public function getLastErrorMessage () {}
+
+ public function setBucket (array $host_map, array $forward_map, $replicas) {}
+
+}
+
+/**
+ * @link https://php.net/manual/en/class.memcachedexception.php
+ */
+class MemcachedException extends RuntimeException {
+
+}
+// End of memcached v.3.0.4
+?>
diff --git a/system/src/Grav/Common/Assets/BaseAsset.php b/system/src/Grav/Common/Assets/BaseAsset.php
index d2de003a8..f7d2cd767 100644
--- a/system/src/Grav/Common/Assets/BaseAsset.php
+++ b/system/src/Grav/Common/Assets/BaseAsset.php
@@ -162,7 +162,7 @@ abstract class BaseAsset extends PropertyObject
*
* @param string $asset the asset string reference
*
- * @return string the final link url to the asset
+ * @return string|false the final link url to the asset
*/
protected function buildLocalLink($asset)
{
diff --git a/system/src/Grav/Common/Assets/Traits/AssetUtilsTrait.php b/system/src/Grav/Common/Assets/Traits/AssetUtilsTrait.php
index 0a1d149de..1d833b921 100644
--- a/system/src/Grav/Common/Assets/Traits/AssetUtilsTrait.php
+++ b/system/src/Grav/Common/Assets/Traits/AssetUtilsTrait.php
@@ -5,6 +5,8 @@
*
* @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
* @license MIT License; see LICENSE file for details.
+ *
+ * @phan-file-suppress PhanUndeclaredProperty,PhanUndeclaredConstant,PhanUndeclaredMethod
*/
namespace Grav\Common\Assets\Traits;
diff --git a/system/src/Grav/Common/Assets/Traits/LegacyAssetsTrait.php b/system/src/Grav/Common/Assets/Traits/LegacyAssetsTrait.php
index c233cb4a7..74aa5d540 100644
--- a/system/src/Grav/Common/Assets/Traits/LegacyAssetsTrait.php
+++ b/system/src/Grav/Common/Assets/Traits/LegacyAssetsTrait.php
@@ -96,6 +96,7 @@ trait LegacyAssetsTrait
*
* @return \Grav\Common\Assets
* @deprecated Please use dynamic method with ['loading' => 'async'].
+ * @suppress PhanUndeclaredMethod
*/
public function addAsyncJs($asset, $priority = 10, $pipeline = true, $group = 'head')
{
@@ -114,6 +115,7 @@ trait LegacyAssetsTrait
*
* @return \Grav\Common\Assets
* @deprecated Please use dynamic method with ['loading' => 'defer'].
+ * @suppress PhanUndeclaredMethod
*/
public function addDeferJs($asset, $priority = 10, $pipeline = true, $group = 'head')
{
diff --git a/system/src/Grav/Common/Assets/Traits/TestingAssetsTrait.php b/system/src/Grav/Common/Assets/Traits/TestingAssetsTrait.php
index 7c054e834..a7a791ff8 100644
--- a/system/src/Grav/Common/Assets/Traits/TestingAssetsTrait.php
+++ b/system/src/Grav/Common/Assets/Traits/TestingAssetsTrait.php
@@ -5,6 +5,8 @@
*
* @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
* @license MIT License; see LICENSE file for details.
+ *
+ * @phan-file-suppress PhanUndeclaredProperty,PhanUndeclaredConstant,PhanUndeclaredMethod
*/
namespace Grav\Common\Assets\Traits;
diff --git a/system/src/Grav/Common/Backup/Backups.php b/system/src/Grav/Common/Backup/Backups.php
index 054901f6c..e76e05ad6 100644
--- a/system/src/Grav/Common/Backup/Backups.php
+++ b/system/src/Grav/Common/Backup/Backups.php
@@ -159,7 +159,7 @@ class Backups
$date = date(static::BACKUP_DATE_FORMAT, time());
$filename = trim($name, '_') . '--' . $date . '.zip';
$destination = static::$backup_dir . DS . $filename;
- $max_execution_time = ini_set('max_execution_time', 600);
+ $max_execution_time = ini_set('max_execution_time', '600');
$backup_root = $backup->root;
if ($locator->isStream($backup_root)) {
diff --git a/system/src/Grav/Common/Browser.php b/system/src/Grav/Common/Browser.php
index 037d454e2..f48fd34ba 100644
--- a/system/src/Grav/Common/Browser.php
+++ b/system/src/Grav/Common/Browser.php
@@ -108,7 +108,7 @@ class Browser
/**
* Get the current major version identifier
*
- * @return string the browser major version identifier
+ * @return int the browser major version identifier
*/
public function getVersion()
{
diff --git a/system/src/Grav/Common/Composer.php b/system/src/Grav/Common/Composer.php
index c6abb2c6c..dde354117 100644
--- a/system/src/Grav/Common/Composer.php
+++ b/system/src/Grav/Common/Composer.php
@@ -26,7 +26,7 @@ class Composer
}
// check for global composer install
- $path = trim(shell_exec('command -v composer'));
+ $path = trim((string)shell_exec('command -v composer'));
// fall back to grav bundled composer
if (!$path || !preg_match('/(composer|composer\.phar)$/', $path)) {
diff --git a/system/src/Grav/Common/Config/CompiledBase.php b/system/src/Grav/Common/Config/CompiledBase.php
index 708a292ca..a2cc3a511 100644
--- a/system/src/Grav/Common/Config/CompiledBase.php
+++ b/system/src/Grav/Common/Config/CompiledBase.php
@@ -29,7 +29,7 @@ abstract class CompiledBase
public $checksum;
/**
- * @var string Timestamp of compiled configuration
+ * @var int Timestamp of compiled configuration
*/
public $timestamp;
@@ -159,7 +159,7 @@ abstract class CompiledBase
* Load single configuration file and append it to the correct position.
*
* @param string $name Name of the position.
- * @param string $filename File to be loaded.
+ * @param string|string[] $filename File(s) to be loaded.
*/
abstract protected function loadFile($name, $filename);
diff --git a/system/src/Grav/Common/Config/ConfigFileFinder.php b/system/src/Grav/Common/Config/ConfigFileFinder.php
index 1e7adca59..b98e3a94d 100644
--- a/system/src/Grav/Common/Config/ConfigFileFinder.php
+++ b/system/src/Grav/Common/Config/ConfigFileFinder.php
@@ -50,6 +50,7 @@ class ConfigFileFinder
* @param string $pattern Pattern to match the file. Pattern will also be removed from the key.
* @param int $levels Maximum number of recursive directories.
* @return array
+ * @suppress PhanTypeMismatchReturn - false positive on the += array trick
*/
public function getFiles(array $paths, $pattern = '|\.yaml$|', $levels = -1)
{
diff --git a/system/src/Grav/Common/Config/Setup.php b/system/src/Grav/Common/Config/Setup.php
index 6a4d336bb..ebc03c23d 100644
--- a/system/src/Grav/Common/Config/Setup.php
+++ b/system/src/Grav/Common/Config/Setup.php
@@ -150,6 +150,7 @@ class Setup extends Data
/**
* @param Container|array $container
+ * @suppress PhanUndeclaredConstant
*/
public function __construct($container)
{
diff --git a/system/src/Grav/Common/Data/Blueprint.php b/system/src/Grav/Common/Data/Blueprint.php
index dbd9f5988..f7dcd780e 100644
--- a/system/src/Grav/Common/Data/Blueprint.php
+++ b/system/src/Grav/Common/Data/Blueprint.php
@@ -28,7 +28,7 @@ class Blueprint extends BlueprintForm
/** @var object */
protected $object;
- /** @var array */
+ /** @var ?array */
protected $defaults;
protected $handlers = [];
diff --git a/system/src/Grav/Common/Data/Data.php b/system/src/Grav/Common/Data/Data.php
index 496fd2e2e..4a6db8657 100644
--- a/system/src/Grav/Common/Data/Data.php
+++ b/system/src/Grav/Common/Data/Data.php
@@ -34,7 +34,7 @@ class Data implements DataInterface, \ArrayAccess, \Countable, \JsonSerializable
/**
* @param array $items
- * @param Blueprint|callable $blueprints
+ * @param Blueprint|callable|null $blueprints
*/
public function __construct(array $items = [], $blueprints = null)
{
@@ -197,13 +197,13 @@ class Data implements DataInterface, \ArrayAccess, \Countable, \JsonSerializable
}
/**
+ * @param mixed ...$args
* @return $this
*/
- public function filter()
+ public function filter(...$args)
{
- $args = func_get_args();
- $missingValuesAsNull = (bool)(array_shift($args) ?: false);
- $keepEmptyValues = (bool)(array_shift($args) ?: false);
+ $missingValuesAsNull = $args[0] ?? false;
+ $keepEmptyValues = $args[1] ?? false;
$this->items = $this->blueprints()->filter($this->items, $missingValuesAsNull, $keepEmptyValues);
@@ -280,7 +280,7 @@ class Data implements DataInterface, \ArrayAccess, \Countable, \JsonSerializable
/**
* Set or get the data storage.
*
- * @param FileInterface $storage Optionally enter a new storage.
+ * @param ?FileInterface $storage Optionally enter a new storage.
* @return FileInterface
*/
public function file(FileInterface $storage = null)
diff --git a/system/src/Grav/Common/Data/DataInterface.php b/system/src/Grav/Common/Data/DataInterface.php
index 91279b28e..1bc0ee9a0 100644
--- a/system/src/Grav/Common/Data/DataInterface.php
+++ b/system/src/Grav/Common/Data/DataInterface.php
@@ -63,7 +63,7 @@ interface DataInterface
/**
* Set or get the data storage.
*
- * @param FileInterface $storage Optionally enter a new storage.
+ * @param ?FileInterface $storage Optionally enter a new storage.
* @return FileInterface
*/
public function file(FileInterface $storage = null);
diff --git a/system/src/Grav/Common/Debugger.php b/system/src/Grav/Common/Debugger.php
index ffcefef69..7a3936552 100644
--- a/system/src/Grav/Common/Debugger.php
+++ b/system/src/Grav/Common/Debugger.php
@@ -73,7 +73,7 @@ class Debugger
/** @var array $deprecations */
protected $deprecations = [];
- /** @var callable */
+ /** @var ?callable */
protected $errorHandler;
protected $requestTime;
@@ -403,6 +403,7 @@ class Debugger
$this->renderer = $this->debugbar->getJavascriptRenderer();
$this->renderer->setIncludeVendors(false);
+ // @phan-suppress-next-line PhanTypeMismatchArgument maximebf/debugbar has an incorrect phpdoc type for $type
list($css_files, $js_files) = $this->renderer->getAssets(null, JavascriptRenderer::RELATIVE_URL);
foreach ((array)$css_files as $css) {
@@ -430,7 +431,7 @@ class Debugger
/**
* Adds a data collector
*
- * @param DataCollectorInterface $collector
+ * @param string $collector
*
* @return $this
* @throws \DebugBar\DebugBarException
@@ -503,7 +504,7 @@ class Debugger
/**
* Returns collected debugger data.
*
- * @return array
+ * @return ?array
*/
public function getData()
{
@@ -781,6 +782,7 @@ class Debugger
* @param string $errfile
* @param int $errline
* @return bool
+ * @suppress PhanAccessMethodInternal,PhanTypeArraySuspicious,PhanTypeArraySuspiciousNull
*/
public function deprecatedErrorHandler($errno, $errstr, $errfile, $errline)
{
diff --git a/system/src/Grav/Common/File/CompiledFile.php b/system/src/Grav/Common/File/CompiledFile.php
index 45ffb8fde..a6c08c514 100644
--- a/system/src/Grav/Common/File/CompiledFile.php
+++ b/system/src/Grav/Common/File/CompiledFile.php
@@ -5,6 +5,8 @@
*
* @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
* @license MIT License; see LICENSE file for details.
+ *
+ * @phan-file-suppress PhanUndeclaredProperty,PhanUndeclaredMethod,PhanTraitParentReference,PhanUndeclaredStaticProperty
*/
namespace Grav\Common\File;
diff --git a/system/src/Grav/Common/GPM/Common/Package.php b/system/src/Grav/Common/GPM/Common/Package.php
index 88d0c01b4..1c7f9cbb8 100644
--- a/system/src/Grav/Common/GPM/Common/Package.php
+++ b/system/src/Grav/Common/GPM/Common/Package.php
@@ -45,7 +45,7 @@ class Package
public function __set($key, $value)
{
- return $this->data->set($key, $value);
+ $this->data->set($key, $value);
}
public function __isset($key)
diff --git a/system/src/Grav/Common/GPM/GPM.php b/system/src/Grav/Common/GPM/GPM.php
index 0cb6486ce..126a9e805 100644
--- a/system/src/Grav/Common/GPM/GPM.php
+++ b/system/src/Grav/Common/GPM/GPM.php
@@ -110,7 +110,7 @@ class GPM extends Iterator
* Return the instance of a specific Package
*
* @param string $slug The slug of the Package
- * @return Local\Package The instance of the Package
+ * @return ?Local\Package The instance of the Package
*/
public function getInstalledPackage($slug)
{
diff --git a/system/src/Grav/Common/GPM/Installer.php b/system/src/Grav/Common/GPM/Installer.php
index 62ef3b3d5..fb1bdb19e 100644
--- a/system/src/Grav/Common/GPM/Installer.php
+++ b/system/src/Grav/Common/GPM/Installer.php
@@ -40,7 +40,7 @@ class Installer
protected static $target;
/**
- * @var int Error Code
+ * @var int|string Error code or string
*/
protected static $error = 0;
diff --git a/system/src/Grav/Common/GPM/Remote/GravCore.php b/system/src/Grav/Common/GPM/Remote/GravCore.php
index 1d30120d0..962a7b38a 100644
--- a/system/src/Grav/Common/GPM/Remote/GravCore.php
+++ b/system/src/Grav/Common/GPM/Remote/GravCore.php
@@ -15,6 +15,7 @@ use \Doctrine\Common\Cache\FilesystemCache;
class GravCore extends AbstractPackageCollection
{
protected $repository = 'https://getgrav.org/downloads/grav.json';
+ /** @var array */
private $data;
private $version;
@@ -23,7 +24,7 @@ class GravCore extends AbstractPackageCollection
/**
* @param bool $refresh
- * @param null $callback
+ * @param ?callable $callback
* @throws \InvalidArgumentException
*/
public function __construct($refresh = false, $callback = null)
diff --git a/system/src/Grav/Common/GPM/Response.php b/system/src/Grav/Common/GPM/Response.php
index 5c203fa87..94a654cbf 100644
--- a/system/src/Grav/Common/GPM/Response.php
+++ b/system/src/Grav/Common/GPM/Response.php
@@ -251,7 +251,7 @@ class Response
/**
* Automatically picks the preferred method
*
- * @return string The response of the request
+ * @return ?string The response of the request
*/
private static function getAuto()
{
@@ -270,6 +270,8 @@ class Response
* Starts a HTTP request via fopen
*
* @return string The response of the request
+ *
+ * @suppress PhanTypeInvalidDimOffset,PhanTypeMismatchArgumentInternal
*/
private static function getFopen()
{
diff --git a/system/src/Grav/Common/GPM/Upgrader.php b/system/src/Grav/Common/GPM/Upgrader.php
index 5d9406d5a..71221ba2f 100644
--- a/system/src/Grav/Common/GPM/Upgrader.php
+++ b/system/src/Grav/Common/GPM/Upgrader.php
@@ -109,7 +109,7 @@ class Upgrader
/**
* Get minimum PHP version from remote
*
- * @return null
+ * @return string
*/
public function minPHPVersion()
{
diff --git a/system/src/Grav/Common/Grav.php b/system/src/Grav/Common/Grav.php
index b685a58f5..3f671a443 100644
--- a/system/src/Grav/Common/Grav.php
+++ b/system/src/Grav/Common/Grav.php
@@ -47,13 +47,15 @@ class Grav extends Container
public $output;
/**
- * @var static The singleton instance
+ * @var ?static The singleton instance
*/
protected static $instance;
/**
* @var array Contains all Services and ServicesProviders that are mapped
* to the dependency injection container.
+ *
+ * @suppress PhanPluginMixedKeyNoKey
*/
protected static $diMap = [
'Grav\Common\Service\AccountsServiceProvider',
@@ -121,7 +123,7 @@ class Grav extends Container
*/
public static function instance(array $values = [])
{
- if (!self::$instance) {
+ if (empty(self::$instance)) {
self::$instance = static::load($values);
} elseif ($values) {
$instance = self::$instance;
@@ -154,9 +156,6 @@ class Grav extends Container
Setup::$environment = $environment;
}
- $this['setup'];
- $this['streams'];
-
return $this;
}
@@ -376,7 +375,7 @@ class Grav extends Container
* Fires an event with optional parameters.
*
* @param string $eventName
- * @param Event $event
+ * @param ?Event $event
*
* @return Event
*/
diff --git a/system/src/Grav/Common/Helpers/Truncator.php b/system/src/Grav/Common/Helpers/Truncator.php
index 015a47dd6..6447343b5 100644
--- a/system/src/Grav/Common/Helpers/Truncator.php
+++ b/system/src/Grav/Common/Helpers/Truncator.php
@@ -132,7 +132,7 @@ class Truncator
/**
* Builds a DOMDocument object from a string containing HTML.
* @param string $html HTML to load
- * @returns DOMDocument Returns a DOMDocument object.
+ * @return DOMDocument Returns a DOMDocument object.
*/
public static function htmlToDomDocument($html)
{
diff --git a/system/src/Grav/Common/Iterator.php b/system/src/Grav/Common/Iterator.php
index cfb5e6c63..6664481b9 100644
--- a/system/src/Grav/Common/Iterator.php
+++ b/system/src/Grav/Common/Iterator.php
@@ -247,7 +247,6 @@ class Iterator implements \ArrayAccess, \Iterator, \Countable, \Serializable
* @param bool $desc
*
* @return $this|array
- * @internal param bool $asc
*
*/
public function sort(callable $callback = null, $desc = false)
diff --git a/system/src/Grav/Common/Language/Language.php b/system/src/Grav/Common/Language/Language.php
index a10b15cdc..6e1dc87b8 100644
--- a/system/src/Grav/Common/Language/Language.php
+++ b/system/src/Grav/Common/Language/Language.php
@@ -450,7 +450,7 @@ class Language
*
* @param string|array $args The first argument is the lookup key value
* Other arguments can be passed and replaced in the translation with sprintf syntax
- * @param array $languages
+ * @param ?array $languages
* @param bool $array_support
* @param bool $html_out
*
diff --git a/system/src/Grav/Common/Markdown/ParsedownGravTrait.php b/system/src/Grav/Common/Markdown/ParsedownGravTrait.php
index aa76cdf0c..54183c36b 100644
--- a/system/src/Grav/Common/Markdown/ParsedownGravTrait.php
+++ b/system/src/Grav/Common/Markdown/ParsedownGravTrait.php
@@ -5,6 +5,8 @@
*
* @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
* @license MIT License; see LICENSE file for details.
+ *
+ * @phan-file-suppress PhanUndeclaredProperty,PhanTraitParentReference
*/
namespace Grav\Common\Markdown;
diff --git a/system/src/Grav/Common/Page/Flex/Traits/PageContentTrait.php b/system/src/Grav/Common/Page/Flex/Traits/PageContentTrait.php
index bcf31b915..3b381f1f3 100644
--- a/system/src/Grav/Common/Page/Flex/Traits/PageContentTrait.php
+++ b/system/src/Grav/Common/Page/Flex/Traits/PageContentTrait.php
@@ -15,6 +15,8 @@ use Grav\Common\Utils;
/**
* Implements PageContentInterface.
+ *
+ * @phan-file-suppress PhanUndeclaredMethod
*/
trait PageContentTrait
{
diff --git a/system/src/Grav/Common/Page/Flex/Traits/PageLegacyTrait.php b/system/src/Grav/Common/Page/Flex/Traits/PageLegacyTrait.php
index 41e5110a2..d65506bc6 100644
--- a/system/src/Grav/Common/Page/Flex/Traits/PageLegacyTrait.php
+++ b/system/src/Grav/Common/Page/Flex/Traits/PageLegacyTrait.php
@@ -20,6 +20,8 @@ use Grav\Common\Utils;
/**
* Implements PageLegacyInterface.
+ *
+ * @phan-file-suppress PhanUndeclaredMethod
*/
trait PageLegacyTrait
{
@@ -105,7 +107,7 @@ trait PageLegacyTrait
/**
* Helper method to return an ancestor page.
*
- * @param bool $lookup Name of the parent folder
+ * @param ?string $lookup Name of the parent folder
*
* @return PageInterface|null page you were looking for if it exists
*/
diff --git a/system/src/Grav/Common/Page/Flex/Traits/PageRoutableTrait.php b/system/src/Grav/Common/Page/Flex/Traits/PageRoutableTrait.php
index 0e6adf154..d0ac9ddf1 100644
--- a/system/src/Grav/Common/Page/Flex/Traits/PageRoutableTrait.php
+++ b/system/src/Grav/Common/Page/Flex/Traits/PageRoutableTrait.php
@@ -19,6 +19,8 @@ use Grav\Common\Utils;
/**
* Implements PageRoutableInterface.
+ *
+ * @phan-file-suppress PhanUndeclaredMethod
*/
trait PageRoutableTrait
{
@@ -49,7 +51,7 @@ trait PageRoutableTrait
/**
* Gets and Sets the parent object for this page
*
- * @param PageInterface $var the parent page object
+ * @param ?PageInterface $var the parent page object
*
* @return PageInterface|null the parent page object if it exists.
*/
diff --git a/system/src/Grav/Common/Page/Flex/Traits/PageTranslateTrait.php b/system/src/Grav/Common/Page/Flex/Traits/PageTranslateTrait.php
index e6e18577d..76ad1e044 100644
--- a/system/src/Grav/Common/Page/Flex/Traits/PageTranslateTrait.php
+++ b/system/src/Grav/Common/Page/Flex/Traits/PageTranslateTrait.php
@@ -19,6 +19,7 @@ use RocketTheme\Toolbox\ResourceLocator\UniformResourceLocator;
/**
* Implements PageTranslateInterface
+ * @phan-file-suppress PhanUndeclaredMethod
*/
trait PageTranslateTrait
{
diff --git a/system/src/Grav/Common/Page/Interfaces/PageContentInterface.php b/system/src/Grav/Common/Page/Interfaces/PageContentInterface.php
index c7de508e4..7d8bc4056 100644
--- a/system/src/Grav/Common/Page/Interfaces/PageContentInterface.php
+++ b/system/src/Grav/Common/Page/Interfaces/PageContentInterface.php
@@ -75,10 +75,11 @@ interface PageContentInterface
*
* @param string $name Variable name.
* @param mixed|null $default
+ * @param mixed|null $separator
*
* @return mixed
*/
- public function value($name, $default = null);
+ public function value($name, $default = null, $separator = null);
/**
* Gets and sets the associated media as found in the page folder.
@@ -247,5 +248,5 @@ interface PageContentInterface
*
* @return bool
*/
- public function exists();
+ public function exists():bool;
}
diff --git a/system/src/Grav/Common/Page/Interfaces/PageRoutableInterface.php b/system/src/Grav/Common/Page/Interfaces/PageRoutableInterface.php
index ab7a898fb..8ca908d60 100644
--- a/system/src/Grav/Common/Page/Interfaces/PageRoutableInterface.php
+++ b/system/src/Grav/Common/Page/Interfaces/PageRoutableInterface.php
@@ -119,7 +119,7 @@ interface PageRoutableInterface
* Gets and sets the path to the folder where the .md for this Page object resides.
* This is equivalent to the filePath but without the filename.
*
- * @param string $var the path
+ * @param ?string $var the path
*
* @return string|null the path
*/
@@ -137,7 +137,7 @@ interface PageRoutableInterface
/**
* Gets and Sets the parent object for this page
*
- * @param PageInterface $var the parent page object
+ * @param ?PageInterface $var the parent page object
*
* @return PageInterface|null the parent page object if it exists.
*/
diff --git a/system/src/Grav/Common/Page/Markdown/Excerpts.php b/system/src/Grav/Common/Page/Markdown/Excerpts.php
index 8b35dc380..28d86e9c8 100644
--- a/system/src/Grav/Common/Page/Markdown/Excerpts.php
+++ b/system/src/Grav/Common/Page/Markdown/Excerpts.php
@@ -25,9 +25,10 @@ class Excerpts
/** @var array */
protected $config;
+ /** @suppress PhanPossiblyNullTypeMismatchProperty - hopefully Grav::instance()['page'] can't be null here */
public function __construct(PageInterface $page = null, array $config = null)
{
- $this->page = $page ?? Grav::instance()['page'] ?? null;
+ $this->page = $page ?? Grav::instance()['page'];
// Add defaults to the configuration.
if (null === $config || !isset($config['markdown'], $config['images'])) {
@@ -108,7 +109,7 @@ class Excerpts
}
}
- $url_parts['query'] = http_build_query($actions, null, '&', PHP_QUERY_RFC3986);
+ $url_parts['query'] = http_build_query($actions, '', '&', PHP_QUERY_RFC3986);
}
// If no query elements left, unset query.
diff --git a/system/src/Grav/Common/Page/Media.php b/system/src/Grav/Common/Page/Media.php
index 3dae3c906..2611ac842 100644
--- a/system/src/Grav/Common/Page/Media.php
+++ b/system/src/Grav/Common/Page/Media.php
@@ -25,7 +25,7 @@ class Media extends AbstractMedia
/**
* @param string $path
- * @param array $media_order
+ * @param ?array $media_order
* @param bool $load
*/
public function __construct($path, array $media_order = null, $load = true)
@@ -118,7 +118,7 @@ class Media extends AbstractMedia
foreach ($types['alternative'] as $ratio => &$alt) {
$alt['file'] = MediumFactory::fromFile($alt['file']);
- if (!$alt['file']) {
+ if (empty($alt['file'])) {
unset($types['alternative'][$ratio]);
} else {
$alt['file']->set('size', $alt['size']);
@@ -142,7 +142,7 @@ class Media extends AbstractMedia
} else {
$medium = MediumFactory::fromFile($types['base']['file']);
$medium && $medium->set('size', $types['base']['size']);
- $file_path = $medium->path();
+ $file_path = $medium ? $medium->path() : null;
}
if (empty($medium)) {
diff --git a/system/src/Grav/Common/Page/Medium/GlobalMedia.php b/system/src/Grav/Common/Page/Medium/GlobalMedia.php
index 9fb30e982..40cd9a949 100644
--- a/system/src/Grav/Common/Page/Medium/GlobalMedia.php
+++ b/system/src/Grav/Common/Page/Medium/GlobalMedia.php
@@ -17,11 +17,11 @@ class GlobalMedia extends AbstractMedia
/**
* Return media path.
*
- * @return null
+ * @return string
*/
public function getPath()
{
- return null;
+ return '';
}
/**
diff --git a/system/src/Grav/Common/Page/Medium/ImageFile.php b/system/src/Grav/Common/Page/Medium/ImageFile.php
index 854e4b0ce..ffe0694a9 100644
--- a/system/src/Grav/Common/Page/Medium/ImageFile.php
+++ b/system/src/Grav/Common/Page/Medium/ImageFile.php
@@ -110,7 +110,7 @@ class ImageFile extends Image
* @param string $type
* @param int $quality
* @param array $extras
- * @return null
+ * @return string
*/
public function getHash($type = 'guess', $quality = 80, $extras = [])
{
diff --git a/system/src/Grav/Common/Page/Medium/ImageMedium.php b/system/src/Grav/Common/Page/Medium/ImageMedium.php
index 78a517611..ce3933507 100644
--- a/system/src/Grav/Common/Page/Medium/ImageMedium.php
+++ b/system/src/Grav/Common/Page/Medium/ImageMedium.php
@@ -76,7 +76,7 @@ class ImageMedium extends Medium
* Construct.
*
* @param array $items
- * @param Blueprint $blueprint
+ * @param ?Blueprint $blueprint
*/
public function __construct($items = [], Blueprint $blueprint = null)
{
@@ -625,16 +625,19 @@ class ImageMedium extends Medium
/**
* Filter image by using user defined filter parameters.
*
- * @param string $filter Filter to be used.
+ * @param mixed ...$args Filter to be used - varags to be compatible with parent
+ * @return $this
*/
- public function filter($filter = 'image.filters.default')
+ public function filter(...$args)
{
+ $filter = $args[0] ?? 'image.filters.default';
$filters = (array) $this->get($filter, []);
foreach ($filters as $params) {
$params = (array) $params;
$method = array_shift($params);
$this->__call($method, $params);
}
+ return $this;
}
/**
diff --git a/system/src/Grav/Common/Page/Medium/Link.php b/system/src/Grav/Common/Page/Medium/Link.php
index 697863519..9b28ce5e0 100644
--- a/system/src/Grav/Common/Page/Medium/Link.php
+++ b/system/src/Grav/Common/Page/Medium/Link.php
@@ -34,10 +34,10 @@ class Link implements RenderableInterface
/**
* Get an element (is array) that can be rendered by the Parsedown engine
*
- * @param string $title
- * @param string $alt
- * @param string $class
- * @param string $id
+ * @param ?string $title
+ * @param ?string $alt
+ * @param ?string $class
+ * @param ?string $id
* @param bool $reset
* @return array
*/
diff --git a/system/src/Grav/Common/Page/Medium/Medium.php b/system/src/Grav/Common/Page/Medium/Medium.php
index 75c300008..2ebdcb778 100644
--- a/system/src/Grav/Common/Page/Medium/Medium.php
+++ b/system/src/Grav/Common/Page/Medium/Medium.php
@@ -32,7 +32,7 @@ class Medium extends Data implements RenderableInterface, MediaObjectInterface
protected $mode = 'source';
/**
- * @var Medium
+ * @var ?Medium
*/
protected $_thumbnail = null;
@@ -74,7 +74,7 @@ class Medium extends Data implements RenderableInterface, MediaObjectInterface
* Construct.
*
* @param array $items
- * @param Blueprint $blueprint
+ * @param ?Blueprint $blueprint
*/
public function __construct($items = [], Blueprint $blueprint = null)
{
@@ -281,7 +281,7 @@ class Medium extends Data implements RenderableInterface, MediaObjectInterface
/**
* Get/set querystring for the file's url
*
- * @param string $querystring
+ * @param ?string $querystring
* @param bool $withQuestionmark
* @return string
*/
@@ -345,10 +345,10 @@ class Medium extends Data implements RenderableInterface, MediaObjectInterface
/**
* Get an element (is array) that can be rendered by the Parsedown engine
*
- * @param string $title
- * @param string $alt
- * @param string $class
- * @param string $id
+ * @param ?string $title
+ * @param ?string $alt
+ * @param ?string $class
+ * @param ?string $id
* @param bool $reset
* @return array
*/
@@ -479,7 +479,7 @@ class Medium extends Data implements RenderableInterface, MediaObjectInterface
*
* @param string $mode
*
- * @return $this
+ * @return ?$this
*/
public function display($mode = 'source')
{
diff --git a/system/src/Grav/Common/Page/Medium/MediumFactory.php b/system/src/Grav/Common/Page/Medium/MediumFactory.php
index dc372d81d..b8e8bc0d5 100644
--- a/system/src/Grav/Common/Page/Medium/MediumFactory.php
+++ b/system/src/Grav/Common/Page/Medium/MediumFactory.php
@@ -20,7 +20,7 @@ class MediumFactory
*
* @param string $file
* @param array $params
- * @return Medium
+ * @return ?Medium
*/
public static function fromFile($file, array $params = [])
{
@@ -73,7 +73,7 @@ class MediumFactory
*
* @param FormFlashFile $uploadedFile
* @param array $params
- * @return Medium
+ * @return ?Medium
*/
public static function fromUploadedFile(FormFlashFile $uploadedFile, array $params = [])
{
@@ -82,7 +82,7 @@ class MediumFactory
$ext = $parts['extension'];
$basename = $parts['filename'];
$file = $uploadedFile->getTmpFile();
- $path = dirname($file);
+ $path = empty($file) ? '' : dirname($file);
$config = Grav::instance()['config'];
@@ -104,7 +104,7 @@ class MediumFactory
'basename' => $basename,
'extension' => $ext,
'path' => $path,
- 'modified' => filemtime($file),
+ 'modified' => empty($file) ? 0 : filemtime($file),
'thumbnails' => []
];
@@ -149,7 +149,7 @@ class MediumFactory
/**
* Create a new ImageMedium by scaling another ImageMedium object.
*
- * @param ImageMedium $medium
+ * @param Medium $medium
* @param int $from
* @param int $to
* @return Medium|array
diff --git a/system/src/Grav/Common/Page/Medium/ParsedownHtmlTrait.php b/system/src/Grav/Common/Page/Medium/ParsedownHtmlTrait.php
index c6d75bc77..13dfdbe34 100644
--- a/system/src/Grav/Common/Page/Medium/ParsedownHtmlTrait.php
+++ b/system/src/Grav/Common/Page/Medium/ParsedownHtmlTrait.php
@@ -22,12 +22,13 @@ trait ParsedownHtmlTrait
/**
* Return HTML markup from the medium.
*
- * @param string $title
- * @param string $alt
- * @param string $class
- * @param string $id
+ * @param ?string $title
+ * @param ?string $alt
+ * @param ?string $class
+ * @param ?string $id
* @param bool $reset
* @return string
+ * @suppress PhanUndeclaredMethod
*/
public function html($title = null, $alt = null, $class = null, $id = null, $reset = true)
{
diff --git a/system/src/Grav/Common/Page/Medium/RenderableInterface.php b/system/src/Grav/Common/Page/Medium/RenderableInterface.php
index 50a6e6790..56315261a 100644
--- a/system/src/Grav/Common/Page/Medium/RenderableInterface.php
+++ b/system/src/Grav/Common/Page/Medium/RenderableInterface.php
@@ -14,23 +14,24 @@ interface RenderableInterface
/**
* Return HTML markup from the medium.
*
- * @param string $title
- * @param string $alt
- * @param string $class
+ * @param ?string $title
+ * @param ?string $alt
+ * @param ?string $class
+ * @param ?string $id
* @param bool $reset
* @return string
*/
- public function html($title = null, $alt = null, $class = null, $reset = true);
+ public function html($title = null, $alt = null, $class = null, $id = null, $reset = true);
/**
* Return Parsedown Element from the medium.
*
- * @param string $title
- * @param string $alt
- * @param string $class
- * @param string $id
+ * @param ?string $title
+ * @param ?string $alt
+ * @param ?string $class
+ * @param ?string $id
* @param bool $reset
- * @return string
+ * @return array
*/
public function parsedownElement($title = null, $alt = null, $class = null, $id = null, $reset = true);
}
diff --git a/system/src/Grav/Common/Page/Medium/StaticResizeTrait.php b/system/src/Grav/Common/Page/Medium/StaticResizeTrait.php
index 8d6d43fb4..de5a86507 100644
--- a/system/src/Grav/Common/Page/Medium/StaticResizeTrait.php
+++ b/system/src/Grav/Common/Page/Medium/StaticResizeTrait.php
@@ -17,6 +17,7 @@ trait StaticResizeTrait
* @param int $width
* @param int $height
* @return $this
+ * @suppress PhanUndeclaredProperty
*/
public function resize($width = null, $height = null)
{
diff --git a/system/src/Grav/Common/Page/Medium/ThumbnailImageMedium.php b/system/src/Grav/Common/Page/Medium/ThumbnailImageMedium.php
index 380baee64..8becfc70a 100644
--- a/system/src/Grav/Common/Page/Medium/ThumbnailImageMedium.php
+++ b/system/src/Grav/Common/Page/Medium/ThumbnailImageMedium.php
@@ -35,10 +35,10 @@ class ThumbnailImageMedium extends ImageMedium
/**
* Get an element (is array) that can be rendered by the Parsedown engine
*
- * @param string $title
- * @param string $alt
- * @param string $class
- * @param string $id
+ * @param ?string $title
+ * @param ?string $alt
+ * @param ?string $class
+ * @param ?string $id
* @param bool $reset
* @return array
*/
@@ -50,10 +50,10 @@ class ThumbnailImageMedium extends ImageMedium
/**
* Return HTML markup from the medium.
*
- * @param string $title
- * @param string $alt
- * @param string $class
- * @param string $id
+ * @param ?string $title
+ * @param ?string $alt
+ * @param ?string $class
+ * @param ?string $id
* @param bool $reset
* @return string
*/
@@ -119,7 +119,7 @@ class ThumbnailImageMedium extends ImageMedium
* @param string $method
* @param array $arguments
* @param bool $testLinked
- * @return Medium
+ * @return Medium|Link|array
*/
protected function bubble($method, array $arguments = [], $testLinked = true)
{
diff --git a/system/src/Grav/Common/Page/Page.php b/system/src/Grav/Common/Page/Page.php
index a04f18b8e..b9389dd14 100644
--- a/system/src/Grav/Common/Page/Page.php
+++ b/system/src/Grav/Common/Page/Page.php
@@ -2259,7 +2259,7 @@ class Page implements PageInterface
/**
* Gets and Sets the parent object for this page
*
- * @param PageInterface $var the parent page object
+ * @param ?PageInterface $var the parent page object
*
* @return PageInterface|null the parent page object if it exists.
*/
diff --git a/system/src/Grav/Common/Page/Pages.php b/system/src/Grav/Common/Page/Pages.php
index 23f7a2c1e..20968b80d 100644
--- a/system/src/Grav/Common/Page/Pages.php
+++ b/system/src/Grav/Common/Page/Pages.php
@@ -921,6 +921,7 @@ class Pages
* @param string $type
*
* @return Blueprint
+ * @suppress PhanTypeMismatchArgument
*/
public function blueprints($type)
{
@@ -945,7 +946,7 @@ class Pages
/**
* Get all pages
*
- * @param PageInterface $current
+ * @param ?PageInterface $current
*
* @return Collection
*/
@@ -1014,7 +1015,7 @@ class Pages
/**
* Get list of route/title of all pages.
*
- * @param PageInterface $current
+ * @param ?PageInterface $current
* @param int $level
* @param bool $rawRoutes
*
@@ -1856,7 +1857,7 @@ class Pages
if (!$child_header instanceof Header) {
$child_header = new Header((array)$child_header);
}
- $header_value = $child_header->get($header_query);
+ $header_value = $child_header->get((string)$header_query);
if (is_array($header_value)) {
$list[$key] = implode(',', $header_value);
} elseif ($header_value) {
diff --git a/system/src/Grav/Common/Plugin.php b/system/src/Grav/Common/Plugin.php
index cc29dff3d..724d92edb 100644
--- a/system/src/Grav/Common/Plugin.php
+++ b/system/src/Grav/Common/Plugin.php
@@ -66,7 +66,7 @@ class Plugin implements EventSubscriberInterface, \ArrayAccess
*
* @param string $name
* @param Grav $grav
- * @param Config $config
+ * @param ?Config $config
*/
public function __construct($name, Grav $grav, Config $config = null)
{
diff --git a/system/src/Grav/Common/Scheduler/IntervalTrait.php b/system/src/Grav/Common/Scheduler/IntervalTrait.php
index 821833780..ed9517564 100644
--- a/system/src/Grav/Common/Scheduler/IntervalTrait.php
+++ b/system/src/Grav/Common/Scheduler/IntervalTrait.php
@@ -11,6 +11,7 @@ namespace Grav\Common\Scheduler;
use Cron\CronExpression;
+/** @phan-file-suppress PhanUndeclaredProperty,PhanTypeMismatchArgument */
trait IntervalTrait
{
/**
diff --git a/system/src/Grav/Common/Scheduler/Job.php b/system/src/Grav/Common/Scheduler/Job.php
index 26b9c5e99..5cff3cca5 100644
--- a/system/src/Grav/Common/Scheduler/Job.php
+++ b/system/src/Grav/Common/Scheduler/Job.php
@@ -145,7 +145,7 @@ class Job
* the job is due. Defaults to job creation time.
* It also default the execution time if not previously defined.
*
- * @param \DateTime $date
+ * @param ?\DateTime $date
* @return bool
*/
public function isDue(\DateTime $date = null)
@@ -217,7 +217,7 @@ class Job
* The job id is used as a filename for the lock file.
*
* @param string $tempDir The directory path for the lock files
- * @param callable $whenOverlapping A callback to ignore job overlapping
+ * @param ?callable $whenOverlapping A callback to ignore job overlapping
* @return self
*/
public function onlyOne($tempDir = null, callable $whenOverlapping = null)
diff --git a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserRender.php b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserRender.php
index 8620ee5ed..2316267bd 100644
--- a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserRender.php
+++ b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserRender.php
@@ -40,6 +40,7 @@ class TwigTokenParserRender extends AbstractTokenParser
/**
* @param Token $token
* @return array
+ * @suppress PhanAccessMethodInternal - parseExpression() is marked as Twig-internal
*/
protected function parseArguments(Token $token)
{
diff --git a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserScript.php b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserScript.php
index 83a489640..a544fb80c 100644
--- a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserScript.php
+++ b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserScript.php
@@ -52,6 +52,7 @@ class TwigTokenParserScript extends AbstractTokenParser
/**
* @param Token $token
* @return array
+ * @suppress PhanAccessMethodInternal - parseExpression() is marked as Twig-internal
*/
protected function parseArguments(Token $token)
{
diff --git a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserStyle.php b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserStyle.php
index e01277dea..518ff9c5e 100644
--- a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserStyle.php
+++ b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserStyle.php
@@ -51,6 +51,7 @@ class TwigTokenParserStyle extends AbstractTokenParser
/**
* @param Token $token
* @return array
+ * @suppress PhanAccessMethodInternal - parseExpression() is marked as Twig-internal
*/
protected function parseArguments(Token $token)
{
diff --git a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserSwitch.php b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserSwitch.php
index 7bd3ba99f..91e3aa850 100644
--- a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserSwitch.php
+++ b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserSwitch.php
@@ -32,6 +32,7 @@ class TwigTokenParserSwitch extends AbstractTokenParser
{
/**
* {@inheritdoc}
+ * @suppress PhanAccessMethodInternal - parseExpression() is marked as Twig-internal
*/
public function parse(Token $token)
{
diff --git a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserThrow.php b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserThrow.php
index d9fd9ebf3..a406cfbb1 100644
--- a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserThrow.php
+++ b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserThrow.php
@@ -29,6 +29,7 @@ class TwigTokenParserThrow extends AbstractTokenParser
* @param Token $token A Twig Token instance
*
* @return Node A Twig Node instance
+ * @suppress PhanAccessMethodInternal - parseExpression() is marked as Twig-internal
*/
public function parse(Token $token)
{
@@ -39,7 +40,7 @@ class TwigTokenParserThrow extends AbstractTokenParser
$message = $this->parser->getExpressionParser()->parseExpression();
$stream->expect(Token::BLOCK_END_TYPE);
- return new TwigNodeThrow($code, $message, $lineno, $this->getTag());
+ return new TwigNodeThrow((int)$code, $message, $lineno, $this->getTag());
}
/**
diff --git a/system/src/Grav/Common/Twig/TwigExtension.php b/system/src/Grav/Common/Twig/TwigExtension.php
index ad7d2da9d..aebad22a3 100644
--- a/system/src/Grav/Common/Twig/TwigExtension.php
+++ b/system/src/Grav/Common/Twig/TwigExtension.php
@@ -44,7 +44,7 @@ class TwigExtension extends AbstractExtension implements GlobalsInterface
/** @var Grav */
protected $grav;
- /** @var Debugger */
+ /** @var ?Debugger */
protected $debugger;
/** @var Config */
@@ -453,7 +453,8 @@ class TwigExtension extends AbstractExtension implements GlobalsInterface
* @param string $haystack
* @param string $needle
*
- * @return bool
+ * @return string|bool
+ * @todo returning $haystack here doesn't make much sense
*/
public function containsFilter($haystack, $needle)
{
@@ -620,9 +621,8 @@ class TwigExtension extends AbstractExtension implements GlobalsInterface
}
/**
- * @param string $string
- *
* @param array $context
+ * @param string $string
* @param bool $block Block or Line processing
* @return mixed|string
*/
@@ -667,22 +667,22 @@ class TwigExtension extends AbstractExtension implements GlobalsInterface
/**
* @param string $value
- * @param null $chars
+ * @param string $chars
*
* @return string
*/
- public function rtrimFilter($value, $chars = null)
+ public function rtrimFilter($value, $chars = '')
{
return rtrim($value, $chars);
}
/**
* @param string $value
- * @param null $chars
+ * @param string $chars
*
* @return string
*/
- public function ltrimFilter($value, $chars = null)
+ public function ltrimFilter($value, $chars = '')
{
return ltrim($value, $chars);
}
@@ -698,7 +698,6 @@ class TwigExtension extends AbstractExtension implements GlobalsInterface
return (string) $input;
}
-
/**
* Casts input to int.
*
@@ -967,7 +966,7 @@ class TwigExtension extends AbstractExtension implements GlobalsInterface
*
* @param array $array1
* @param array $array2
- * @return array
+ * @return array|Collection
*/
public function arrayIntersectFunc($array1, $array2)
{
@@ -1406,6 +1405,8 @@ class TwigExtension extends AbstractExtension implements GlobalsInterface
* @param string|null $typeTest
* @param string|null $className
* @return bool
+ *
+ * @suppress PhanPluginUnreachableCode
*/
public function ofTypeFunc($var, $typeTest = null, $className = null)
{
diff --git a/system/src/Grav/Common/Uri.php b/system/src/Grav/Common/Uri.php
index dc2c43266..1ff32a918 100644
--- a/system/src/Grav/Common/Uri.php
+++ b/system/src/Grav/Common/Uri.php
@@ -213,7 +213,7 @@ class Uri
/**
* Return URI path.
*
- * @param string $id
+ * @param int $id
*
* @return string|string[]
*/
diff --git a/system/src/Grav/Common/User/FlexUser/User.php b/system/src/Grav/Common/User/FlexUser/User.php
index 887703c83..8a2332f6c 100644
--- a/system/src/Grav/Common/User/FlexUser/User.php
+++ b/system/src/Grav/Common/User/FlexUser/User.php
@@ -406,7 +406,7 @@ class User extends FlexObject implements UserInterface, MediaManipulationInterfa
/**
* Set or get the data storage.
*
- * @param FileInterface $storage Optionally enter a new storage.
+ * @param ?FileInterface $storage Optionally enter a new storage.
* @return FileInterface
*/
public function file(FileInterface $storage = null)
diff --git a/system/src/Grav/Common/User/Traits/UserTrait.php b/system/src/Grav/Common/User/Traits/UserTrait.php
index 3de8fe280..2625ae3c3 100644
--- a/system/src/Grav/Common/User/Traits/UserTrait.php
+++ b/system/src/Grav/Common/User/Traits/UserTrait.php
@@ -16,6 +16,7 @@ use Grav\Common\Page\Medium\StaticImageMedium;
use Grav\Common\User\Authentication;
use Grav\Common\Utils;
+/** @phan-file-suppress PhanUndeclaredMethod */
trait UserTrait
{
/**
diff --git a/system/src/Grav/Console/ConsoleTrait.php b/system/src/Grav/Console/ConsoleTrait.php
index 190109517..dc1cc6f21 100644
--- a/system/src/Grav/Console/ConsoleTrait.php
+++ b/system/src/Grav/Console/ConsoleTrait.php
@@ -43,7 +43,6 @@ trait ConsoleTrait
{
// Initialize cache with CLI compatibility
Grav::instance()['config']->set('system.cache.cli_compatibility', true);
- Grav::instance()['cache'];
$this->argv = $_SERVER['argv'][0];
$this->input = $input;
diff --git a/system/src/Grav/Console/Gpm/SelfupgradeCommand.php b/system/src/Grav/Console/Gpm/SelfupgradeCommand.php
index 1764cf011..8522bdb52 100644
--- a/system/src/Grav/Console/Gpm/SelfupgradeCommand.php
+++ b/system/src/Grav/Console/Gpm/SelfupgradeCommand.php
@@ -175,7 +175,7 @@ class SelfupgradeCommand extends ConsoleCommand
}
// clear cache after successful upgrade
- $this->clearCache('all');
+ $this->clearCache(['all']);
}
/**
diff --git a/system/src/Grav/Framework/Cache/CacheTrait.php b/system/src/Grav/Framework/Cache/CacheTrait.php
index 66943b96d..78d7c6458 100644
--- a/system/src/Grav/Framework/Cache/CacheTrait.php
+++ b/system/src/Grav/Framework/Cache/CacheTrait.php
@@ -303,7 +303,7 @@ trait CacheTrait
}
if (\strlen($key) > 64) {
throw new InvalidArgumentException(
- sprintf('Cache key length must be less than 65 characters, key had %s characters', \strlen($key))
+ sprintf('Cache key length must be less than 65 characters, key had %d characters', \strlen($key))
);
}
if (strpbrk($key, '{}()/\@:') !== false) {
diff --git a/system/src/Grav/Framework/Controller/Traits/ControllerResponseTrait.php b/system/src/Grav/Framework/Controller/Traits/ControllerResponseTrait.php
index e38e1e6f3..5d88ec39c 100644
--- a/system/src/Grav/Framework/Controller/Traits/ControllerResponseTrait.php
+++ b/system/src/Grav/Framework/Controller/Traits/ControllerResponseTrait.php
@@ -33,8 +33,8 @@ trait ControllerResponseTrait
/**
* @param string $content
- * @param int $code
- * @param array $headers
+ * @param ?int $code
+ * @param ?array $headers
* @return Response
*/
protected function createHtmlResponse(string $content, int $code = null, array $headers = null): ResponseInterface
@@ -50,8 +50,8 @@ trait ControllerResponseTrait
/**
* @param array $content
- * @param int $code
- * @param array $headers
+ * @param ?int $code
+ * @param ?array $headers
* @return Response
*/
protected function createJsonResponse(array $content, int $code = null, array $headers = null): ResponseInterface
@@ -70,7 +70,7 @@ trait ControllerResponseTrait
/**
* @param string $url
- * @param int $code
+ * @param ?int $code
* @return Response
*/
protected function createRedirectResponse(string $url, int $code = null): ResponseInterface
@@ -90,7 +90,7 @@ trait ControllerResponseTrait
/**
* @param \Throwable $e
- * @return \Throwable
+ * @return ResponseInterface
*/
protected function createErrorResponse(\Throwable $e): ResponseInterface
{
diff --git a/system/src/Grav/Framework/Filesystem/Interfaces/FilesystemInterface.php b/system/src/Grav/Framework/Filesystem/Interfaces/FilesystemInterface.php
index 7082ebfc8..4a72b986e 100644
--- a/system/src/Grav/Framework/Filesystem/Interfaces/FilesystemInterface.php
+++ b/system/src/Grav/Framework/Filesystem/Interfaces/FilesystemInterface.php
@@ -66,7 +66,7 @@ interface FilesystemInterface
* @see http://php.net/manual/en/function.pathinfo.php
*
* @param string $path A filename or path, does not need to exist as a file.
- * @param int $options A PATHINFO_* constant.
+ * @param ?int $options A PATHINFO_* constant.
*
* @return array|string
* @api
diff --git a/system/src/Grav/Framework/Flex/Flex.php b/system/src/Grav/Framework/Flex/Flex.php
index 5683fdd93..fca16ad6c 100644
--- a/system/src/Grav/Framework/Flex/Flex.php
+++ b/system/src/Grav/Framework/Flex/Flex.php
@@ -87,7 +87,7 @@ class Flex implements \Countable
}
/**
- * @param array|string[] $types
+ * @param array|string[]|null $types
* @param bool $keepMissing
* @return array
*/
diff --git a/system/src/Grav/Framework/Flex/FlexDirectory.php b/system/src/Grav/Framework/Flex/FlexDirectory.php
index 06eebe462..9bfa6fe51 100644
--- a/system/src/Grav/Framework/Flex/FlexDirectory.php
+++ b/system/src/Grav/Framework/Flex/FlexDirectory.php
@@ -434,7 +434,7 @@ class FlexDirectory implements FlexAuthorizeInterface
/**
* @param array $entries
- * @param string $keyField
+ * @param ?string $keyField
* @return FlexCollectionInterface
*/
public function createCollection(array $entries, string $keyField = null): FlexCollectionInterface
@@ -447,7 +447,7 @@ class FlexDirectory implements FlexAuthorizeInterface
/**
* @param array $entries
- * @param string $keyField
+ * @param ?string $keyField
* @return FlexIndexInterface
*/
public function createIndex(array $entries, string $keyField = null): FlexIndexInterface
@@ -497,7 +497,7 @@ class FlexDirectory implements FlexAuthorizeInterface
/**
* @param array $entries
- * @param string $keyField
+ * @param ?string $keyField
* @return FlexCollectionInterface
*/
public function loadCollection(array $entries, string $keyField = null): FlexCollectionInterface
diff --git a/system/src/Grav/Framework/Flex/FlexIndex.php b/system/src/Grav/Framework/Flex/FlexIndex.php
index c5916248a..8be23e248 100644
--- a/system/src/Grav/Framework/Flex/FlexIndex.php
+++ b/system/src/Grav/Framework/Flex/FlexIndex.php
@@ -487,7 +487,7 @@ class FlexIndex extends ObjectIndex implements FlexCollectionInterface, FlexInde
/**
* @param array $entries
- * @param string $keyField
+ * @param ?string $keyField
* @return static
*/
protected function createFrom(array $entries, string $keyField = null)
diff --git a/system/src/Grav/Framework/Flex/FlexObject.php b/system/src/Grav/Framework/Flex/FlexObject.php
index ba0eaf37b..5cd8e63b4 100644
--- a/system/src/Grav/Framework/Flex/FlexObject.php
+++ b/system/src/Grav/Framework/Flex/FlexObject.php
@@ -420,6 +420,7 @@ class FlexObject implements FlexObjectInterface, FlexAuthorizeInterface
/**
* {@inheritdoc}
* @see FlexObjectInterface::render()
+ * @suppress PhanAccessMethodInternal - the render() call is marked internal in Twig
*/
public function render(string $layout = null, array $context = [])
{
diff --git a/system/src/Grav/Framework/Flex/Interfaces/FlexCollectionInterface.php b/system/src/Grav/Framework/Flex/Interfaces/FlexCollectionInterface.php
index 35ab6461d..b8d952434 100644
--- a/system/src/Grav/Framework/Flex/Interfaces/FlexCollectionInterface.php
+++ b/system/src/Grav/Framework/Flex/Interfaces/FlexCollectionInterface.php
@@ -31,7 +31,7 @@ interface FlexCollectionInterface extends FlexCommonInterface, ObjectCollectionI
*
* @param FlexObjectInterface[] $entries Associated array of Flex Objects to be included in the collection.
* @param FlexDirectory $directory Flex Directory where all the objects belong into.
- * @param string $keyField Key field used to index the collection.
+ * @param ?string $keyField Key field used to index the collection.
*
* @return static Returns a new Flex Collection.
*/
@@ -43,7 +43,7 @@ interface FlexCollectionInterface extends FlexCommonInterface, ObjectCollectionI
* @used-by FlexDirectory::createCollection() Official method to create Flex Collection.
*
* @param FlexObjectInterface[] $entries Associated array of Flex Objects to be included in the collection.
- * @param FlexDirectory $directory Flex Directory where all the objects belong into.
+ * @param ?FlexDirectory $directory Flex Directory where all the objects belong into.
*
* @throws \InvalidArgumentException
*/
diff --git a/system/src/Grav/Framework/Flex/Interfaces/FlexIndexInterface.php b/system/src/Grav/Framework/Flex/Interfaces/FlexIndexInterface.php
index f6e813652..6c3de808f 100644
--- a/system/src/Grav/Framework/Flex/Interfaces/FlexIndexInterface.php
+++ b/system/src/Grav/Framework/Flex/Interfaces/FlexIndexInterface.php
@@ -57,7 +57,7 @@ interface FlexIndexInterface extends FlexCollectionInterface
public function withKeyField(string $keyField = null);
/**
- * @param string $indexKey
+ * @param ?string $indexKey
* @return array
*/
public function getIndexMap(string $indexKey = null);
diff --git a/system/src/Grav/Framework/Flex/Interfaces/FlexObjectInterface.php b/system/src/Grav/Framework/Flex/Interfaces/FlexObjectInterface.php
index e44d2c5d8..d7c87841b 100644
--- a/system/src/Grav/Framework/Flex/Interfaces/FlexObjectInterface.php
+++ b/system/src/Grav/Framework/Flex/Interfaces/FlexObjectInterface.php
@@ -186,7 +186,7 @@ interface FlexObjectInterface extends FlexCommonInterface, NestedObjectInterface
* @see FlexObjectInterface::getForm()
*
* @param string $name Property name.
- * @param string $separator Optional nested property separator.
+ * @param ?string $separator Optional nested property separator.
*
* @return mixed|null Returns default value of the field, null if there is no default value.
*/
@@ -208,7 +208,7 @@ interface FlexObjectInterface extends FlexCommonInterface, NestedObjectInterface
*
* @param string $name Property name.
* @param mixed $default Default value.
- * @param string $separator Optional nested property separator.
+ * @param ?string $separator Optional nested property separator.
*
* @return mixed Returns value of the field.
*/
diff --git a/system/src/Grav/Framework/Flex/Interfaces/FlexStorageInterface.php b/system/src/Grav/Framework/Flex/Interfaces/FlexStorageInterface.php
index f8eab3199..7250db7be 100644
--- a/system/src/Grav/Framework/Flex/Interfaces/FlexStorageInterface.php
+++ b/system/src/Grav/Framework/Flex/Interfaces/FlexStorageInterface.php
@@ -77,7 +77,7 @@ interface FlexStorageInterface
* If you pass object or array as value, that value will be used to save I/O.
*
* @param array $rows Array of `[key => row, ...]` pairs.
- * @param array $fetched Optional reference to store only fetched items.
+ * @param ?array $fetched Optional reference to store only fetched items.
*
* @return array Returns rows. Note that non-existing rows will have `null` as their value.
*/
diff --git a/system/src/Grav/Framework/Flex/Pages/Traits/PageContentTrait.php b/system/src/Grav/Framework/Flex/Pages/Traits/PageContentTrait.php
index 23cac7c0d..c740fe163 100644
--- a/system/src/Grav/Framework/Flex/Pages/Traits/PageContentTrait.php
+++ b/system/src/Grav/Framework/Flex/Pages/Traits/PageContentTrait.php
@@ -24,6 +24,8 @@ use RocketTheme\Toolbox\Event\Event;
/**
* Implements PageContentInterface.
+ *
+ * @phan-file-suppress PhanUndeclaredMethod,PhanUndeclaredConstant,PhanUndeclaredProperty,PhanTypeMismatchArgument
*/
trait PageContentTrait
{
diff --git a/system/src/Grav/Framework/Flex/Pages/Traits/PageLegacyTrait.php b/system/src/Grav/Framework/Flex/Pages/Traits/PageLegacyTrait.php
index c9fb1d834..68e46729c 100644
--- a/system/src/Grav/Framework/Flex/Pages/Traits/PageLegacyTrait.php
+++ b/system/src/Grav/Framework/Flex/Pages/Traits/PageLegacyTrait.php
@@ -27,6 +27,8 @@ use RocketTheme\Toolbox\ResourceLocator\UniformResourceLocator;
/**
* Implements PageLegacyInterface
+ *
+ * @phan-file-suppress PhanUndeclaredMethod,PhanUndeclaredProperty,PhanParamSignatureMismatch
*/
trait PageLegacyTrait
{
diff --git a/system/src/Grav/Framework/Flex/Pages/Traits/PageRoutableTrait.php b/system/src/Grav/Framework/Flex/Pages/Traits/PageRoutableTrait.php
index 599d7c558..8a4ff4f72 100644
--- a/system/src/Grav/Framework/Flex/Pages/Traits/PageRoutableTrait.php
+++ b/system/src/Grav/Framework/Flex/Pages/Traits/PageRoutableTrait.php
@@ -19,6 +19,8 @@ use RocketTheme\Toolbox\ResourceLocator\UniformResourceLocator;
/**
* Implements PageRoutableInterface
+ *
+ * @phan-file-suppress PhanUndeclaredMethod
*/
trait PageRoutableTrait
{
@@ -263,7 +265,7 @@ trait PageRoutableTrait
* Gets and sets the path to the folder where the .md for this Page object resides.
* This is equivalent to the filePath but without the filename.
*
- * @param string $var the path
+ * @param ?string $var the path
* @return string|null the path
*/
public function path($var = null): ?string
@@ -334,7 +336,7 @@ trait PageRoutableTrait
/**
* Gets and Sets the parent object for this page
*
- * @param PageInterface $var the parent page object
+ * @param ?PageInterface $var the parent page object
* @return PageInterface|null the parent page object if it exists.
*/
public function parent(PageInterface $var = null)
diff --git a/system/src/Grav/Framework/Flex/Pages/Traits/PageTranslateTrait.php b/system/src/Grav/Framework/Flex/Pages/Traits/PageTranslateTrait.php
index 445a15ccf..7b10eac37 100644
--- a/system/src/Grav/Framework/Flex/Pages/Traits/PageTranslateTrait.php
+++ b/system/src/Grav/Framework/Flex/Pages/Traits/PageTranslateTrait.php
@@ -16,6 +16,8 @@ use Grav\Framework\Flex\Interfaces\FlexObjectInterface;
/**
* Implements PageTranslateInterface
+ *
+ * @phan-file-suppress PhanUndeclaredMethod
*/
trait PageTranslateTrait
{
diff --git a/system/src/Grav/Framework/Flex/Traits/FlexAuthorizeTrait.php b/system/src/Grav/Framework/Flex/Traits/FlexAuthorizeTrait.php
index af36fce4c..83da5121e 100644
--- a/system/src/Grav/Framework/Flex/Traits/FlexAuthorizeTrait.php
+++ b/system/src/Grav/Framework/Flex/Traits/FlexAuthorizeTrait.php
@@ -18,6 +18,7 @@ use Grav\Framework\Flex\Interfaces\FlexObjectInterface;
/**
* Implements basic ACL
+ * @phan-file-suppress PhanPossiblyUndeclaredMethod,PhanPluginPrintfVariableFormatString
*/
trait FlexAuthorizeTrait
{
diff --git a/system/src/Grav/Framework/Flex/Traits/FlexMediaTrait.php b/system/src/Grav/Framework/Flex/Traits/FlexMediaTrait.php
index a58082646..173b69d7b 100644
--- a/system/src/Grav/Framework/Flex/Traits/FlexMediaTrait.php
+++ b/system/src/Grav/Framework/Flex/Traits/FlexMediaTrait.php
@@ -27,6 +27,8 @@ use RuntimeException;
/**
* Implements Grav Page content and header manipulation methods.
+ *
+ * @phan-file-suppress PhanUndeclaredMethod,PhanUnanalyzableInheritance
*/
trait FlexMediaTrait
{
@@ -61,6 +63,7 @@ trait FlexMediaTrait
/**
* @return MediaCollectionInterface
+ * @suppress PhanTypeMismatchArgumentNullable - assuming MediumFactory::fromUploadedFile($upload) will not return null here
*/
public function getMedia()
{
@@ -89,6 +92,7 @@ trait FlexMediaTrait
return $this->media;
}
+ /** @suppress PhanPluginPrintfVariableFormatString */
public function checkUploadedMediaFile(UploadedFileInterface $uploadedFile)
{
$grav = Grav::instance();
@@ -171,7 +175,7 @@ trait FlexMediaTrait
try {
// Upload it
- $filepath = sprintf('%s/%s', $path, $filename);
+ $filepath = sprintf('%s/%s', $path, $filename ?? '');
Folder::create(\dirname($filepath));
if ($uploadedFile instanceof FormFlashFile) {
$metadata = $uploadedFile->getMetaData();
diff --git a/system/src/Grav/Framework/Form/FormFlash.php b/system/src/Grav/Framework/Form/FormFlash.php
index 2e99c579b..edda5a684 100644
--- a/system/src/Grav/Framework/Form/FormFlash.php
+++ b/system/src/Grav/Framework/Form/FormFlash.php
@@ -496,10 +496,10 @@ class FormFlash implements FormFlashInterface
}
/**
- * @param string $field
+ * @param ?string $field
* @param string $name
* @param array $data
- * @param array|null $crop
+ * @param ?array $crop
*/
protected function addFileInternal(?string $field, string $name, array $data, array $crop = null): void
{
diff --git a/system/src/Grav/Framework/Form/Interfaces/FormFlashInterface.php b/system/src/Grav/Framework/Form/Interfaces/FormFlashInterface.php
index 8eb85254d..73611bb0b 100644
--- a/system/src/Grav/Framework/Form/Interfaces/FormFlashInterface.php
+++ b/system/src/Grav/Framework/Form/Interfaces/FormFlashInterface.php
@@ -139,7 +139,7 @@ interface FormFlashInterface extends \JsonSerializable
*
* @param string $filename
* @param string $field
- * @param array $crop
+ * @param ?array $crop
* @return bool
*/
public function addFile(string $filename, string $field, array $crop = null): bool;
@@ -148,7 +148,7 @@ interface FormFlashInterface extends \JsonSerializable
* Remove any file from form flash.
*
* @param string $name
- * @param string $field
+ * @param ?string $field
* @return bool
*/
public function removeFile(string $name, string $field = null): bool;
diff --git a/system/src/Grav/Framework/Form/Interfaces/FormInterface.php b/system/src/Grav/Framework/Form/Interfaces/FormInterface.php
index 96d3145e8..61f82c4e2 100644
--- a/system/src/Grav/Framework/Form/Interfaces/FormInterface.php
+++ b/system/src/Grav/Framework/Form/Interfaces/FormInterface.php
@@ -131,14 +131,14 @@ interface FormInterface extends RenderInterface, \Serializable
/**
* @param ServerRequestInterface $request
- * @return $this
+ * @return FormInterface
*/
public function handleRequest(ServerRequestInterface $request): FormInterface;
/**
* @param array $data
- * @param UploadedFileInterface[] $files
- * @return $this
+ * @param ?UploadedFileInterface[] $files
+ * @return FormInterface
*/
public function submit(array $data, array $files = null): FormInterface;
diff --git a/system/src/Grav/Framework/Form/Traits/FormTrait.php b/system/src/Grav/Framework/Form/Traits/FormTrait.php
index 4fa311e97..a0b00df84 100644
--- a/system/src/Grav/Framework/Form/Traits/FormTrait.php
+++ b/system/src/Grav/Framework/Form/Traits/FormTrait.php
@@ -32,6 +32,7 @@ use Twig\TemplateWrapper;
/**
* Trait FormTrait
* @package Grav\Framework\Form
+ * @phan-file-suppress PhanTypeMismatchReturn
*/
trait FormTrait
{
@@ -174,7 +175,7 @@ trait FormTrait
/**
* @param ServerRequestInterface $request
- * @return FormInterface|$this
+ * @return FormInterface
*/
public function handleRequest(ServerRequestInterface $request): FormInterface
{
@@ -206,7 +207,7 @@ trait FormTrait
/**
* @param ServerRequestInterface $request
- * @return FormInterface|$this
+ * @return FormInterface
*/
public function setRequest(ServerRequestInterface $request): FormInterface
{
@@ -264,8 +265,8 @@ trait FormTrait
/**
* @param array $data
- * @param UploadedFileInterface[] $files
- * @return FormInterface|$this
+ * @param ?UploadedFileInterface[] $files
+ * @return FormInterface
*/
public function submit(array $data, array $files = null): FormInterface
{
@@ -408,6 +409,7 @@ trait FormTrait
/**
* {@inheritdoc}
* @see FormInterface::render()
+ * @suppress PhanAccessMethodInternal - Twig render() is marked as internal
*/
public function render(string $layout = null, array $context = [])
{
@@ -638,6 +640,7 @@ trait FormTrait
* Validate uploaded file.
*
* @param UploadedFileInterface $file
+ * @suppress PhanPluginPrintfVariableFormatString
*/
protected function validateUpload(UploadedFileInterface $file): void
{
diff --git a/system/src/Grav/Framework/Media/Interfaces/MediaObjectInterface.php b/system/src/Grav/Framework/Media/Interfaces/MediaObjectInterface.php
index 1fc46b759..4a617aac5 100644
--- a/system/src/Grav/Framework/Media/Interfaces/MediaObjectInterface.php
+++ b/system/src/Grav/Framework/Media/Interfaces/MediaObjectInterface.php
@@ -14,4 +14,6 @@ namespace Grav\Framework\Media\Interfaces;
*/
interface MediaObjectInterface
{
+ /** @var string */
+ public $type;
}
diff --git a/system/src/Grav/Framework/Object/Access/NestedPropertyTrait.php b/system/src/Grav/Framework/Object/Access/NestedPropertyTrait.php
index 3d9f4bbfd..9cb9c49ee 100644
--- a/system/src/Grav/Framework/Object/Access/NestedPropertyTrait.php
+++ b/system/src/Grav/Framework/Object/Access/NestedPropertyTrait.php
@@ -31,9 +31,10 @@ trait NestedPropertyTrait
/**
* @param string $property Object property to be fetched.
- * @param mixed $default Default value if property has not been set.
- * @param string $separator Separator, defaults to '.'
+ * @param ?mixed $default Default value if property has not been set.
+ * @param ?string $separator Separator, defaults to '.'
* @return mixed Property value.
+ * @suppress PhanUndeclaredMethod
*/
public function getNestedProperty($property, $default = null, $separator = null)
{
diff --git a/system/src/Grav/Framework/Object/Base/ObjectCollectionTrait.php b/system/src/Grav/Framework/Object/Base/ObjectCollectionTrait.php
index 60a50bc93..8f3f61604 100644
--- a/system/src/Grav/Framework/Object/Base/ObjectCollectionTrait.php
+++ b/system/src/Grav/Framework/Object/Base/ObjectCollectionTrait.php
@@ -14,6 +14,7 @@ use Grav\Framework\Object\Interfaces\ObjectInterface;
/**
* ObjectCollection Trait
* @package Grav\Framework\Object
+ * @phan-file-suppress PhanUndeclaredMethod
*/
trait ObjectCollectionTrait
{
@@ -321,9 +322,10 @@ trait ObjectCollectionTrait
* Group items in the collection by a field and return them as associated array.
*
* @param string $property
+ * @param ?string $separator
* @return array
*/
- public function group($property)
+ public function group($property, $separator = null)
{
$list = [];
diff --git a/system/src/Grav/Framework/Object/Base/ObjectTrait.php b/system/src/Grav/Framework/Object/Base/ObjectTrait.php
index 07e4f7917..a767a7755 100644
--- a/system/src/Grav/Framework/Object/Base/ObjectTrait.php
+++ b/system/src/Grav/Framework/Object/Base/ObjectTrait.php
@@ -13,6 +13,7 @@ namespace Grav\Framework\Object\Base;
* Object trait.
*
* @package Grav\Framework\Object
+ * @phan-file-suppress PhanUndeclaredMethod
*/
trait ObjectTrait
{
diff --git a/system/src/Grav/Framework/Object/Collection/ObjectExpressionVisitor.php b/system/src/Grav/Framework/Object/Collection/ObjectExpressionVisitor.php
index 1d6a999ae..6b50a62d3 100644
--- a/system/src/Grav/Framework/Object/Collection/ObjectExpressionVisitor.php
+++ b/system/src/Grav/Framework/Object/Collection/ObjectExpressionVisitor.php
@@ -94,7 +94,7 @@ class ObjectExpressionVisitor extends ClosureExpressionVisitor
*
* @param string $name
* @param int $orientation
- * @param \Closure $next
+ * @param ?\Closure $next
*
* @return \Closure
*/
diff --git a/system/src/Grav/Framework/Object/Property/ArrayPropertyTrait.php b/system/src/Grav/Framework/Object/Property/ArrayPropertyTrait.php
index 4932acf6a..b7da895e6 100644
--- a/system/src/Grav/Framework/Object/Property/ArrayPropertyTrait.php
+++ b/system/src/Grav/Framework/Object/Property/ArrayPropertyTrait.php
@@ -50,7 +50,7 @@ trait ArrayPropertyTrait
* @param bool $doCreate Set true to create variable.
* @return mixed Property value.
*/
- protected function &doGetProperty($property, $default = null, $doCreate = false)
+ public function &doGetProperty($property, $default = null, $doCreate = false)
{
if (!array_key_exists($property, $this->_elements)) {
if ($doCreate) {
diff --git a/system/src/Grav/Framework/Object/Property/ObjectPropertyTrait.php b/system/src/Grav/Framework/Object/Property/ObjectPropertyTrait.php
index 5f8fdf0ac..a1279b2b4 100644
--- a/system/src/Grav/Framework/Object/Property/ObjectPropertyTrait.php
+++ b/system/src/Grav/Framework/Object/Property/ObjectPropertyTrait.php
@@ -31,7 +31,7 @@ trait ObjectPropertyTrait
/**
* @param array $elements
- * @param string $key
+ * @param ?string $key
* @throws \InvalidArgumentException
*/
public function __construct(array $elements = [], $key = null)
diff --git a/system/src/Grav/Framework/Pagination/AbstractPagination.php b/system/src/Grav/Framework/Pagination/AbstractPagination.php
index 3497bc2f2..b0e0af418 100644
--- a/system/src/Grav/Framework/Pagination/AbstractPagination.php
+++ b/system/src/Grav/Framework/Pagination/AbstractPagination.php
@@ -220,7 +220,7 @@ class AbstractPagination implements PaginationInterface
}
/**
- * @param int $start
+ * @param ?int $start
* @return $this
*/
protected function setStart(int $start = null)
diff --git a/system/src/Grav/Framework/Psr7/Response.php b/system/src/Grav/Framework/Psr7/Response.php
index 960621dbf..b8a1e5e08 100644
--- a/system/src/Grav/Framework/Psr7/Response.php
+++ b/system/src/Grav/Framework/Psr7/Response.php
@@ -50,7 +50,7 @@ class Response implements ResponseInterface
* response to the client.
*
* @param mixed $data The data
- * @param int $status The HTTP status code.
+ * @param ?int $status The HTTP status code.
* @param int $options Json encoding options
* @param int $depth Json encoding max depth
* @return static
diff --git a/system/src/Grav/Framework/Psr7/Traits/MessageDecoratorTrait.php b/system/src/Grav/Framework/Psr7/Traits/MessageDecoratorTrait.php
index 28ed1f572..81cc954ec 100644
--- a/system/src/Grav/Framework/Psr7/Traits/MessageDecoratorTrait.php
+++ b/system/src/Grav/Framework/Psr7/Traits/MessageDecoratorTrait.php
@@ -16,6 +16,7 @@ use Psr\Http\Message\StreamInterface;
/**
* @author Márk Sági-Kazár
+ * @phan-file-suppress PhanTypeInvalidTraitReturn,PhanParamSignatureMismatch
*/
trait MessageDecoratorTrait
{
diff --git a/system/src/Grav/Framework/Psr7/Traits/RequestDecoratorTrait.php b/system/src/Grav/Framework/Psr7/Traits/RequestDecoratorTrait.php
index ab1ffadcf..416a349a0 100644
--- a/system/src/Grav/Framework/Psr7/Traits/RequestDecoratorTrait.php
+++ b/system/src/Grav/Framework/Psr7/Traits/RequestDecoratorTrait.php
@@ -16,6 +16,7 @@ use Psr\Http\Message\UriInterface;
/**
* @author Márk Sági-Kazár
+ * @phan-file-suppress PhanTypeInvalidTraitReturn,PhanParamSignatureMismatch
*/
trait RequestDecoratorTrait
{
diff --git a/system/src/Grav/Framework/Psr7/Traits/ServerRequestDecoratorTrait.php b/system/src/Grav/Framework/Psr7/Traits/ServerRequestDecoratorTrait.php
index f9297ddb4..ef977b11f 100644
--- a/system/src/Grav/Framework/Psr7/Traits/ServerRequestDecoratorTrait.php
+++ b/system/src/Grav/Framework/Psr7/Traits/ServerRequestDecoratorTrait.php
@@ -7,6 +7,8 @@ declare(strict_types=1);
*
* @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
* @license MIT License; see LICENSE file for details.
+ *
+ * @phan-file-suppress PhanUnanalyzableInheritance
*/
namespace Grav\Framework\Psr7\Traits;
diff --git a/system/src/Grav/Framework/Psr7/Traits/UriDecorationTrait.php b/system/src/Grav/Framework/Psr7/Traits/UriDecorationTrait.php
index 9abb8b1be..afc15b5ac 100644
--- a/system/src/Grav/Framework/Psr7/Traits/UriDecorationTrait.php
+++ b/system/src/Grav/Framework/Psr7/Traits/UriDecorationTrait.php
@@ -7,6 +7,8 @@ declare(strict_types=1);
*
* @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
* @license MIT License; see LICENSE file for details.
+ *
+ * @phan-file-suppress PhanTypeMismatchReturn
*/
namespace Grav\Framework\Psr7\Traits;
diff --git a/system/src/Grav/Framework/RequestHandler/Traits/RequestHandlerTrait.php b/system/src/Grav/Framework/RequestHandler/Traits/RequestHandlerTrait.php
index 79358003d..f20cbe069 100644
--- a/system/src/Grav/Framework/RequestHandler/Traits/RequestHandlerTrait.php
+++ b/system/src/Grav/Framework/RequestHandler/Traits/RequestHandlerTrait.php
@@ -31,6 +31,7 @@ trait RequestHandlerTrait
/**
* {@inheritdoc}
* @throws InvalidArgumentException
+ * @suppress PhanTypeMismatchArgument - $this in a trait can't be statically determined
*/
public function handle(ServerRequestInterface $request): ResponseInterface
{
diff --git a/tests/unit/Grav/Common/Page/PagesTest.php b/tests/unit/Grav/Common/Page/PagesTest.php
index b03a04a37..a463b75ab 100644
--- a/tests/unit/Grav/Common/Page/PagesTest.php
+++ b/tests/unit/Grav/Common/Page/PagesTest.php
@@ -126,6 +126,7 @@ class PagesTest extends \Codeception\TestCase\Test
$this->assertSame(['slug' => 'post-two'], $subPagesSorted[$folder . '/fake/simple-site/user/pages/02.blog/post-two']);
}
+ /** @suppress PhanAccessMethodInternal - sortCollection() is internal */
public function testSortCollection()
{
/** @var UniformResourceLocator $locator */
diff --git a/tests/unit/Grav/Common/Twig/TwigExtensionTest.php b/tests/unit/Grav/Common/Twig/TwigExtensionTest.php
index 9777fd91e..97d7cf93d 100644
--- a/tests/unit/Grav/Common/Twig/TwigExtensionTest.php
+++ b/tests/unit/Grav/Common/Twig/TwigExtensionTest.php
@@ -30,8 +30,8 @@ class TwigExtensionTest extends \Codeception\TestCase\Test
$this->assertSame('camel_cased', $this->twig_ext->inflectorFilter('underscor', 'CamelCased'));
$this->assertSame('something-text', $this->twig_ext->inflectorFilter('hyphen', 'Something Text'));
$this->assertSame('Something text to read', $this->twig_ext->inflectorFilter('human', 'something_text_to_read'));
- $this->assertSame(5, $this->twig_ext->inflectorFilter('month', 175));
- $this->assertSame('10th', $this->twig_ext->inflectorFilter('ordinal', 10));
+ $this->assertSame(5, $this->twig_ext->inflectorFilter('month', '175'));
+ $this->assertSame('10th', $this->twig_ext->inflectorFilter('ordinal', '10'));
}
public function testMd5Filter()
@@ -62,7 +62,7 @@ class TwigExtensionTest extends \Codeception\TestCase\Test
$threeYears = time() - (60*60*24*365*3);
$measures = ['minutes','hours','days','months','years'];
- $this->assertSame('No date provided', $this->twig_ext->nicetimeFunc(null));
+ $this->assertSame('No date provided', $this->twig_ext->nicetimeFunc(''));
for ($i=0; $i