Skip to content

Commit 5ac92d2

Browse files
michael-grundermichael-grunder
committed
Add missing directed node command to docs and refactor stubs.
* Add every "directed node" command we could find to the relevant section in cluster.markdown. * Refactor the stubs so every node argument is named the same thing ($key_or_address) and has the same data type (string|array). Fixes #1840
1 parent e392dd8 commit 5ac92d2

File tree

4 files changed

+49
-45
lines changed

4 files changed

+49
-45
lines changed

‎cluster.markdown‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -145,22 +145,28 @@ foreach ($obj_cluster->_masters() as $arr_master) {
145145

146146
In the case of all commands which need to be directed at a node, the calling convention is identical to the Redis call, except that they require an additional (first) argument in order to deliver the command. Following is a list of each of these commands:
147147

148-
1. SAVE
149-
2. BGSAVE
150-
3. FLUSHDB
151-
4. FLUSHALL
152-
5. DBSIZE
153-
6. BGREWRITEAOF
154-
7. LASTSAVE
155-
8. INFO
156-
9. CLIENT
157-
10. CLUSTER
158-
11. CONFIG
159-
12. PUBSUB
160-
13. SLOWLOG
161-
14. RANDOMKEY
162-
15. PING
163-
16. SCAN
148+
1. ACL
149+
1. BGREWRITEAOF
150+
1. BGSAVE
151+
1. CLIENT
152+
1. CLUSTER
153+
1. CONFIG
154+
1. DBSIZE
155+
1. ECHO
156+
1. FLUSHALL
157+
1. FLUSHDB
158+
1. INFO
159+
1. LASTSAVE
160+
1. PING
161+
1. PUBSUB
162+
1. RANDOMKEY
163+
1. RAWCOMMAND
164+
1. ROLE
165+
1. SAVE
166+
1. SCAN
167+
1. SCRIPT
168+
1. SLOWLOG
169+
1. TIME
164170

165171
## Session Handler
166172
You can use the cluster functionality of phpredis to store PHP session information in a Redis cluster as you can with a non cluster-enabled Redis instance.

‎redis_cluster.stub.php‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,15 @@ public function lmpop(array $keys, string $from, int $count = 1): RedisCluster|a
6161

6262
public function clearlasterror(): bool;
6363

64-
public function client(string|array $node, string $subcommand, ?string $arg = NULL): array|string|bool;
64+
public function client(string|array $key_or_address, string $subcommand, ?string $arg = NULL): array|string|bool;
6565

6666
public function close(): bool;
6767

68-
public function cluster(string|array $node, string $command, mixed ...$extra_args): mixed;
68+
public function cluster(string|array $key_or_address, string $command, mixed ...$extra_args): mixed;
6969

7070
public function command(mixed ...$extra_args): mixed;
7171

72-
public function config(string|array $node, string $subcommand, mixed ...$extra_args): mixed;
72+
public function config(string|array $key_or_address, string $subcommand, mixed ...$extra_args): mixed;
7373

7474
public function dbsize(string|array $key_or_address): RedisCluster|int;
7575

@@ -85,7 +85,7 @@ public function discard(): bool;
8585

8686
public function dump(string $key): RedisCluster|string|false;
8787

88-
public function echo(string|array $node, string $msg): RedisCluster|string|false;
88+
public function echo(string|array $key_or_address, string $msg): RedisCluster|string|false;
8989

9090
public function eval(string $script, array $args = [], int $num_keys = 0): mixed;
9191

@@ -103,9 +103,9 @@ public function expiretime(string $key): RedisCluster|int|false;
103103

104104
public function pexpiretime(string $key): RedisCluster|int|false;
105105

106-
public function flushall(string|array $node, bool $async = false): RedisCluster|bool;
106+
public function flushall(string|array $key_or_address, bool $async = false): RedisCluster|bool;
107107

108-
public function flushdb(string|array $node, bool $async = false): RedisCluster|bool;
108+
public function flushdb(string|array $key_or_address, bool $async = false): RedisCluster|bool;
109109

110110
public function geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples): RedisCluster|int;
111111

@@ -175,11 +175,11 @@ public function incrby(string $key, int $value): RedisCluster|int|false;
175175

176176
public function incrbyfloat(string $key, float $value): RedisCluster|float|false;
177177

178-
public function info(string|array $node, ?string $section = null): RedisCluster|array|false;
178+
public function info(string|array $key_or_address, ?string $section = null): RedisCluster|array|false;
179179

180180
public function keys(string $pattern): RedisCluster|array|false;
181181

182-
public function lastsave(string|array $node): RedisCluster|int|false;
182+
public function lastsave(string|array $key_or_address): RedisCluster|int|false;
183183

184184
public function lget(string $key, int $index): RedisCluster|string|bool;
185185

@@ -268,7 +268,7 @@ public function saddarray(string $key, array $values): RedisCluster|bool|int;
268268

269269
public function save(string|array $key_or_address): RedisCluster|bool;
270270

271-
public function scan(?int &$iterator, mixed $node, ?string $pattern = null, int $count = 0): bool|array;
271+
public function scan(?int &$iterator, string|array $key_or_address, ?string $pattern = null, int $count = 0): bool|array;
272272

273273
public function scard(string $key): RedisCluster|int|false;
274274

‎redis_cluster_arginfo.h‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* This is a generated file, edit the .stub.php file instead.
2-
* Stub hash: 280323a9e3fc028641ad1d8bcba2514dfa90fac9 */
2+
* Stub hash: c6326ac0f4a1dc7b6fe920a7358010f1a570832a */
33

44
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster___construct, 0, 0, 1)
55
ZEND_ARG_TYPE_INFO(0, name, IS_STRING, 1)
@@ -122,15 +122,15 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_RedisCluster_clearlasterro
122122
ZEND_END_ARG_INFO()
123123

124124
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_class_RedisCluster_client, 0, 2, MAY_BE_ARRAY|MAY_BE_STRING|MAY_BE_BOOL)
125-
ZEND_ARG_TYPE_MASK(0, node, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
125+
ZEND_ARG_TYPE_MASK(0, key_or_address, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
126126
ZEND_ARG_TYPE_INFO(0, subcommand, IS_STRING, 0)
127127
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, arg, IS_STRING, 1, "NULL")
128128
ZEND_END_ARG_INFO()
129129

130130
#define arginfo_class_RedisCluster_close arginfo_class_RedisCluster_clearlasterror
131131

132132
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_RedisCluster_cluster, 0, 2, IS_MIXED, 0)
133-
ZEND_ARG_TYPE_MASK(0, node, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
133+
ZEND_ARG_TYPE_MASK(0, key_or_address, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
134134
ZEND_ARG_TYPE_INFO(0, command, IS_STRING, 0)
135135
ZEND_ARG_VARIADIC_TYPE_INFO(0, extra_args, IS_MIXED, 0)
136136
ZEND_END_ARG_INFO()
@@ -140,7 +140,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_RedisCluster_command, 0, 0
140140
ZEND_END_ARG_INFO()
141141

142142
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_RedisCluster_config, 0, 2, IS_MIXED, 0)
143-
ZEND_ARG_TYPE_MASK(0, node, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
143+
ZEND_ARG_TYPE_MASK(0, key_or_address, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
144144
ZEND_ARG_TYPE_INFO(0, subcommand, IS_STRING, 0)
145145
ZEND_ARG_VARIADIC_TYPE_INFO(0, extra_args, IS_MIXED, 0)
146146
ZEND_END_ARG_INFO()
@@ -176,7 +176,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_dump, 0,
176176
ZEND_END_ARG_INFO()
177177

178178
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_echo, 0, 2, RedisCluster, MAY_BE_STRING|MAY_BE_FALSE)
179-
ZEND_ARG_TYPE_MASK(0, node, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
179+
ZEND_ARG_TYPE_MASK(0, key_or_address, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
180180
ZEND_ARG_TYPE_INFO(0, msg, IS_STRING, 0)
181181
ZEND_END_ARG_INFO()
182182

@@ -217,7 +217,7 @@ ZEND_END_ARG_INFO()
217217
#define arginfo_class_RedisCluster_pexpiretime arginfo_class_RedisCluster_expiretime
218218

219219
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_flushall, 0, 1, RedisCluster, MAY_BE_BOOL)
220-
ZEND_ARG_TYPE_MASK(0, node, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
220+
ZEND_ARG_TYPE_MASK(0, key_or_address, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
221221
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, async, _IS_BOOL, 0, "false")
222222
ZEND_END_ARG_INFO()
223223

@@ -381,7 +381,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_incrbyflo
381381
ZEND_END_ARG_INFO()
382382

383383
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_info, 0, 1, RedisCluster, MAY_BE_ARRAY|MAY_BE_FALSE)
384-
ZEND_ARG_TYPE_MASK(0, node, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
384+
ZEND_ARG_TYPE_MASK(0, key_or_address, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
385385
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, section, IS_STRING, 1, "null")
386386
ZEND_END_ARG_INFO()
387387

@@ -390,7 +390,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_keys, 0,
390390
ZEND_END_ARG_INFO()
391391

392392
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_lastsave, 0, 1, RedisCluster, MAY_BE_LONG|MAY_BE_FALSE)
393-
ZEND_ARG_TYPE_MASK(0, node, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
393+
ZEND_ARG_TYPE_MASK(0, key_or_address, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
394394
ZEND_END_ARG_INFO()
395395

396396
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_lget, 0, 2, RedisCluster, MAY_BE_STRING|MAY_BE_BOOL)
@@ -591,7 +591,7 @@ ZEND_END_ARG_INFO()
591591

592592
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_class_RedisCluster_scan, 0, 2, MAY_BE_BOOL|MAY_BE_ARRAY)
593593
ZEND_ARG_TYPE_INFO(1, iterator, IS_LONG, 1)
594-
ZEND_ARG_TYPE_INFO(0, node, IS_MIXED, 0)
594+
ZEND_ARG_TYPE_MASK(0, key_or_address, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
595595
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, pattern, IS_STRING, 1, "null")
596596
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, count, IS_LONG, 0, "0")
597597
ZEND_END_ARG_INFO()

‎redis_cluster_legacy_arginfo.h‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* This is a generated file, edit the .stub.php file instead.
2-
* Stub hash: 280323a9e3fc028641ad1d8bcba2514dfa90fac9 */
2+
* Stub hash: c6326ac0f4a1dc7b6fe920a7358010f1a570832a */
33

44
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster___construct, 0, 0, 1)
55
ZEND_ARG_INFO(0, name)
@@ -110,15 +110,15 @@ ZEND_END_ARG_INFO()
110110
#define arginfo_class_RedisCluster_clearlasterror arginfo_class_RedisCluster__masters
111111

112112
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_client, 0, 0, 2)
113-
ZEND_ARG_INFO(0, node)
113+
ZEND_ARG_INFO(0, key_or_address)
114114
ZEND_ARG_INFO(0, subcommand)
115115
ZEND_ARG_INFO(0, arg)
116116
ZEND_END_ARG_INFO()
117117

118118
#define arginfo_class_RedisCluster_close arginfo_class_RedisCluster__masters
119119

120120
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_cluster, 0, 0, 2)
121-
ZEND_ARG_INFO(0, node)
121+
ZEND_ARG_INFO(0, key_or_address)
122122
ZEND_ARG_INFO(0, command)
123123
ZEND_ARG_VARIADIC_INFO(0, extra_args)
124124
ZEND_END_ARG_INFO()
@@ -128,7 +128,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_command, 0, 0, 0)
128128
ZEND_END_ARG_INFO()
129129

130130
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_config, 0, 0, 2)
131-
ZEND_ARG_INFO(0, node)
131+
ZEND_ARG_INFO(0, key_or_address)
132132
ZEND_ARG_INFO(0, subcommand)
133133
ZEND_ARG_VARIADIC_INFO(0, extra_args)
134134
ZEND_END_ARG_INFO()
@@ -154,7 +154,7 @@ ZEND_END_ARG_INFO()
154154
#define arginfo_class_RedisCluster_dump arginfo_class_RedisCluster__prefix
155155

156156
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_echo, 0, 0, 2)
157-
ZEND_ARG_INFO(0, node)
157+
ZEND_ARG_INFO(0, key_or_address)
158158
ZEND_ARG_INFO(0, msg)
159159
ZEND_END_ARG_INFO()
160160

@@ -189,7 +189,7 @@ ZEND_END_ARG_INFO()
189189
#define arginfo_class_RedisCluster_pexpiretime arginfo_class_RedisCluster__prefix
190190

191191
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_flushall, 0, 0, 1)
192-
ZEND_ARG_INFO(0, node)
192+
ZEND_ARG_INFO(0, key_or_address)
193193
ZEND_ARG_INFO(0, async)
194194
ZEND_END_ARG_INFO()
195195

@@ -323,17 +323,15 @@ ZEND_END_ARG_INFO()
323323
#define arginfo_class_RedisCluster_incrbyfloat arginfo_class_RedisCluster_append
324324

325325
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_info, 0, 0, 1)
326-
ZEND_ARG_INFO(0, node)
326+
ZEND_ARG_INFO(0, key_or_address)
327327
ZEND_ARG_INFO(0, section)
328328
ZEND_END_ARG_INFO()
329329

330330
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_keys, 0, 0, 1)
331331
ZEND_ARG_INFO(0, pattern)
332332
ZEND_END_ARG_INFO()
333333

334-
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_lastsave, 0, 0, 1)
335-
ZEND_ARG_INFO(0, node)
336-
ZEND_END_ARG_INFO()
334+
#define arginfo_class_RedisCluster_lastsave arginfo_class_RedisCluster_bgrewriteaof
337335

338336
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_lget, 0, 0, 2)
339337
ZEND_ARG_INFO(0, key)
@@ -499,7 +497,7 @@ ZEND_END_ARG_INFO()
499497

500498
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_scan, 0, 0, 2)
501499
ZEND_ARG_INFO(1, iterator)
502-
ZEND_ARG_INFO(0, node)
500+
ZEND_ARG_INFO(0, key_or_address)
503501
ZEND_ARG_INFO(0, pattern)
504502
ZEND_ARG_INFO(0, count)
505503
ZEND_END_ARG_INFO()

0 commit comments

Comments
 (0)