Clarify RedisCluster multi docs.

Fixes #2432
This commit is contained in:
michael-grunder
2024-03-28 13:34:39 -07:00
parent b698901818
commit 828dc11c98
3 changed files with 17 additions and 6 deletions

View File

@@ -636,7 +636,18 @@ class RedisCluster {
/* We only support Redis::MULTI in RedisCluster but take the argument
so we can test MULTI..EXEC with RedisTest.php and in the event
we add pipeline support in the future. */
public function multi(int $value = Redis::MULTI): RedisCluster|bool;
/**
* @see Redis::multi
*
* @param int $mode The mode to use, although `Redis::MULTI` is the only mode supported in `RedisCluster`.`
* @return RedisCluster|false
*
* Unlike `Redis`, if you call `multi()` when already in multi modce, this function will return false and
* display a warning.
*
*/
public function multi(int $mode = Redis::MULTI): RedisCluster|false;
/**
* @see Redis::object

View File

@@ -1,5 +1,5 @@
/* This is a generated file, edit the .stub.php file instead.
* Stub hash: c19108e54b637b6c76a529c1285104a0c38da220 */
* Stub hash: 224e043037f1cc3c682bbeaa57dc04be51eb946e */
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster___construct, 0, 0, 1)
ZEND_ARG_TYPE_INFO(0, name, IS_STRING, 1)
@@ -536,8 +536,8 @@ ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_msetnx, 0
ZEND_ARG_TYPE_INFO(0, key_values, IS_ARRAY, 0)
ZEND_END_ARG_INFO()
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_multi, 0, 0, RedisCluster, MAY_BE_BOOL)
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, value, IS_LONG, 0, "Redis::MULTI")
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_multi, 0, 0, RedisCluster, MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, mode, IS_LONG, 0, "Redis::MULTI")
ZEND_END_ARG_INFO()
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_class_RedisCluster_object, 0, 2, RedisCluster, MAY_BE_LONG|MAY_BE_STRING|MAY_BE_FALSE)

View File

@@ -1,5 +1,5 @@
/* This is a generated file, edit the .stub.php file instead.
* Stub hash: c19108e54b637b6c76a529c1285104a0c38da220 */
* Stub hash: 224e043037f1cc3c682bbeaa57dc04be51eb946e */
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster___construct, 0, 0, 1)
ZEND_ARG_INFO(0, name)
@@ -458,7 +458,7 @@ ZEND_END_ARG_INFO()
#define arginfo_class_RedisCluster_msetnx arginfo_class_RedisCluster_mset
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_multi, 0, 0, 0)
ZEND_ARG_INFO(0, value)
ZEND_ARG_INFO(0, mode)
ZEND_END_ARG_INFO()
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_RedisCluster_object, 0, 0, 2)