mirror of
https://github.com/php-win-ext/phpredis.git
synced 2026-03-24 00:52:16 +01:00
Documentation: Add several more docblocs
- Add a bunch more docblocks with examples - Link every relevant RedisCluster method to the Redis docs.
This commit is contained in:
committed by
Michael Grunder
parent
cf63e96ec5
commit
f05ba81935
163
redis.stub.php
163
redis.stub.php
@@ -1563,12 +1563,173 @@ class Redis {
|
||||
*/
|
||||
public function sMembers(string $key): Redis|array|false;
|
||||
|
||||
public function sMisMember(string $key, string $member, string ...$other_members): array;
|
||||
/**
|
||||
* Check if one or more values are members of a set.
|
||||
*
|
||||
* @see https://redis.io/commands/smismember
|
||||
* @see https://redis.io/commands/smember
|
||||
* @see Redis::smember()
|
||||
*
|
||||
* @param string $key The set to query.
|
||||
* @param string $member The first value to test if exists in the set.
|
||||
* @param string $other_members Any number of additional values to check.
|
||||
*
|
||||
* @return Redis|array|false An array of integers representing whether each passed value
|
||||
* was a member of the set.
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* $redis = new Redis(['host' => 'localhost']);
|
||||
*
|
||||
* $redis->del('ds9-crew');
|
||||
* $redis->sAdd('ds9-crew', ...["Sisko", "Kira", "Dax", "Worf", "Bashir", "O'Brien"]);
|
||||
*
|
||||
* $names = ['Sisko', 'Picard', 'Data', 'Worf'];
|
||||
* $members = $redis->sMIsMember('ds9-crew', ...$names);
|
||||
*
|
||||
* // array(4) {
|
||||
* // ["Sisko"]=>
|
||||
* // int(1)
|
||||
* // ["Picard"]=>
|
||||
* // int(0)
|
||||
* // ["Data"]=>
|
||||
* // int(0)
|
||||
* // ["Worf"]=>
|
||||
* // int(1)
|
||||
* // }
|
||||
* var_dump(array_combine($names, $members));
|
||||
* ?>
|
||||
* </code>
|
||||
*/
|
||||
public function sMisMember(string $key, string $member, string ...$other_members): Redis|array|false;
|
||||
|
||||
/**
|
||||
* Pop a member from one set and push it onto another. This command will create the
|
||||
* destination set if it does not currently exist.
|
||||
*
|
||||
* @see https://redis.io/commands/smove
|
||||
*
|
||||
* @param string $src The source set.
|
||||
* @param string $dst The destination set.
|
||||
* @param mixed $value The member you wish to move.
|
||||
*
|
||||
* @return Redis|bool True if the member was moved, and false if it wasn't in the set.
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* $redis = new Redis(['host' => 'localhost']);
|
||||
*
|
||||
* $redis->del('numbers', 'evens');
|
||||
* $redis->sAdd('numbers', 'zero', 'one', 'two', 'three', 'four');
|
||||
*
|
||||
* $redis->sMove('numbers', 'evens', 'zero');
|
||||
* $redis->sMove('numbers', 'evens', 'two');
|
||||
* $redis->sMove('numbers', 'evens', 'four');
|
||||
*
|
||||
* // array(2) {
|
||||
* // [0]=>
|
||||
* // string(5) "three"
|
||||
* // [1]=>
|
||||
* // string(3) "one"
|
||||
* // }
|
||||
* var_dump($redis->sMembers('numbers'));
|
||||
*
|
||||
* // array(3) {
|
||||
* // [0]=>
|
||||
* // string(4) "zero"
|
||||
* // [1]=>
|
||||
* // string(3) "two"
|
||||
* // [2]=>
|
||||
* // string(4) "four"
|
||||
* // }
|
||||
* var_dump($redis->sMembers('evens'));
|
||||
*
|
||||
* ?>
|
||||
* </code>
|
||||
*/
|
||||
public function sMove(string $src, string $dst, mixed $value): Redis|bool;
|
||||
|
||||
/**
|
||||
* Remove one or more elements from a set.
|
||||
*
|
||||
* @see https://redis.io/commands/spop
|
||||
*
|
||||
* @param string $key The set in question.
|
||||
* @param int $count An optional number of members to pop. This defaults to
|
||||
* removing one element.
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* $redis = new Redis(['host' => 'localhost']);
|
||||
*
|
||||
* <?php
|
||||
*
|
||||
* $redis = new Redis(['host' => 'localhost']);
|
||||
*
|
||||
* $redis->del('numbers', 'evens');
|
||||
* $redis->sAdd('numbers', 'zero', 'one', 'two', 'three', 'four');
|
||||
*
|
||||
* $redis->sMove('numbers', 'evens', 'zero');
|
||||
* $redis->sMove('numbers', 'evens', 'two');
|
||||
* $redis->sMove('numbers', 'evens', 'four');
|
||||
*
|
||||
* // array(2) {
|
||||
* // [0]=>
|
||||
* // string(5) "three"
|
||||
* // [1]=>
|
||||
* // string(3) "one"
|
||||
* // }
|
||||
* var_dump($redis->sMembers('numbers'));
|
||||
*
|
||||
* // array(3) {
|
||||
* // [0]=>
|
||||
* // string(4) "zero"
|
||||
* // [1]=>
|
||||
* // string(3) "two"
|
||||
* // [2]=>
|
||||
* // string(4) "four"
|
||||
* // }
|
||||
* var_dump($redis->sMembers('evens'));
|
||||
* ?>
|
||||
* </code>
|
||||
*/
|
||||
public function sPop(string $key, int $count = 0): Redis|string|array|false;
|
||||
|
||||
/**
|
||||
* Retrieve one or more random members of a set.
|
||||
*
|
||||
* @param string $key The set to query.
|
||||
* @param int $count An optional count of members to return.
|
||||
*
|
||||
* If this value is positive, Redis will return *up to* the requested
|
||||
* number but with unique elements that will never repeat. This means
|
||||
* you may recieve fewer then `$count` replies.
|
||||
*
|
||||
* If the number is negative, Redis will return the exact number requested
|
||||
* but the result may contain duplicate elements.
|
||||
*
|
||||
* @return Redis|array|string|false One or more random members or false on failure.
|
||||
*
|
||||
* <code>
|
||||
* <?php
|
||||
* $redis = new Redis(['host' => 'localhost']);
|
||||
*
|
||||
* $redis->del('elder-gods');
|
||||
*
|
||||
* $redis->sAdd('elder-gods', ["Cthulhu", "Azathoth", "Daoloth", "D'endrrah"]);
|
||||
*
|
||||
* // A single random member returned.
|
||||
* $rng1 = $redis->sRandMember('elder-gods');
|
||||
*
|
||||
* // Up to SCARD `elder-gods` random members returned
|
||||
* $rng2 = $redis->sRandMember('elder-gods', 9999);
|
||||
*
|
||||
* // 9999 elements from the set returned with duplicates
|
||||
* $rng3 = $redis->sRandMember('elder-gods', -9999);
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
*/
|
||||
public function sRandMember(string $key, int $count = 0): Redis|string|array|false;
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* This is a generated file, edit the .stub.php file instead.
|
||||
* Stub hash: 42952974e3686f29934dfff1ebba07150942a405 */
|
||||
* Stub hash: 4c4d58bf2ce686c82287a69fef109267828a2d9b */
|
||||
|
||||
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___construct, 0, 0, 0)
|
||||
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, options, IS_ARRAY, 0, "null")
|
||||
@@ -720,11 +720,7 @@ ZEND_END_ARG_INFO()
|
||||
|
||||
#define arginfo_class_Redis_sMembers arginfo_class_Redis_hGetAll
|
||||
|
||||
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Redis_sMisMember, 0, 2, IS_ARRAY, 0)
|
||||
ZEND_ARG_TYPE_INFO(0, key, IS_STRING, 0)
|
||||
ZEND_ARG_TYPE_INFO(0, member, IS_STRING, 0)
|
||||
ZEND_ARG_VARIADIC_TYPE_INFO(0, other_members, IS_STRING, 0)
|
||||
ZEND_END_ARG_INFO()
|
||||
#define arginfo_class_Redis_sMisMember arginfo_class_Redis_geohash
|
||||
|
||||
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_Redis_sMove, 0, 3, Redis, MAY_BE_BOOL)
|
||||
ZEND_ARG_TYPE_INFO(0, src, IS_STRING, 0)
|
||||
|
||||
@@ -49,6 +49,9 @@ class RedisCluster {
|
||||
|
||||
public function _redir(): string|null;
|
||||
|
||||
/**
|
||||
* @see Redis::acl
|
||||
*/
|
||||
public function acl(string|array $key_or_address, string $subcmd, string ...$args): mixed;
|
||||
|
||||
/**
|
||||
@@ -56,12 +59,24 @@ class RedisCluster {
|
||||
*/
|
||||
public function append(string $key, mixed $value): RedisCluster|bool|int;
|
||||
|
||||
/**
|
||||
* @see Redis::bgrewriteaof
|
||||
*/
|
||||
public function bgrewriteaof(string|array $key_or_address): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::bgsave
|
||||
*/
|
||||
public function bgsave(string|array $key_or_address): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::bitcount
|
||||
*/
|
||||
public function bitcount(string $key, int $start = 0, int $end = -1, bool $bybit = false): RedisCluster|bool|int;
|
||||
|
||||
/**
|
||||
* @see Redis::bitop
|
||||
*/
|
||||
public function bitop(string $operation, string $deskey, string $srckey, string ...$otherkeys): RedisCluster|bool|int;
|
||||
|
||||
/**
|
||||
@@ -93,12 +108,24 @@ class RedisCluster {
|
||||
*/
|
||||
public function brpoplpush(string $srckey, string $deskey, int $timeout): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::bzpopmax
|
||||
*/
|
||||
public function bzpopmax(string|array $key, string|int $timeout_or_key, mixed ...$extra_args): array;
|
||||
|
||||
/**
|
||||
* @see Redis::bzpopmin
|
||||
*/
|
||||
public function bzpopmin(string|array $key, string|int $timeout_or_key, mixed ...$extra_args): array;
|
||||
|
||||
/**
|
||||
* @see Redis::bzmpop
|
||||
*/
|
||||
public function bzmpop(float $timeout, array $keys, string $from, int $count = 1): RedisCluster|array|null|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zmpop
|
||||
*/
|
||||
public function zmpop(array $keys, string $from, int $count = 1): RedisCluster|array|null|false;
|
||||
|
||||
/**
|
||||
@@ -116,12 +143,24 @@ class RedisCluster {
|
||||
*/
|
||||
public function clearlasterror(): bool;
|
||||
|
||||
/**
|
||||
* @see Redis::client
|
||||
*/
|
||||
public function client(string|array $key_or_address, string $subcommand, ?string $arg = NULL): array|string|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::close
|
||||
*/
|
||||
public function close(): bool;
|
||||
|
||||
/**
|
||||
* @see Redis::cluster
|
||||
*/
|
||||
public function cluster(string|array $key_or_address, string $command, mixed ...$extra_args): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::command
|
||||
*/
|
||||
public function command(mixed ...$extra_args): mixed;
|
||||
|
||||
/**
|
||||
@@ -144,6 +183,9 @@ class RedisCluster {
|
||||
*/
|
||||
public function decrby(string $key, int $value): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::decrbyfloat
|
||||
*/
|
||||
public function decrbyfloat(string $key, float $value): float;
|
||||
|
||||
/**
|
||||
@@ -151,8 +193,14 @@ class RedisCluster {
|
||||
*/
|
||||
public function del(array|string $key, string ...$other_keys): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::discard
|
||||
*/
|
||||
public function discard(): bool;
|
||||
|
||||
/**
|
||||
* @see Redis::dump
|
||||
*/
|
||||
public function dump(string $key): RedisCluster|string|false;
|
||||
|
||||
/**
|
||||
@@ -160,12 +208,24 @@ class RedisCluster {
|
||||
*/
|
||||
public function echo(string|array $key_or_address, string $msg): RedisCluster|string|false;
|
||||
|
||||
/**
|
||||
* @see Redis::eval
|
||||
*/
|
||||
public function eval(string $script, array $args = [], int $num_keys = 0): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::eval_ro
|
||||
*/
|
||||
public function eval_ro(string $script, array $args = [], int $num_keys = 0): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::evalsha
|
||||
*/
|
||||
public function evalsha(string $script_sha, array $args = [], int $num_keys = 0): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::evalsha_ro
|
||||
*/
|
||||
public function evalsha_ro(string $script_sha, array $args = [], int $num_keys = 0): mixed;
|
||||
|
||||
/**
|
||||
@@ -173,6 +233,9 @@ class RedisCluster {
|
||||
*/
|
||||
public function exec(): array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::exists
|
||||
*/
|
||||
public function exists(mixed $key, mixed ...$other_keys): RedisCluster|int|bool;
|
||||
|
||||
/**
|
||||
@@ -180,8 +243,14 @@ class RedisCluster {
|
||||
*/
|
||||
public function touch(mixed $key, mixed ...$other_keys): RedisCluster|int|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::expire
|
||||
*/
|
||||
public function expire(string $key, int $timeout, ?string $mode = NULL): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::expireat
|
||||
*/
|
||||
public function expireat(string $key, int $timestamp, ?string $mode = NULL): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
@@ -194,78 +263,189 @@ class RedisCluster {
|
||||
*/
|
||||
public function pexpiretime(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::flushall
|
||||
*/
|
||||
public function flushall(string|array $key_or_address, bool $async = false): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::flushdb
|
||||
*/
|
||||
public function flushdb(string|array $key_or_address, bool $async = false): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::geoadd
|
||||
*/
|
||||
public function geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples_and_options): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::geodist
|
||||
*/
|
||||
public function geodist(string $key, string $src, string $dest, ?string $unit = null): RedisCluster|float|false;
|
||||
|
||||
/**
|
||||
* @see Redis::geohash
|
||||
*/
|
||||
public function geohash(string $key, string $member, string ...$other_members): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::geopos
|
||||
*/
|
||||
public function geopos(string $key, string $member, string ...$other_members): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::georadius
|
||||
*/
|
||||
public function georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = []): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::georadius_ro
|
||||
*/
|
||||
public function georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = []): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::georadiusbymember
|
||||
*/
|
||||
public function georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = []): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::georadiusbymember_ro
|
||||
*/
|
||||
public function georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = []): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::get
|
||||
*/
|
||||
public function get(string $key): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::getbit
|
||||
*/
|
||||
public function getbit(string $key, int $value): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::getlasterror
|
||||
*/
|
||||
public function getlasterror(): string|null;
|
||||
|
||||
/**
|
||||
* @see Redis::getmode
|
||||
*/
|
||||
public function getmode(): int;
|
||||
|
||||
/**
|
||||
* @see Redis::getoption
|
||||
*/
|
||||
public function getoption(int $option): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::getrange
|
||||
*/
|
||||
public function getrange(string $key, int $start, int $end): RedisCluster|string|false;
|
||||
|
||||
/**
|
||||
* @see Redis::lcs
|
||||
*/
|
||||
public function lcs(string $key1, string $key2, ?array $options = NULL): RedisCluster|string|array|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::getset
|
||||
*/
|
||||
public function getset(string $key, mixed $value): RedisCluster|string|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::gettransferredbytes
|
||||
*/
|
||||
public function gettransferredbytes(): int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hdel
|
||||
*/
|
||||
public function hdel(string $key, string $member, string ...$other_members): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hexists
|
||||
*/
|
||||
public function hexists(string $key, string $member): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::hget
|
||||
*/
|
||||
public function hget(string $key, string $member): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::hgetall
|
||||
*/
|
||||
public function hgetall(string $key): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hincrby
|
||||
*/
|
||||
public function hincrby(string $key, string $member, int $value): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hincrbyfloat
|
||||
*/
|
||||
public function hincrbyfloat(string $key, string $member, float $value): RedisCluster|float|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hkeys
|
||||
*/
|
||||
public function hkeys(string $key): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hlen
|
||||
*/
|
||||
public function hlen(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hmget
|
||||
*/
|
||||
public function hmget(string $key, array $keys): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hmset
|
||||
*/
|
||||
public function hmset(string $key, array $key_values): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::hscan
|
||||
*/
|
||||
public function hscan(string $key, ?int &$iterator, ?string $pattern = null, int $count = 0): array|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::hset
|
||||
*/
|
||||
public function hset(string $key, string $member, mixed $value): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hsetnx
|
||||
*/
|
||||
public function hsetnx(string $key, string $member, mixed $value): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::hstrlen
|
||||
*/
|
||||
public function hstrlen(string $key, string $field): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::hvals
|
||||
*/
|
||||
public function hvals(string $key): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::incr
|
||||
*/
|
||||
public function incr(string $key, int $by = 1): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::incrby
|
||||
*/
|
||||
public function incrby(string $key, int $value): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::incrbyfloat
|
||||
*/
|
||||
public function incrbyfloat(string $key, float $value): RedisCluster|float|false;
|
||||
|
||||
/**
|
||||
@@ -286,36 +466,84 @@ class RedisCluster {
|
||||
*/
|
||||
public function info(string|array $key_or_address, string ...$sections): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::keys
|
||||
*/
|
||||
public function keys(string $pattern): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::lastsave
|
||||
*/
|
||||
public function lastsave(string|array $key_or_address): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::lget
|
||||
*/
|
||||
public function lget(string $key, int $index): RedisCluster|string|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::lindex
|
||||
*/
|
||||
public function lindex(string $key, int $index): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::linsert
|
||||
*/
|
||||
public function linsert(string $key, string $pos, mixed $pivot, mixed $value): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::llen
|
||||
*/
|
||||
public function llen(string $key): RedisCluster|int|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::lpop
|
||||
*/
|
||||
public function lpop(string $key, int $count = 0): RedisCluster|bool|string|array;
|
||||
|
||||
/**
|
||||
* @see Redis::lpush
|
||||
*/
|
||||
public function lpush(string $key, mixed $value, mixed ...$other_values): RedisCluster|int|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::lpushx
|
||||
*/
|
||||
public function lpushx(string $key, mixed $value): RedisCluster|int|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::lrange
|
||||
*/
|
||||
public function lrange(string $key, int $start, int $end): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::lrem
|
||||
*/
|
||||
public function lrem(string $key, mixed $value, int $count = 0): RedisCluster|int|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::lset
|
||||
*/
|
||||
public function lset(string $key, int $index, mixed $value): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::ltrim
|
||||
*/
|
||||
public function ltrim(string $key, int $start, int $end): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::mget
|
||||
*/
|
||||
public function mget(array $keys): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::mset
|
||||
*/
|
||||
public function mset(array $key_values): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::msetnx
|
||||
*/
|
||||
public function msetnx(array $key_values): RedisCluster|array|false;
|
||||
|
||||
/* We only support Redis::MULTI in RedisCluster but take the argument
|
||||
@@ -323,12 +551,24 @@ class RedisCluster {
|
||||
we add pipeline support in the future. */
|
||||
public function multi(int $value = Redis::MULTI): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::object
|
||||
*/
|
||||
public function object(string $subcommand, string $key): RedisCluster|int|string|false;
|
||||
|
||||
/**
|
||||
* @see Redis::persist
|
||||
*/
|
||||
public function persist(string $key): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::pexpire
|
||||
*/
|
||||
public function pexpire(string $key, int $timeout, ?string $mode = NULL): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::pexpireat
|
||||
*/
|
||||
public function pexpireat(string $key, int $timestamp, ?string $mode = NULL): RedisCluster|bool;
|
||||
|
||||
|
||||
@@ -362,28 +602,64 @@ class RedisCluster {
|
||||
*/
|
||||
public function ping(string|array $key_or_address, ?string $message = NULL): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::psetex
|
||||
*/
|
||||
public function psetex(string $key, int $timeout, string $value): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::psubscribe
|
||||
*/
|
||||
public function psubscribe(array $patterns, callable $callback): void;
|
||||
|
||||
/**
|
||||
* @see Redis::pttl
|
||||
*/
|
||||
public function pttl(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::publish
|
||||
*/
|
||||
public function publish(string $channel, string $message): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::pubsub
|
||||
*/
|
||||
public function pubsub(string|array $key_or_address, string ...$values): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::punsubscribe
|
||||
*/
|
||||
public function punsubscribe(string $pattern, string ...$other_patterns): bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::randomkey
|
||||
*/
|
||||
public function randomkey(string|array $key_or_address): RedisCluster|bool|string;
|
||||
|
||||
/**
|
||||
* @see Redis::rawcommand
|
||||
*/
|
||||
public function rawcommand(string|array $key_or_address, string $command, mixed ...$args): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::rename
|
||||
*/
|
||||
public function rename(string $key_src, string $key_dst): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::renamenx
|
||||
*/
|
||||
public function renamenx(string $key, string $newkey): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::restore
|
||||
*/
|
||||
public function restore(string $key, int $timeout, string $value, ?array $options = NULL): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::role
|
||||
*/
|
||||
public function role(string|array $key_or_address): mixed;
|
||||
|
||||
/**
|
||||
@@ -396,8 +672,14 @@ class RedisCluster {
|
||||
*/
|
||||
public function rpoplpush(string $src, string $dst): RedisCluster|bool|string;
|
||||
|
||||
/**
|
||||
* @see Redis::rpush
|
||||
*/
|
||||
public function rpush(string $key, mixed ...$elements): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::rpushx
|
||||
*/
|
||||
public function rpushx(string $key, string $value): RedisCluster|bool|int;
|
||||
|
||||
/**
|
||||
@@ -410,12 +692,24 @@ class RedisCluster {
|
||||
*/
|
||||
public function saddarray(string $key, array $values): RedisCluster|bool|int;
|
||||
|
||||
/**
|
||||
* @see Redis::save
|
||||
*/
|
||||
public function save(string|array $key_or_address): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::scan
|
||||
*/
|
||||
public function scan(?int &$iterator, string|array $key_or_address, ?string $pattern = null, int $count = 0): bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::scard
|
||||
*/
|
||||
public function scard(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::script
|
||||
*/
|
||||
public function script(string|array $key_or_address, mixed ...$args): mixed;
|
||||
|
||||
/**
|
||||
@@ -433,14 +727,29 @@ class RedisCluster {
|
||||
*/
|
||||
public function set(string $key, mixed $value, mixed $options = NULL): RedisCluster|string|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::setbit
|
||||
*/
|
||||
public function setbit(string $key, int $offset, bool $onoff): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::setex
|
||||
*/
|
||||
public function setex(string $key, int $expire, mixed $value): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::setnx
|
||||
*/
|
||||
public function setnx(string $key, mixed $value): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::setoption
|
||||
*/
|
||||
public function setoption(int $option, mixed $value): bool;
|
||||
|
||||
/**
|
||||
* @see Redis::setrange
|
||||
*/
|
||||
public function setrange(string $key, int $offset, string $value): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
@@ -448,6 +757,9 @@ class RedisCluster {
|
||||
*/
|
||||
public function sinter(array|string $key, string ...$other_keys): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::sintercard
|
||||
*/
|
||||
public function sintercard(array $keys, int $limit = -1): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
@@ -455,12 +767,24 @@ class RedisCluster {
|
||||
*/
|
||||
public function sinterstore(array|string $key, string ...$other_keys): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::sismember
|
||||
*/
|
||||
public function sismember(string $key, mixed $value): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::slowlog
|
||||
*/
|
||||
public function slowlog(string|array $key_or_address, mixed ...$args): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::smembers()
|
||||
*/
|
||||
public function smembers(string $key): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::smove()
|
||||
*/
|
||||
public function smove(string $src, string $dst, string $member): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
@@ -473,8 +797,14 @@ class RedisCluster {
|
||||
*/
|
||||
public function sort_ro(string $key, ?array $options = NULL): RedisCluster|array|bool|int|string;
|
||||
|
||||
/**
|
||||
* @see Redis::spop
|
||||
*/
|
||||
public function spop(string $key, int $count = 0): RedisCluster|string|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::srandmember
|
||||
*/
|
||||
public function srandmember(string $key, int $count = 0): RedisCluster|string|array|false;
|
||||
|
||||
/**
|
||||
@@ -482,10 +812,19 @@ class RedisCluster {
|
||||
*/
|
||||
public function srem(string $key, mixed $value, mixed ...$other_values): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::sscan
|
||||
*/
|
||||
public function sscan(string $key, ?int &$iterator, ?string $pattern = null, int $count = 0): array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::strlen
|
||||
*/
|
||||
public function strlen(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::subscribe
|
||||
*/
|
||||
public function subscribe(array $channels, callable $cb): void;
|
||||
|
||||
/**
|
||||
@@ -498,62 +837,149 @@ class RedisCluster {
|
||||
*/
|
||||
public function sunionstore(string $dst, string $key, string ...$other_keys): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::time
|
||||
*/
|
||||
public function time(string|array $key_or_address): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::ttl
|
||||
*/
|
||||
public function ttl(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::type
|
||||
*/
|
||||
public function type(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::unsubscribe
|
||||
*/
|
||||
public function unsubscribe(array $channels): bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::unlink
|
||||
*/
|
||||
public function unlink(array|string $key, string ...$other_keys): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::unwatch
|
||||
*/
|
||||
public function unwatch(): bool;
|
||||
|
||||
/**
|
||||
* @see Redis::watch
|
||||
*/
|
||||
public function watch(string $key, string ...$other_keys): RedisCluster|bool;
|
||||
|
||||
/**
|
||||
* @see Redis::xack
|
||||
*/
|
||||
public function xack(string $key, string $group, array $ids): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::xadd
|
||||
*/
|
||||
public function xadd(string $key, string $id, array $values, int $maxlen = 0, bool $approx = false): RedisCluster|string|false;
|
||||
|
||||
/**
|
||||
* @see Redis::xclaim
|
||||
*/
|
||||
public function xclaim(string $key, string $group, string $consumer, int $min_iddle, array $ids, array $options): RedisCluster|string|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::xdel
|
||||
*/
|
||||
public function xdel(string $key, array $ids): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::xgroup
|
||||
*/
|
||||
public function xgroup(string $operation, string $key = null, string $arg1 = null, string $arg2 = null, bool $arg3 = false): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::xinfo
|
||||
*/
|
||||
public function xinfo(string $operation, ?string $arg1 = null, ?string $arg2 = null, int $count = -1): mixed;
|
||||
|
||||
/**
|
||||
* @see Redis::xlen
|
||||
*/
|
||||
public function xlen(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::xpending
|
||||
*/
|
||||
public function xpending(string $key, string $group, ?string $start = null, ?string $end = null, int $count = -1, ?string $consumer = null): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::xrange
|
||||
*/
|
||||
public function xrange(string $key, string $start, string $end, int $count = -1): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::xread
|
||||
*/
|
||||
public function xread(array $streams, int $count = -1, int $block = -1): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::xreadgroup
|
||||
*/
|
||||
public function xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::xrevrange
|
||||
*/
|
||||
public function xrevrange(string $key, string $start, string $end, int $count = -1): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::xtrim
|
||||
*/
|
||||
public function xtrim(string $key, int $maxlen, bool $approx = false, bool $minid = false, int $limit = -1): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zadd
|
||||
*/
|
||||
public function zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zcard
|
||||
*/
|
||||
public function zcard(string $key): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zcount
|
||||
*/
|
||||
public function zcount(string $key, string $start, string $end): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zincrby
|
||||
*/
|
||||
public function zincrby(string $key, float $value, string $member): RedisCluster|float|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zinterstore
|
||||
*/
|
||||
public function zinterstore(string $dst, array $keys, ?array $weights = null, ?string $aggregate = null): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zintercard
|
||||
*/
|
||||
public function zintercard(array $keys, int $limit = -1): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zlexcount
|
||||
*/
|
||||
public function zlexcount(string $key, string $min, string $max): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zpopmax
|
||||
*/
|
||||
public function zpopmax(string $key, int $value = null): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::zpopmin
|
||||
*/
|
||||
public function zpopmin(string $key, int $value = null): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
@@ -567,32 +993,74 @@ class RedisCluster {
|
||||
public function zrangestore(string $dstkey, string $srckey, int $start, int $end,
|
||||
array|bool|null $options = null): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zrangebylex
|
||||
*/
|
||||
public function zrangebylex(string $key, string $min, string $max, int $offset = -1, int $count = -1): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zrangebyscore
|
||||
*/
|
||||
public function zrangebyscore(string $key, string $start, string $end, array $options = []): RedisCluster|array|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zrank
|
||||
*/
|
||||
public function zrank(string $key, mixed $member): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zrem
|
||||
*/
|
||||
public function zrem(string $key, string $value, string ...$other_values): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zremrangebylex
|
||||
*/
|
||||
public function zremrangebylex(string $key, string $min, string $max): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zremrangebyrank
|
||||
*/
|
||||
public function zremrangebyrank(string $key, string $min, string $max): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zremrangebyscore
|
||||
*/
|
||||
public function zremrangebyscore(string $key, string $min, string $max): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zrevrange
|
||||
*/
|
||||
public function zrevrange(string $key, string $min, string $max, array $options = null): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::zrevrangebylex
|
||||
*/
|
||||
public function zrevrangebylex(string $key, string $min, string $max, array $options = null): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::zrevrangebyscore
|
||||
*/
|
||||
public function zrevrangebyscore(string $key, string $min, string $max, array $options = null): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::zrevrank
|
||||
*/
|
||||
public function zrevrank(string $key, mixed $member): RedisCluster|int|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zscan
|
||||
*/
|
||||
public function zscan(string $key, ?int &$iterator, ?string $pattern = null, int $count = 0): RedisCluster|bool|array;
|
||||
|
||||
/**
|
||||
* @see Redis::zscore
|
||||
*/
|
||||
public function zscore(string $key, mixed $member): RedisCluster|float|false;
|
||||
|
||||
/**
|
||||
* @see Redis::zunionstore
|
||||
*/
|
||||
public function zunionstore(string $dst, array $keys, ?array $weights = NULL, ?string $aggregate = NULL): RedisCluster|int|false;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* This is a generated file, edit the .stub.php file instead.
|
||||
* Stub hash: 65c7830c07ea86720c6089dbd0fa7943df0a2ca8 */
|
||||
* Stub hash: 1783d14c476f95598062edb44dab7284b9b2680d */
|
||||
|
||||
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster___construct, 0, 0, 1)
|
||||
ZEND_ARG_TYPE_INFO(0, name, IS_STRING, 1)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* This is a generated file, edit the .stub.php file instead.
|
||||
* Stub hash: 65c7830c07ea86720c6089dbd0fa7943df0a2ca8 */
|
||||
* Stub hash: 1783d14c476f95598062edb44dab7284b9b2680d */
|
||||
|
||||
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster___construct, 0, 0, 1)
|
||||
ZEND_ARG_INFO(0, name)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* This is a generated file, edit the .stub.php file instead.
|
||||
* Stub hash: 42952974e3686f29934dfff1ebba07150942a405 */
|
||||
* Stub hash: 4c4d58bf2ce686c82287a69fef109267828a2d9b */
|
||||
|
||||
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___construct, 0, 0, 0)
|
||||
ZEND_ARG_INFO(0, options)
|
||||
|
||||
Reference in New Issue
Block a user