Skip to content

Commit bc5f07d

Browse files
vladvildanovVladyslav Vildanovtillkrussglaubinix
authored
Sync branch with 2.x (#1169)
* Added support for new arguments for BITPOS, BITCOUNT commands (#1045) * Added support for new arguments for EXPIRE, EXPIREAT commands (#1046) * Extended core support by implementing SORT_RO command (#1044) * Added support for SORT_RO command * Codestyle fixes * Added command description --------- Co-authored-by: Vladyslav Vildanov <[email protected]> * fix deprecated call * Added support for container commands (#1049) * Added support for container commands FUNCTION LOAD, FUNCTION DELETE and FCALL * Changed ContainerInterface and AbstractContainer * Re-implement logic of abstract methods --------- Co-authored-by: Vladyslav Vildanov <[email protected]> * Added stream commands to KeyPrefixProcessor (#1051) Co-authored-by: Vladyslav Vildanov <[email protected]> * Fix return type of ReplicationInterface::getSlaves (#1111) * Codestyle fixes * Changed return annotation --------- Co-authored-by: Vladyslav Vildanov <[email protected]> Co-authored-by: Till Krüss <[email protected]> Co-authored-by: Stephan <[email protected]>
1 parent 02fadf8 commit bc5f07d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2126
-22
lines changed

‎src/Client.php

+31
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
use IteratorAggregate;
1818
use Predis\Command\CommandInterface;
1919
use Predis\Command\RawCommand;
20+
use Predis\Command\Redis\Container\ContainerFactory;
21+
use Predis\Command\Redis\Container\ContainerInterface;
2022
use Predis\Command\ScriptCommand;
2123
use Predis\Configuration\Options;
2224
use Predis\Configuration\OptionsInterface;
@@ -31,6 +33,7 @@
3133
use Predis\Response\ServerException;
3234
use Predis\Transaction\MultiExec as MultiExecTransaction;
3335
use ReturnTypeWillChange;
36+
use RuntimeException;
3437
use Traversable;
3538

3639
/**
@@ -310,6 +313,34 @@ public function createCommand($commandID, $arguments = [])
310313
return $this->commands->create($commandID, $arguments);
311314
}
312315

316+
/**
317+
* @param $name
318+
* @return ContainerInterface
319+
*/
320+
public function __get($name)
321+
{
322+
return ContainerFactory::create($this, $name);
323+
}
324+
325+
/**
326+
* @param $name
327+
* @param $value
328+
* @return mixed
329+
*/
330+
public function __set($name, $value)
331+
{
332+
throw new RuntimeException('Not allowed');
333+
}
334+
335+
/**
336+
* @param $name
337+
* @return mixed
338+
*/
339+
public function __isset($name)
340+
{
341+
throw new RuntimeException('Not allowed');
342+
}
343+
313344
/**
314345
* {@inheritdoc}
315346
*/

‎src/ClientContextInterface.php

+11-4
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@
1414

1515
use Predis\Command\Argument\Geospatial\ByInterface;
1616
use Predis\Command\Argument\Geospatial\FromInterface;
17+
use Predis\Command\Argument\Server\LimitOffsetCount;
1718
use Predis\Command\Argument\Server\To;
1819
use Predis\Command\CommandInterface;
20+
use Predis\Command\Redis\Container\FunctionContainer;
1921

2022
/**
2123
* Interface defining a client-side context such as a pipeline or transaction.
@@ -24,8 +26,8 @@
2426
* @method $this del(array|string $keys)
2527
* @method $this dump($key)
2628
* @method $this exists($key)
27-
* @method $this expire($key, $seconds)
28-
* @method $this expireat($key, $timestamp)
29+
* @method $this expire($key, $seconds, string $expireOption = '')
30+
* @method $this expireat($key, $timestamp, string $expireOption = '')
2931
* @method $this expiretime(string $key)
3032
* @method $this keys($pattern)
3133
* @method $this move($key, $db)
@@ -39,9 +41,11 @@
3941
* @method $this renamenx($key, $target)
4042
* @method $this scan($cursor, array $options = null)
4143
* @method $this sort($key, array $options = null)
44+
* @method $this sort_ro(string $key, ?string $byPattern = null, ?LimitOffsetCount $limit = null, array $getPatterns = [], ?string $sorting = null, bool $alpha = false)
4245
* @method $this ttl($key)
4346
* @method $this type($key)
4447
* @method $this append($key, $value)
48+
* @method $this bitcount($key, $start = null, $end = null, string $index = 'byte')
4549
* @method $this bfadd(string $key, $item)
4650
* @method $this bfexists(string $key, $item)
4751
* @method $this bfinfo(string $key, string $modifier = '')
@@ -51,10 +55,9 @@
5155
* @method $this bfmexists(string $key, ...$item)
5256
* @method $this bfreserve(string $key, float $errorRate, int $capacity, int $expansion = -1, bool $nonScaling = false)
5357
* @method $this bfscandump(string $key, int $iterator)
54-
* @method $this bitcount($key, $start = null, $end = null)
5558
* @method $this bitop($operation, $destkey, $key)
5659
* @method $this bitfield($key, $subcommand, ...$subcommandArg)
57-
* @method $this bitpos($key, $bit, $start = null, $end = null)
60+
* @method $this bitpos($key, $bit, $start = null, $end = null, string $index = 'byte')
5861
* @method $this blmpop(int $timeout, array $keys, string $modifier = 'left', int $count = 1)
5962
* @method $this bzpopmax(array $keys, int $timeout)
6063
* @method $this bzpopmin(array $keys, int $timeout)
@@ -80,6 +83,7 @@
8083
* @method $this decr($key)
8184
* @method $this decrby($key, $decrement)
8285
* @method $this failover(?To $to = null, bool $abort = false, int $timeout = -1)
86+
* @method $this fcall(string $function, array $keys, ...$args)
8387
* @method $this get($key)
8488
* @method $this getbit($key, $offset)
8589
* @method $this getex(string $key, $modifier = '', $value = false)
@@ -265,6 +269,9 @@
265269
* @method $this georadiusbymember($key, $member, $radius, $unit, array $options = null)
266270
* @method $this geosearch(string $key, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $withCoord = false, bool $withDist = false, bool $withHash = false)
267271
* @method $this geosearchstore(string $destination, string $source, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $storeDist = false)
272+
*
273+
* Container commands
274+
* @property FunctionContainer $function
268275
*/
269276
interface ClientContextInterface
270277
{

‎src/ClientInterface.php

+11-4
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@
1414

1515
use Predis\Command\Argument\Geospatial\ByInterface;
1616
use Predis\Command\Argument\Geospatial\FromInterface;
17+
use Predis\Command\Argument\Server\LimitOffsetCount;
1718
use Predis\Command\Argument\Server\To;
1819
use Predis\Command\CommandInterface;
1920
use Predis\Command\FactoryInterface;
21+
use Predis\Command\Redis\Container\FunctionContainer;
2022
use Predis\Configuration\OptionsInterface;
2123
use Predis\Connection\ConnectionInterface;
2224
use Predis\Response\Status;
@@ -33,8 +35,8 @@
3335
* @method int del(string[]|string $keyOrKeys, string ...$keys = null)
3436
* @method string|null dump(string $key)
3537
* @method int exists(string $key)
36-
* @method int expire(string $key, int $seconds)
37-
* @method int expireat(string $key, int $timestamp)
38+
* @method int expire(string $key, int $seconds, string $expireOption = '')
39+
* @method int expireat(string $key, int $timestamp, string $expireOption = '')
3840
* @method int expiretime(string $key)
3941
* @method array keys(string $pattern)
4042
* @method int move(string $key, int $db)
@@ -48,9 +50,11 @@
4850
* @method int renamenx(string $key, string $target)
4951
* @method array scan($cursor, array $options = null)
5052
* @method array sort(string $key, array $options = null)
53+
* @method array sort_ro(string $key, ?string $byPattern = null, ?LimitOffsetCount $limit = null, array $getPatterns = [], ?string $sorting = null, bool $alpha = false)
5154
* @method int ttl(string $key)
5255
* @method mixed type(string $key)
5356
* @method int append(string $key, $value)
57+
* @method int bitcount(string $key, $start = null, $end = null, string $index = 'byte')
5458
* @method int bfadd(string $key, $item)
5559
* @method int bfexists(string $key, $item)
5660
* @method array bfinfo(string $key, string $modifier = '')
@@ -60,10 +64,9 @@
6064
* @method array bfmexists(string $key, ...$item)
6165
* @method Status bfreserve(string $key, float $errorRate, int $capacity, int $expansion = -1, bool $nonScaling = false)
6266
* @method array bfscandump(string $key, int $iterator)
63-
* @method int bitcount(string $key, $start = null, $end = null)
6467
* @method int bitop($operation, $destkey, $key)
6568
* @method array|null bitfield(string $key, $subcommand, ...$subcommandArg)
66-
* @method int bitpos(string $key, $bit, $start = null, $end = null)
69+
* @method int bitpos(string $key, $bit, $start = null, $end = null, string $index = 'byte')
6770
* @method array blmpop(int $timeout, array $keys, string $modifier = 'left', int $count = 1)
6871
* @method array bzpopmax(array $keys, int $timeout)
6972
* @method array bzpopmin(array $keys, int $timeout)
@@ -89,6 +92,7 @@
8992
* @method int decr(string $key)
9093
* @method int decrby(string $key, int $decrement)
9194
* @method Status failover(?To $to = null, bool $abort = false, int $timeout = -1)
95+
* @method mixed fcall(string $function, array $keys, ...$args)
9296
* @method string|null get(string $key)
9397
* @method int getbit(string $key, $offset)
9498
* @method int|null getex(string $key, $modifier = '', $value = false)
@@ -283,6 +287,9 @@
283287
* @method array georadiusbymember(string $key, $member, $radius, $unit, array $options = null)
284288
* @method array geosearch(string $key, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $withCoord = false, bool $withDist = false, bool $withHash = false)
285289
* @method int geosearchstore(string $destination, string $source, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $storeDist = false)
290+
*
291+
* Container commands
292+
* @property FunctionContainer $function
286293
*/
287294
interface ClientInterface
288295
{

‎src/Command/Argument/Server/LimitInterface.php

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Argument\Server;
14+
15+
use Predis\Command\Argument\ArrayableArgument;
16+
17+
interface LimitInterface extends ArrayableArgument
18+
{
19+
}

‎src/Command/Argument/Server/LimitOffsetCount.php

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Argument\Server;
14+
15+
class LimitOffsetCount implements LimitInterface
16+
{
17+
private const KEYWORD = 'LIMIT';
18+
19+
/**
20+
* @var int
21+
*/
22+
private $offset;
23+
24+
/**
25+
* @var int
26+
*/
27+
private $count;
28+
29+
public function __construct(int $offset, int $count)
30+
{
31+
$this->offset = $offset;
32+
$this->count = $count;
33+
}
34+
35+
/**
36+
* {@inheritDoc}
37+
*/
38+
public function toArray(): array
39+
{
40+
return [self::KEYWORD, $this->offset, $this->count];
41+
}
42+
}

‎src/Command/Command.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ public static function normalizeVariadic(array $arguments)
120120
public function filterArguments(): void
121121
{
122122
$this->arguments = array_filter($this->arguments, static function ($argument) {
123-
return $argument !== false;
123+
return $argument !== false && $argument !== null;
124124
});
125125
}
126126
}

‎src/Command/Processor/KeyPrefixProcessor.php

+6
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,12 @@ public function __construct($prefix)
178178
'GEODIST' => $prefixFirst,
179179
'GEORADIUS' => $prefixGeoradius,
180180
'GEORADIUSBYMEMBER' => $prefixGeoradius,
181+
/* ---------------- Redis 5.0 ---------------- */
182+
'XADD' => $prefixFirst,
183+
'XRANGE' => $prefixFirst,
184+
'XDEL' => $prefixFirst,
185+
'XLEN' => $prefixFirst,
186+
'XACK' => $prefixFirst,
181187
];
182188
}
183189

‎src/Command/Redis/BITCOUNT.php

+5
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,17 @@
1313
namespace Predis\Command\Redis;
1414

1515
use Predis\Command\Command as RedisCommand;
16+
use Predis\Command\Traits\BitByte;
1617

1718
/**
1819
* @see http://redis.io/commands/bitcount
20+
*
21+
* Count the number of set bits (population counting) in a string.
1922
*/
2023
class BITCOUNT extends RedisCommand
2124
{
25+
use BitByte;
26+
2227
/**
2328
* {@inheritdoc}
2429
*/

‎src/Command/Redis/BITPOS.php

+5
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,17 @@
1313
namespace Predis\Command\Redis;
1414

1515
use Predis\Command\Command as RedisCommand;
16+
use Predis\Command\Traits\BitByte;
1617

1718
/**
1819
* @see http://redis.io/commands/bitpos
20+
*
21+
* Return the position of the first bit set to 1 or 0 in a string.
1922
*/
2023
class BITPOS extends RedisCommand
2124
{
25+
use BitByte;
26+
2227
/**
2328
* {@inheritdoc}
2429
*/

‎src/Command/Redis/Container/AbstractContainer.php

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Redis\Container;
14+
15+
use Predis\ClientInterface;
16+
17+
abstract class AbstractContainer implements ContainerInterface
18+
{
19+
/**
20+
* @var ClientInterface
21+
*/
22+
protected $client;
23+
24+
public function __construct(ClientInterface $client)
25+
{
26+
$this->client = $client;
27+
}
28+
29+
/**
30+
* {@inheritDoc}
31+
*/
32+
public function __call($subcommandID, $arguments)
33+
{
34+
array_unshift($arguments, strtoupper($subcommandID));
35+
36+
return $this->client->executeCommand(
37+
$this->client->createCommand($this->getContainerCommandId(), $arguments)
38+
);
39+
}
40+
41+
abstract public function getContainerCommandId(): string;
42+
}

‎src/Command/Redis/Container/ContainerFactory.php

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Redis\Container;
14+
15+
use Predis\ClientInterface;
16+
use UnexpectedValueException;
17+
18+
class ContainerFactory
19+
{
20+
private const CONTAINER_NAMESPACE = "Predis\Command\Redis\Container";
21+
22+
/**
23+
* Mappings for class names that corresponds to PHP reserved words.
24+
*
25+
* @var array
26+
*/
27+
private static $specialMappings = [
28+
'FUNCTION' => FunctionContainer::class,
29+
];
30+
31+
/**
32+
* Creates container command.
33+
*
34+
* @param ClientInterface $client
35+
* @param string $containerCommandID
36+
* @return ContainerInterface
37+
*/
38+
public static function create(ClientInterface $client, string $containerCommandID): ContainerInterface
39+
{
40+
$containerCommandID = strtoupper($containerCommandID);
41+
42+
if (class_exists($containerClass = self::CONTAINER_NAMESPACE . '\\' . $containerCommandID)) {
43+
return new $containerClass($client);
44+
}
45+
46+
if (array_key_exists($containerCommandID, self::$specialMappings)) {
47+
$containerClass = self::$specialMappings[$containerCommandID];
48+
49+
return new $containerClass($client);
50+
}
51+
52+
throw new UnexpectedValueException('Given command is not supported.');
53+
}
54+
}

0 commit comments

Comments
 (0)