Skip to content

Commit 8fbd34c

Browse files
vladvildanovvladvildanov
authored
Added support for hash field expiration commands (#1456)
* Added support for hash field expiration commands * Added support for HSETF, HGETF commands * Removed non-printable ASCII chars from docs * Removed more non-printable ASCII * Fixed code style issues * Extended codespell ignore words list * Added FIELDS argument, fixes related to comments * Codestyle fixes * Fixed typo * Removed HSETF, HGETF commands * Added 7.4-rc1 to test matrix * Fixed test with new response types * Updated tests against 7.4-rc2 image
1 parent 0a92618 commit 8fbd34c

21 files changed

+1240
-1
lines changed

‎.codespellrc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ skip=./.git
33
check-hidden=
44
check-filenames=
55
builtin=clear,rare,informal,usage,code,names
6-
ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget,ro
6+
ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget,ro,DOF,dof

‎src/ClientContextInterface.php

+9
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,13 @@
154154
* @method $this strlen($key)
155155
* @method $this hdel($key, array $fields)
156156
* @method $this hexists($key, $field)
157+
* @method $this hexpire(string $key, int $seconds, array $fields, string $flag = null)
158+
* @method $this hexpireat(string $key, int $unixTimeSeconds, array $fields, string $flag = null)
159+
* @method $this hexpiretime(string $key, array $fields)
160+
* @method $this hpersist(string $key, array $fields)
161+
* @method $this hpexpire(string $key, int $milliseconds, array $fields, string $flag = null)
162+
* @method $this hpexpireat(string $key, int $unixTimeMilliseconds, array $fields, string $flag = null)
163+
* @method $this hpexpiretime(string $key, array $fields)
157164
* @method $this hget($key, $field)
158165
* @method $this hgetall($key)
159166
* @method $this hincrby($key, $field, $increment)
@@ -166,6 +173,8 @@
166173
* @method $this hscan($key, $cursor, ?array $options = null)
167174
* @method $this hset($key, $field, $value)
168175
* @method $this hsetnx($key, $field, $value)
176+
* @method $this httl(string $key, array $fields)
177+
* @method $this hpttl(string $key, array $fields)
169178
* @method $this hvals($key)
170179
* @method $this hstrlen($key, $field)
171180
* @method $this jsonarrappend(string $key, string $path = '$', ...$value)

‎src/ClientInterface.php

+9
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,13 @@
163163
* @method int strlen(string $key)
164164
* @method int hdel(string $key, array $fields)
165165
* @method int hexists(string $key, string $field)
166+
* @method array|null hexpire(string $key, int $seconds, array $fields, string $flag = null)
167+
* @method array|null hexpireat(string $key, int $unixTimeSeconds, array $fields, string $flag = null)
168+
* @method array|null hexpiretime(string $key, array $fields)
169+
* @method array|null hpersist(string $key, array $fields)
170+
* @method array|null hpexpire(string $key, int $milliseconds, array $fields, string $flag = null)
171+
* @method array|null hpexpireat(string $key, int $unixTimeMilliseconds, array $fields, string $flag = null)
172+
* @method array|null hpexpiretime(string $key, array $fields)
166173
* @method string|null hget(string $key, string $field)
167174
* @method array hgetall(string $key)
168175
* @method int hincrby(string $key, string $field, int $increment)
@@ -175,6 +182,8 @@
175182
* @method array hscan(string $key, $cursor, ?array $options = null)
176183
* @method int hset(string $key, string $field, string $value)
177184
* @method int hsetnx(string $key, string $field, string $value)
185+
* @method array|null httl(string $key, array $fields)
186+
* @method array|null hpttl(string $key, array $fields)
178187
* @method array hvals(string $key)
179188
* @method int hstrlen(string $key, string $field)
180189
* @method array jsonarrappend(string $key, string $path = '$', ...$value)

‎src/Command/Redis/HEXPIRE.php

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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 UnexpectedValueException;
17+
18+
class HEXPIRE extends RedisCommand
19+
{
20+
/**
21+
* @var array
22+
*/
23+
protected $flagsEnum = [
24+
'NX', 'XX', 'GT', 'LT',
25+
];
26+
27+
public function getId()
28+
{
29+
return 'HEXPIRE';
30+
}
31+
32+
public function setArguments(array $arguments)
33+
{
34+
$processedArguments = [$arguments[0], $arguments[1]];
35+
36+
if (array_key_exists(3, $arguments) && null !== $arguments[3]) {
37+
if (in_array(strtoupper($arguments[3]), $this->flagsEnum, true)) {
38+
$processedArguments[] = strtoupper($arguments[3]);
39+
} else {
40+
throw new UnexpectedValueException('Unsupported flag value');
41+
}
42+
}
43+
44+
if (array_key_exists(2, $arguments) && null !== $arguments[2]) {
45+
array_push($processedArguments, 'FIELDS', count($arguments[2]));
46+
$processedArguments = array_merge($processedArguments, $arguments[2]);
47+
}
48+
49+
parent::setArguments($processedArguments);
50+
}
51+
}

‎src/Command/Redis/HEXPIREAT.php

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
class HEXPIREAT extends HEXPIRE
16+
{
17+
public function getId()
18+
{
19+
return 'HEXPIREAT';
20+
}
21+
}

‎src/Command/Redis/HEXPIRETIME.php

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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+
17+
class HEXPIRETIME extends RedisCommand
18+
{
19+
public function getId()
20+
{
21+
return 'HEXPIRETIME';
22+
}
23+
24+
public function setArguments(array $arguments)
25+
{
26+
$processedArguments = [$arguments[0], 'FIELDS', count($arguments[1])];
27+
$processedArguments = array_merge($processedArguments, $arguments[1]);
28+
29+
parent::setArguments($processedArguments);
30+
}
31+
}

‎src/Command/Redis/HPERSIST.php

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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+
17+
class HPERSIST extends RedisCommand
18+
{
19+
public function getId()
20+
{
21+
return 'HPERSIST';
22+
}
23+
24+
public function setArguments(array $arguments)
25+
{
26+
$processedArguments = [$arguments[0], 'FIELDS', count($arguments[1])];
27+
$processedArguments = array_merge($processedArguments, $arguments[1]);
28+
29+
parent::setArguments($processedArguments);
30+
}
31+
}

‎src/Command/Redis/HPEXPIRE.php

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
class HPEXPIRE extends HEXPIRE
16+
{
17+
public function getId()
18+
{
19+
return 'HPEXPIRE';
20+
}
21+
}

‎src/Command/Redis/HPEXPIREAT.php

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
class HPEXPIREAT extends HEXPIRE
16+
{
17+
public function getId()
18+
{
19+
return 'HPEXPIREAT';
20+
}
21+
}

‎src/Command/Redis/HPEXPIRETIME.php

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
class HPEXPIRETIME extends HEXPIRETIME
16+
{
17+
public function getId()
18+
{
19+
return 'HPEXPIRETIME';
20+
}
21+
}

‎src/Command/Redis/HPTTL.php

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
class HPTTL extends HTTL
16+
{
17+
public function getId()
18+
{
19+
return 'HPTTL';
20+
}
21+
}

‎src/Command/Redis/HTTL.php

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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+
17+
class HTTL extends RedisCommand
18+
{
19+
public function getId()
20+
{
21+
return 'HTTL';
22+
}
23+
24+
public function setArguments(array $arguments)
25+
{
26+
$processedArguments = [$arguments[0], 'FIELDS', count($arguments[1])];
27+
$processedArguments = array_merge($processedArguments, $arguments[1]);
28+
29+
parent::setArguments($processedArguments);
30+
}
31+
}

0 commit comments

Comments
 (0)