Merge pull request #2388 from phpredis/issue-2385

yatsukhnenko · web-flow · commit 3eb60f58c1b6 · 2023-09-20T22:08:33.000+03:00
Fix unknown expiration modifier warning when null argument passed
diff --git a/redis.stub.php b/redis.stub.php
@@ -1091,8 +1091,9 @@ public function exists(mixed $key, mixed ...$other_keys): Redis|int|bool;
      * redis-server >= 7.0.0 you may send an additional "mode" argument which
      * modifies how the command will execute.
      *
-     * @param string  $key  The key to set an expiration on.
-     * @param string  $mode A two character modifier that changes how the
+     * @param string      $key  The key to set an expiration on.
+     * @param int         $timeout  The number of seconds after which key will be automatically deleted.
+     * @param string|null $mode  A two character modifier that changes how the
      *                      command works.
      *                      <code>
      *                      NX - Set expiry only if key has no expiry
@@ -1122,9 +1123,9 @@ public function expire(string $key, int $timeout, ?string $mode = null): Redis|b
     /**
      * Set a key to expire at an exact unix timestamp.
      *
-     * @param string $key The key to set an expiration on.
-     * @param int $timestamp The unix timestamp to expire at.
-     * @param string $mode An option 'mode' that modifies how the command acts (see {@link Redis::expire}).
+     * @param string      $key The key to set an expiration on.
+     * @param int         $timestamp The unix timestamp to expire at.
+     * @param string|null $mode An option 'mode' that modifies how the command acts (see {@link Redis::expire}).
      * @return Redis|bool True if an expiration was set, false if not.
      *
      * @see https://redis.io/commands/expireat
@@ -2256,8 +2257,9 @@ public function persist(string $key): Redis|bool;
      *
      *  @see Redis::expire() for a description of the mode argument.
      *
-     *  @param string  $key  The key to set an expiration on.
-     *  @param string $mode  A two character modifier that changes how the
+     *  @param string      $key  The key to set an expiration on.
+     *  @param int         $timeout  The number of milliseconds after which key will be automatically deleted.
+     *  @param string|null $mode  A two character modifier that changes how the
      *                       command works.
      *
      *  @return Redis|bool   True if an expiry was set on the key, and false otherwise.
@@ -2270,8 +2272,9 @@ public function pexpire(string $key, int $timeout, ?string $mode = null): bool;
      *
      * @see Redis::expire() For a description of the mode argument.
      *
-     *  @param string  $key  The key to set an expiration on.
-     *  @param string  $mode A two character modifier that changes how the
+     *  @param string      $key  The key to set an expiration on.
+     *  @param int         $timestamp The unix timestamp to expire at.
+     *  @param string|null $mode A two character modifier that changes how the
      *                       command works.
      *
      *  @return Redis|bool   True if an expiration was set on the key, false otherwise.
diff --git a/redis_commands.c b/redis_commands.c
@@ -6002,7 +6002,7 @@ int redis_expire_cmd(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock,
         Z_PARAM_STR(key)
         Z_PARAM_LONG(timeout)
         Z_PARAM_OPTIONAL
-        Z_PARAM_STR(mode)
+        Z_PARAM_STR_OR_NULL(mode)
     ZEND_PARSE_PARAMETERS_END_EX(return FAILURE);
 
     if (mode != NULL && !(zend_string_equals_literal_ci(mode, "NX") ||

Original file line number	Diff line number	Diff line change
`@@ -1091,8 +1091,9 @@ public function exists(mixed $key, mixed ...$other_keys): Redis\|int\|bool;`
`1091`	`1091`	`* redis-server >= 7.0.0 you may send an additional "mode" argument which`
`1092`	`1092`	`* modifies how the command will execute.`
`1093`	`1093`	`*`
`1094`		`- * @param string $key The key to set an expiration on.`
`1095`		`- * @param string $mode A two character modifier that changes how the`
	`1094`	`+ * @param string $key The key to set an expiration on.`
	`1095`	`+ * @param int $timeout The number of seconds after which key will be automatically deleted.`
	`1096`	`+ * @param string\|null $mode A two character modifier that changes how the`
`1096`	`1097`	`* command works.`
`1097`	`1098`	`* <code>`
`1098`	`1099`	`* NX - Set expiry only if key has no expiry`
`@@ -1122,9 +1123,9 @@ public function expire(string $key, int $timeout, ?string $mode = null): Redis\|b`
`1122`	`1123`	`/**`
`1123`	`1124`	`* Set a key to expire at an exact unix timestamp.`
`1124`	`1125`	`*`
`1125`		`- * @param string $key The key to set an expiration on.`
`1126`		`- * @param int $timestamp The unix timestamp to expire at.`
`1127`		`- * @param string $mode An option 'mode' that modifies how the command acts (see {@link Redis::expire}).`
	`1126`	`+ * @param string $key The key to set an expiration on.`
	`1127`	`+ * @param int $timestamp The unix timestamp to expire at.`
	`1128`	`+ * @param string\|null $mode An option 'mode' that modifies how the command acts (see {@link Redis::expire}).`
`1128`	`1129`	`* @return Redis\|bool True if an expiration was set, false if not.`
`1129`	`1130`	`*`
`1130`	`1131`	`* @see https://redis.io/commands/expireat`
`@@ -2256,8 +2257,9 @@ public function persist(string $key): Redis\|bool;`
`2256`	`2257`	`*`
`2257`	`2258`	`* @see Redis::expire() for a description of the mode argument.`
`2258`	`2259`	`*`
`2259`		`- * @param string $key The key to set an expiration on.`
`2260`		`- * @param string $mode A two character modifier that changes how the`
	`2260`	`+ * @param string $key The key to set an expiration on.`
	`2261`	`+ * @param int $timeout The number of milliseconds after which key will be automatically deleted.`
	`2262`	`+ * @param string\|null $mode A two character modifier that changes how the`
`2261`	`2263`	`* command works.`
`2262`	`2264`	`*`
`2263`	`2265`	`* @return Redis\|bool True if an expiry was set on the key, and false otherwise.`
`@@ -2270,8 +2272,9 @@ public function pexpire(string $key, int $timeout, ?string $mode = null): bool;`
`2270`	`2272`	`*`
`2271`	`2273`	`* @see Redis::expire() For a description of the mode argument.`
`2272`	`2274`	`*`
`2273`		`- * @param string $key The key to set an expiration on.`
`2274`		`- * @param string $mode A two character modifier that changes how the`
	`2275`	`+ * @param string $key The key to set an expiration on.`
	`2276`	`+ * @param int $timestamp The unix timestamp to expire at.`
	`2277`	`+ * @param string\|null $mode A two character modifier that changes how the`
`2275`	`2278`	`* command works.`
`2276`	`2279`	`*`
`2277`	`2280`	`* @return Redis\|bool True if an expiration was set on the key, false otherwise.`