Added support for hash field expiration commands

.codespellrc

@@ -3,4 +3,4 @@ skip=./.git
 check-hidden=
 check-filenames=
 builtin=clear,rare,informal,usage,code,names
-ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget,ro
+ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget,ro,DOF,dof

.github/workflows/stack.yml

@@ -33,6 +33,7 @@ jobs:
           - '8.3'
         redis:
           - latest
+          - 7.4.0-rc1
 
     continue-on-error: ${{ matrix.php == '8.3' }}
 

.github/workflows/tests.yml

@@ -35,6 +35,7 @@ jobs:
           - 5
           - 6
           - 7
+          - 7.4-rc1
 
     services:
       redis:

examples/transaction_using_cas.php

@@ -32,7 +32,7 @@ function zpop($client, $key)
         'cas' => true,      // Initialize with support for CAS operations
         'watch' => $key,    // Key that needs to be WATCHed to detect changes
         'retry' => 3,       // Number of retries on aborted transactions, after
-                            // which the client bails out with an exception.
+        // which the client bails out with an exception.
     ];
 
     $client->transaction($options, function ($tx) use ($key, &$element) {

src/ClientContextInterface.php

@@ -154,6 +154,13 @@
  * @method $this strlen($key)
  * @method $this hdel($key, array $fields)
  * @method $this hexists($key, $field)
+ * @method $this hexpire(string $key, int $seconds, array $fields, string $flag = null)
+ * @method $this hexpireat(string $key, int $unixTimeSeconds, array $fields, string $flag = null)
+ * @method $this hexpiretime(string $key, array $fields)
+ * @method $this hpersist(string $key, array $fields)
+ * @method $this hpexpire(string $key, int $milliseconds, array $fields, string $flag = null)
+ * @method $this hpexpireat(string $key, int $unixTimeMilliseconds, array $fields, string $flag = null)
+ * @method $this hpexpiretime(string $key, array $fields)
  * @method $this hget($key, $field)
  * @method $this hgetall($key)
  * @method $this hincrby($key, $field, $increment)
@@ -166,6 +173,8 @@
  * @method $this hscan($key, $cursor, ?array $options = null)
  * @method $this hset($key, $field, $value)
  * @method $this hsetnx($key, $field, $value)
+ * @method $this httl(string $key, array $fields)
+ * @method $this hpttl(string $key, array $fields)
  * @method $this hvals($key)
  * @method $this hstrlen($key, $field)
  * @method $this jsonarrappend(string $key, string $path = '$', ...$value)

src/ClientInterface.php

@@ -163,6 +163,13 @@
  * @method int               strlen(string $key)
  * @method int               hdel(string $key, array $fields)
  * @method int               hexists(string $key, string $field)
+ * @method array|null        hexpire(string $key, int $seconds, array $fields, string $flag = null)
+ * @method array|null        hexpireat(string $key, int $unixTimeSeconds, array $fields, string $flag = null)
+ * @method array|null        hexpiretime(string $key, array $fields)
+ * @method array|null        hpersist(string $key, array $fields)
+ * @method array|null        hpexpire(string $key, int $milliseconds, array $fields, string $flag = null)
+ * @method array|null        hpexpireat(string $key, int $unixTimeMilliseconds, array $fields, string $flag = null)
+ * @method array|null        hpexpiretime(string $key, array $fields)
  * @method string|null       hget(string $key, string $field)
  * @method array             hgetall(string $key)
  * @method int               hincrby(string $key, string $field, int $increment)
@@ -175,6 +182,8 @@
  * @method array             hscan(string $key, $cursor, ?array $options = null)
  * @method int               hset(string $key, string $field, string $value)
  * @method int               hsetnx(string $key, string $field, string $value)
+ * @method array|null        httl(string $key, array $fields)
+ * @method array|null        hpttl(string $key, array $fields)
  * @method array             hvals(string $key)
  * @method int               hstrlen(string $key, string $field)
  * @method array             jsonarrappend(string $key, string $path = '$', ...$value)

src/Collection/Iterator/CursorBasedIterator.php

@@ -176,13 +176,13 @@ public function next()
                 $this->fetch();
             }
 
-            if ($this->elements) {
-                $this->extractNext();
-            } elseif ($this->cursor) {
-                goto tryFetch;
-            } else {
-                $this->valid = false;
-            }
+        if ($this->elements) {
+            $this->extractNext();
+        } elseif ($this->cursor) {
+            goto tryFetch;
+        } else {
+            $this->valid = false;
+        }
     }
 
     /**

src/Command/Redis/HEXPIRE.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+use Predis\Command\Command as RedisCommand;
+use UnexpectedValueException;
+
+class HEXPIRE extends RedisCommand
+{
+    /**
+     * @var array
+     */
+    protected $flagsEnum = [
+        'NX', 'XX', 'GT', 'LT',
+    ];
+
+    public function getId()
+    {
+        return 'HEXPIRE';
+    }
+
+    public function setArguments(array $arguments)
+    {
+        $processedArguments = [$arguments[0], $arguments[1]];
+
+        if (array_key_exists(3, $arguments) && null !== $arguments[3]) {
+            if (in_array(strtoupper($arguments[3]), $this->flagsEnum, true)) {
+                $processedArguments[] = strtoupper($arguments[3]);
+            } else {
+                throw new UnexpectedValueException('Unsupported flag value');
+            }
+        }
+
+        if (array_key_exists(2, $arguments) && null !== $arguments[2]) {
+            array_push($processedArguments, 'FIELDS', count($arguments[2]));
+            $processedArguments = array_merge($processedArguments, $arguments[2]);
+        }
+
+        parent::setArguments($processedArguments);
+    }
+}

src/Command/Redis/HEXPIREAT.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+class HEXPIREAT extends HEXPIRE
+{
+    public function getId()
+    {
+        return 'HEXPIREAT';
+    }
+}

src/Command/Redis/HEXPIRETIME.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+use Predis\Command\Command as RedisCommand;
+
+class HEXPIRETIME extends RedisCommand
+{
+    public function getId()
+    {
+        return 'HEXPIRETIME';
+    }
+
+    public function setArguments(array $arguments)
+    {
+        $processedArguments = [$arguments[0], 'FIELDS', count($arguments[1])];
+        $processedArguments = array_merge($processedArguments, $arguments[1]);
+
+        parent::setArguments($processedArguments);
+    }
+}

src/Command/Redis/HPERSIST.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+use Predis\Command\Command as RedisCommand;
+
+class HPERSIST extends RedisCommand
+{
+    public function getId()
+    {
+        return 'HPERSIST';
+    }
+
+    public function setArguments(array $arguments)
+    {
+        $processedArguments = [$arguments[0], 'FIELDS', count($arguments[1])];
+        $processedArguments = array_merge($processedArguments, $arguments[1]);
+
+        parent::setArguments($processedArguments);
+    }
+}

src/Command/Redis/HPEXPIRE.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+class HPEXPIRE extends HEXPIRE
+{
+    public function getId()
+    {
+        return 'HPEXPIRE';
+    }
+}

src/Command/Redis/HPEXPIREAT.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+class HPEXPIREAT extends HEXPIRE
+{
+    public function getId()
+    {
+        return 'HPEXPIREAT';
+    }
+}

src/Command/Redis/HPEXPIRETIME.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+class HPEXPIRETIME extends HEXPIRETIME
+{
+    public function getId()
+    {
+        return 'HPEXPIRETIME';
+    }
+}

src/Command/Redis/HPTTL.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+class HPTTL extends HTTL
+{
+    public function getId()
+    {
+        return 'HPTTL';
+    }
+}

src/Command/Redis/HTTL.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis;
+
+use Predis\Command\Command as RedisCommand;
+
+class HTTL extends RedisCommand
+{
+    public function getId()
+    {
+        return 'HTTL';
+    }
+
+    public function setArguments(array $arguments)
+    {
+        $processedArguments = [$arguments[0], 'FIELDS', count($arguments[1])];
+        $processedArguments = array_merge($processedArguments, $arguments[1]);
+
+        parent::setArguments($processedArguments);
+    }
+}

src/Connection/RelayConnection.php

@@ -57,7 +57,7 @@ class RelayConnection extends StreamConnection
     /**
      * The Relay instance.
      *
-     * @var \Relay\Relay
+     * @var Relay
      */
     protected $client;
 
@@ -151,7 +151,7 @@ protected function assertParameters(ParametersInterface $parameters)
     /**
      * Creates a new instance of the client.
      *
-     * @return \Relay\Relay
+     * @return Relay
      */
     private function createClient()
     {
@@ -189,7 +189,7 @@ private function createClient()
     /**
      * Returns the underlying client.
      *
-     * @return \Relay\Relay
+     * @return Relay
      */
     public function getClient()
     {

src/Pipeline/RelayPipeline.php

@@ -31,7 +31,7 @@ class RelayPipeline extends Pipeline
      */
     protected function executePipeline(ConnectionInterface $connection, SplQueue $commands)
     {
-        /** @var \Predis\Connection\RelayConnection $connection */
+        /** @var RelayConnection $connection */
         $client = $connection->getClient();
 
         $throw = $this->client->getOptions()->exceptions;