Skip to content

Commit db65e5e

Browse files
vladvildanovVladyslav Vildanov
vladvildanov
and
Vladyslav Vildanov
authored
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]>
1 parent 50e005b commit db65e5e

18 files changed

+738
-6
lines changed

‎src/ClientContextInterface.php

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
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

@@ -39,6 +40,7 @@
3940
* @method $this renamenx($key, $target)
4041
* @method $this scan($cursor, array $options = null)
4142
* @method $this sort($key, array $options = null)
43+
* @method $this sort_ro(string $key, ?string $byPattern = null, ?LimitOffsetCount $limit = null, array $getPatterns = [], ?string $sorting = null, bool $alpha = false)
4244
* @method $this ttl($key)
4345
* @method $this type($key)
4446
* @method $this append($key, $value)

‎src/ClientInterface.php

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
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;
@@ -48,6 +49,7 @@
4849
* @method int renamenx(string $key, string $target)
4950
* @method array scan($cursor, array $options = null)
5051
* @method array sort(string $key, array $options = null)
52+
* @method array sort_ro(string $key, ?string $byPattern = null, ?LimitOffsetCount $limit = null, array $getPatterns = [], ?string $sorting = null, bool $alpha = false)
5153
* @method int ttl(string $key)
5254
* @method mixed type(string $key)
5355
* @method int append(string $key, $value)

‎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/Redis/SINTERCARD.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
use Predis\Command\Command as RedisCommand;
1616
use Predis\Command\Traits\Keys;
17-
use Predis\Command\Traits\Limit;
17+
use Predis\Command\Traits\Limit\Limit;
1818

1919
class SINTERCARD extends RedisCommand
2020
{

‎src/Command/Redis/SORT_RO.php

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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;
14+
15+
use Predis\Command\Command as RedisCommand;
16+
use Predis\Command\Traits\By\ByArgument;
17+
use Predis\Command\Traits\Get\Get;
18+
use Predis\Command\Traits\Limit\LimitObject;
19+
use Predis\Command\Traits\Sorting;
20+
21+
/**
22+
* @see https://redis.io/commands/sort_ro/
23+
*
24+
* Read-only variant of the SORT command.
25+
* It is exactly like the original SORT but refuses the STORE option
26+
* and can safely be used in read-only replicas.
27+
*/
28+
class SORT_RO extends RedisCommand
29+
{
30+
use ByArgument {
31+
ByArgument::setArguments as setBy;
32+
}
33+
use LimitObject {
34+
LimitObject::setArguments as setLimit;
35+
}
36+
use Get {
37+
Get::setArguments as setGetArgument;
38+
}
39+
use Sorting {
40+
Sorting::setArguments as setSorting;
41+
}
42+
43+
protected static $byArgumentPositionOffset = 1;
44+
protected static $getArgumentPositionOffset = 3;
45+
protected static $sortArgumentPositionOffset = 4;
46+
47+
public function getId()
48+
{
49+
return 'SORT_RO';
50+
}
51+
52+
public function setArguments(array $arguments)
53+
{
54+
$alpha = array_pop($arguments);
55+
56+
if (is_bool($alpha) && $alpha) {
57+
$arguments[] = 'ALPHA';
58+
} elseif (!is_bool($alpha)) {
59+
$arguments[] = $alpha;
60+
}
61+
62+
$this->setSorting($arguments);
63+
$arguments = $this->getArguments();
64+
65+
$this->setGetArgument($arguments);
66+
$arguments = $this->getArguments();
67+
68+
$this->setLimit($arguments);
69+
$arguments = $this->getArguments();
70+
71+
$this->setBy($arguments);
72+
$this->filterArguments();
73+
}
74+
}

‎src/Command/Redis/ZINTERCARD.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
use Predis\Command\Command as RedisCommand;
1616
use Predis\Command\Traits\Keys;
17-
use Predis\Command\Traits\Limit;
17+
use Predis\Command\Traits\Limit\Limit;
1818

1919
/**
2020
* @see https://redis.io/commands/zintercard/

‎src/Command/Redis/ZRANGESTORE.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
use Predis\Command\Command as RedisCommand;
1616
use Predis\Command\Traits\By\ByLexByScore;
17-
use Predis\Command\Traits\Limit;
17+
use Predis\Command\Traits\Limit\Limit;
1818
use Predis\Command\Traits\Rev;
1919

2020
/**

‎src/Command/Traits/By/ByArgument.php

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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\Traits\By;
14+
15+
use Predis\Command\Command;
16+
17+
/**
18+
* @mixin Command
19+
*/
20+
trait ByArgument
21+
{
22+
private $byModifier = 'BY';
23+
24+
public function setArguments(array $arguments)
25+
{
26+
$argumentsLength = count($arguments);
27+
28+
if (static::$byArgumentPositionOffset >= $argumentsLength || null === $arguments[static::$byArgumentPositionOffset]) {
29+
parent::setArguments($arguments);
30+
31+
return;
32+
}
33+
34+
$argument = $arguments[static::$byArgumentPositionOffset];
35+
$argumentsBefore = array_slice($arguments, 0, static::$byArgumentPositionOffset);
36+
$argumentsAfter = array_slice($arguments, static::$byArgumentPositionOffset + 1);
37+
38+
parent::setArguments(array_merge($argumentsBefore, [$this->byModifier, $argument], $argumentsAfter));
39+
}
40+
}

‎src/Command/Traits/Get/Get.php

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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\Traits\Get;
14+
15+
use UnexpectedValueException;
16+
17+
trait Get
18+
{
19+
private static $getModifier = 'GET';
20+
21+
public function setArguments(array $arguments)
22+
{
23+
$argumentsLength = count($arguments);
24+
25+
if (static::$getArgumentPositionOffset >= $argumentsLength) {
26+
parent::setArguments($arguments);
27+
28+
return;
29+
}
30+
31+
if (!is_array($arguments[static::$getArgumentPositionOffset])) {
32+
throw new UnexpectedValueException('Wrong get argument type');
33+
}
34+
35+
$patterns = [];
36+
37+
foreach ($arguments[static::$getArgumentPositionOffset] as $pattern) {
38+
$patterns[] = self::$getModifier;
39+
$patterns[] = $pattern;
40+
}
41+
42+
$argumentsBeforeKeys = array_slice($arguments, 0, static::$getArgumentPositionOffset);
43+
$argumentsAfterKeys = array_slice($arguments, static::$getArgumentPositionOffset + 1);
44+
45+
parent::setArguments(array_merge($argumentsBeforeKeys, $patterns, $argumentsAfterKeys));
46+
}
47+
}

‎src/Command/Traits/Limit.php ‎src/Command/Traits/Limit/Limit.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* file that was distributed with this source code.
1111
*/
1212

13-
namespace Predis\Command\Traits;
13+
namespace Predis\Command\Traits\Limit;
1414

1515
use Predis\Command\Command;
1616
use UnexpectedValueException;

‎src/Command/Traits/Limit/LimitObject.php

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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\Traits\Limit;
14+
15+
use Predis\Command\Argument\Server\LimitInterface;
16+
17+
trait LimitObject
18+
{
19+
public function setArguments(array $arguments)
20+
{
21+
$argumentPositionOffset = $this->getLimitArgumentPositionOffset($arguments);
22+
23+
if (null === $argumentPositionOffset) {
24+
parent::setArguments($arguments);
25+
26+
return;
27+
}
28+
29+
$limitObject = $arguments[$argumentPositionOffset];
30+
$argumentsBefore = array_slice($arguments, 0, $argumentPositionOffset);
31+
$argumentsAfter = array_slice($arguments, $argumentPositionOffset + 1);
32+
33+
parent::setArguments(array_merge(
34+
$argumentsBefore,
35+
$limitObject->toArray(),
36+
$argumentsAfter
37+
));
38+
}
39+
40+
private function getLimitArgumentPositionOffset(array $arguments): ?int
41+
{
42+
foreach ($arguments as $i => $value) {
43+
if ($value instanceof LimitInterface) {
44+
return $i;
45+
}
46+
}
47+
48+
return null;
49+
}
50+
}

0 commit comments

Comments
 (0)