Merge pull request phpredis#2010 from phpredis/ctor-options

Redis::__construct options

Author: yatsukhnenko

README.markdown

@@ -158,6 +158,32 @@ _**Description**_: Creates a Redis client
 $redis = new Redis();
 ~~~
 
+Starting from version 6.0.0 it's possible to specify configuration options.
+This allows to connect to the server without explicitly invoking `connect` command.
+
+##### *Example*
+
+~~~php
+$redis = new Redis([
+    'host' => '127.0.0.1',
+    'port' => 6379,
+    'connectTimeout' => 2.5,
+    'auth' => ['phpredis', 'phpredis'],
+    'ssl' => ['verify_peer' => false],
+]);
+~~~
+
+##### *Parameters*
+
+*host*: string. can be a host, or the path to a unix domain socket.
+*port*: int
+*connectTimeout*: float, value in seconds (default is 0 meaning unlimited)
+*retryInterval*: int, value in milliseconds (optional)
+*readTimeout*: float, value in seconds (default is 0 meaning unlimited)
+*persistent*: mixed, if value is string then it used as persistend id, else value casts to boolean
+*auth*: mixed, authentication information
+*ssl*: array, SSL context options
+
 ### Class RedisException
 -----
 phpredis throws a [RedisException](#class-redisexception) object if it can't reach the Redis server. That can happen in case of connectivity issues,

redis.c

@@ -601,12 +601,79 @@ PHP_MINFO_FUNCTION(redis)
     DISPLAY_INI_ENTRIES();
 }
 
-/* {{{ proto Redis Redis::__construct()
+/* {{{ proto Redis Redis::__construct(array $options = null)
     Public constructor */
 PHP_METHOD(Redis, __construct)
 {
-    if (zend_parse_parameters_none() == FAILURE) {
-        RETURN_FALSE;
+    redis_object *redis;
+    zend_string *zkey;
+    zval *val, *opts = NULL;
+
+    if (zend_parse_parameters(ZEND_NUM_ARGS(), "|a", &opts) == FAILURE) {
+        RETURN_THROWS();
+    }
+
+    if (opts != NULL) {
+        redis = PHPREDIS_ZVAL_GET_OBJECT(redis_object, getThis());
+        redis->sock = redis_sock_create("127.0.0.1", 0, 6379, 0, 0, 0, NULL, 0);
+
+        ZEND_HASH_FOREACH_STR_KEY_VAL(Z_ARRVAL_P(opts), zkey, val) {
+            ZVAL_DEREF(val);
+            if (zend_string_equals_literal_ci(zkey, "host")) {
+                if (Z_TYPE_P(val) != IS_STRING) {
+                    REDIS_VALUE_EXCEPTION("Invalid host");
+                    RETURN_THROWS();
+                }
+                zend_string_release(redis->sock->host);
+                redis->sock->host = zval_get_string(val);
+            } else if (zend_string_equals_literal_ci(zkey, "port")) {
+                if (Z_TYPE_P(val) != IS_LONG) {
+                    REDIS_VALUE_EXCEPTION("Invalid port");
+                    RETURN_THROWS();
+                }
+                redis->sock->port = zval_get_long(val);
+            } else if (zend_string_equals_literal_ci(zkey, "connectTimeout")) {
+                if (Z_TYPE_P(val) != IS_LONG && Z_TYPE_P(val) != IS_DOUBLE) {
+                    REDIS_VALUE_EXCEPTION("Invalid connect timeout");
+                    RETURN_THROWS();
+                }
+                redis->sock->timeout = zval_get_double(val);
+            } else if (zend_string_equals_literal_ci(zkey, "readTimeout")) {
+                if (Z_TYPE_P(val) != IS_LONG && Z_TYPE_P(val) != IS_DOUBLE) {
+                    REDIS_VALUE_EXCEPTION("Invalid read timeout");
+                    RETURN_THROWS();
+                }
+                redis->sock->read_timeout = zval_get_double(val);
+            } else if (zend_string_equals_literal_ci(zkey, "persistent")) {
+                if (Z_TYPE_P(val) == IS_STRING) {
+                    if (redis->sock->persistent_id) zend_string_release(redis->sock->persistent_id);
+                    redis->sock->persistent_id = zval_get_string(val);
+                    redis->sock->persistent = 1;
+                } else {
+                    redis->sock->persistent = zval_is_true(val);
+                }
+            } else if (zend_string_equals_literal_ci(zkey, "retryInterval")) {
+                if (Z_TYPE_P(val) != IS_LONG && Z_TYPE_P(val) != IS_DOUBLE) {
+                    REDIS_VALUE_EXCEPTION("Invalid retry interval");
+                    RETURN_THROWS();
+                }
+                redis->sock->retry_interval = zval_get_long(val);
+            } else if (zend_string_equals_literal_ci(zkey, "ssl")) {
+                if (Z_TYPE_P(val) != IS_ARRAY) {
+                    REDIS_VALUE_EXCEPTION("Invalid SSL context options");
+                    RETURN_THROWS();
+                }
+                redis_sock_set_stream_context(redis->sock, val);
+            } else if (zend_string_equals_literal_ci(zkey, "auth")) {
+                if (Z_TYPE_P(val) != IS_STRING && Z_TYPE_P(val) != IS_ARRAY) {
+                    REDIS_VALUE_EXCEPTION("Invalid auth credentials");
+                    RETURN_THROWS();
+                }
+                redis_sock_set_auth_zval(redis->sock, val);
+            } else {
+                php_error_docref(NULL, E_WARNING, "Skip unknown option '%s'", ZSTR_VAL(zkey));
+            }
+        } ZEND_HASH_FOREACH_END();
     }
 }
 /* }}} */

redis.stub.php

@@ -7,7 +7,7 @@
 
 class Redis {
 
-    public function __construct();
+    public function __construct(array $options = null);
 
     public function _compress(string $value): string;
 

redis_arginfo.h

@@ -1,14 +1,16 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: d32b3d0f25155fa5d5f1c9626bbf3f4bcfdf75ae */
+ * Stub hash: fb1a3f1245758210548e5ed11543fe059e6e8770 */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___construct, 0, 0, 0)
+	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, options, IS_ARRAY, 0, "null")
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Redis__compress, 0, 1, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, value, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis___destruct arginfo_class_Redis___construct
+ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___destruct, 0, 0, 0)
+ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Redis__pack, 0, 1, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, value, IS_MIXED, 0)
@@ -521,7 +523,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_rPop arginfo_class_Redis_decr
 
-#define arginfo_class_Redis_randomKey arginfo_class_Redis___construct
+#define arginfo_class_Redis_randomKey arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Redis_rawcommand, 0, 1, IS_MIXED, 0)
 	ZEND_ARG_TYPE_INFO(0, command, IS_STRING, 0)
@@ -708,7 +710,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_unsubscribe arginfo_class_Redis_subscribe
 
-#define arginfo_class_Redis_unwatch arginfo_class_Redis___construct
+#define arginfo_class_Redis_unwatch arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_watch arginfo_class_Redis_del
 

redis_legacy_arginfo.h

@@ -1,14 +1,16 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: d32b3d0f25155fa5d5f1c9626bbf3f4bcfdf75ae */
+ * Stub hash: fb1a3f1245758210548e5ed11543fe059e6e8770 */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___construct, 0, 0, 0)
+	ZEND_ARG_INFO(0, options)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis__compress, 0, 0, 1)
 	ZEND_ARG_INFO(0, value)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis___destruct arginfo_class_Redis___construct
+ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___destruct, 0, 0, 0)
+ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis__pack arginfo_class_Redis__compress
 
@@ -38,9 +40,9 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_auth, 0, 0, 1)
 	ZEND_ARG_INFO(0, credentials)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_bgSave arginfo_class_Redis___construct
+#define arginfo_class_Redis_bgSave arginfo_class_Redis___destruct
 
-#define arginfo_class_Redis_bgrewriteaof arginfo_class_Redis___construct
+#define arginfo_class_Redis_bgrewriteaof arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_bitcount, 0, 0, 1)
 	ZEND_ARG_INFO(0, key)
@@ -80,14 +82,14 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_bzPopMin arginfo_class_Redis_blPop
 
-#define arginfo_class_Redis_clearLastError arginfo_class_Redis___construct
+#define arginfo_class_Redis_clearLastError arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_client, 0, 0, 1)
 	ZEND_ARG_INFO(0, opt)
 	ZEND_ARG_INFO(0, arg)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_close arginfo_class_Redis___construct
+#define arginfo_class_Redis_close arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_command, 0, 0, 2)
 	ZEND_ARG_INFO(0, opt)
@@ -116,7 +118,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_copy, 0, 0, 2)
 	ZEND_ARG_INFO(0, options)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_dbSize arginfo_class_Redis___construct
+#define arginfo_class_Redis_dbSize arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_debug arginfo_class_Redis__prefix
 
@@ -131,7 +133,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_delete arginfo_class_Redis_del
 
-#define arginfo_class_Redis_discard arginfo_class_Redis___construct
+#define arginfo_class_Redis_discard arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_dump arginfo_class_Redis__prefix
 
@@ -151,7 +153,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_evalsha, 0, 0, 1)
 	ZEND_ARG_INFO(0, num_keys)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_exec arginfo_class_Redis___construct
+#define arginfo_class_Redis_exec arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_exists arginfo_class_Redis__prefix
 
@@ -217,40 +219,40 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_get arginfo_class_Redis__prefix
 
-#define arginfo_class_Redis_getAuth arginfo_class_Redis___construct
+#define arginfo_class_Redis_getAuth arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_getBit, 0, 0, 2)
 	ZEND_ARG_INFO(0, key)
 	ZEND_ARG_INFO(0, idx)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_getDBNum arginfo_class_Redis___construct
+#define arginfo_class_Redis_getDBNum arginfo_class_Redis___destruct
 
-#define arginfo_class_Redis_getHost arginfo_class_Redis___construct
+#define arginfo_class_Redis_getHost arginfo_class_Redis___destruct
 
-#define arginfo_class_Redis_getLastError arginfo_class_Redis___construct
+#define arginfo_class_Redis_getLastError arginfo_class_Redis___destruct
 
-#define arginfo_class_Redis_getMode arginfo_class_Redis___construct
+#define arginfo_class_Redis_getMode arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_getOption, 0, 0, 1)
 	ZEND_ARG_INFO(0, option)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_getPersistentID arginfo_class_Redis___construct
+#define arginfo_class_Redis_getPersistentID arginfo_class_Redis___destruct
 
-#define arginfo_class_Redis_getPort arginfo_class_Redis___construct
+#define arginfo_class_Redis_getPort arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_getRange, 0, 0, 3)
 	ZEND_ARG_INFO(0, key)
 	ZEND_ARG_INFO(0, start)
 	ZEND_ARG_INFO(0, end)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_getReadTimeout arginfo_class_Redis___construct
+#define arginfo_class_Redis_getReadTimeout arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_getset arginfo_class_Redis_append
 
-#define arginfo_class_Redis_getTimeout arginfo_class_Redis___construct
+#define arginfo_class_Redis_getTimeout arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_hDel arginfo_class_Redis_geohash
 
@@ -310,7 +312,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_info, 0, 0, 0)
 	ZEND_ARG_INFO(0, opt)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_isConnected arginfo_class_Redis___construct
+#define arginfo_class_Redis_isConnected arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_keys, 0, 0, 1)
 	ZEND_ARG_INFO(0, pattern)
@@ -351,7 +353,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_lSet, 0, 0, 3)
 	ZEND_ARG_INFO(0, value)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_lastSave arginfo_class_Redis___construct
+#define arginfo_class_Redis_lastSave arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_lindex, 0, 0, 2)
 	ZEND_ARG_INFO(0, key)
@@ -425,7 +427,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_ping, 0, 0, 0)
 	ZEND_ARG_INFO(0, key)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_pipeline arginfo_class_Redis___construct
+#define arginfo_class_Redis_pipeline arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_popen arginfo_class_Redis_connect
 
@@ -455,7 +457,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_rPop arginfo_class_Redis__prefix
 
-#define arginfo_class_Redis_randomKey arginfo_class_Redis___construct
+#define arginfo_class_Redis_randomKey arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_rawcommand, 0, 0, 1)
 	ZEND_ARG_INFO(0, command)
@@ -475,7 +477,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_restore, 0, 0, 3)
 	ZEND_ARG_INFO(0, value)
 ZEND_END_ARG_INFO()
 
-#define arginfo_class_Redis_role arginfo_class_Redis___construct
+#define arginfo_class_Redis_role arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_rpoplpush, 0, 0, 2)
 	ZEND_ARG_INFO(0, src)
@@ -526,7 +528,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_sUnionStore arginfo_class_Redis_sDiffStore
 
-#define arginfo_class_Redis_save arginfo_class_Redis___construct
+#define arginfo_class_Redis_save arginfo_class_Redis___destruct
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis_scan, 0, 0, 1)
 	ZEND_ARG_INFO(1, iterator)
@@ -614,7 +616,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_swapdb arginfo_class_Redis_rpoplpush
 
-#define arginfo_class_Redis_time arginfo_class_Redis___construct
+#define arginfo_class_Redis_time arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_ttl arginfo_class_Redis__prefix
 
@@ -624,7 +626,7 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_Redis_unsubscribe arginfo_class_Redis_subscribe
 
-#define arginfo_class_Redis_unwatch arginfo_class_Redis___construct
+#define arginfo_class_Redis_unwatch arginfo_class_Redis___destruct
 
 #define arginfo_class_Redis_watch arginfo_class_Redis_del
 

tests/RedisTest.php

@@ -104,9 +104,10 @@ protected function getFullHostPath()
     }
 
     protected function newInstance() {
-        $r = new Redis();
-
-        $r->connect($this->getHost(), $this->getPort());
+        $r = new Redis([
+            'host' => $this->getHost(),
+            'port' => $this->getPort(),
+        ]);
 
         if($this->getAuth()) {
             $this->assertTrue($r->auth($this->getAuth()));