Browse Source

Rename certain connection parameters usig shorter names.

  - `connection_async` is now `async_connect`
  - `connection_timeout` is now `timeout`
  - `connection_persistent` is now `persistent`
Daniele Alessandri 13 years ago
parent
commit
890ace8565

+ 6 - 0
CHANGELOG.md

@@ -5,6 +5,12 @@ v0.8.0 (201x-xx-xx)
   inspired by the Symfony2 naming conventions. See `CHANGELOG.NAMING.md` for
   more details about these changes.
 
+- Certain connection parameters have been renamed:
+
+  - `connection_async` is now `async_connect`
+  - `connection_timeout` is now `timeout`
+  - `connection_persistent` is now `persistent`
+
 - Cluster and replication connections now extend a new common interface,
   `Predis\Connection\AggregatedConnectionInterface`.
 

+ 3 - 3
lib/Predis/Connection/PhpiredisConnection.php

@@ -76,8 +76,8 @@ class PhpiredisConnection extends AbstractConnection
         if ($parameters->isSetByUser('iterable_multibulk')) {
             $this->onInvalidOption('iterable_multibulk', $parameters);
         }
-        if ($parameters->isSetByUser('connection_persistent')) {
-            $this->onInvalidOption('connection_persistent', $parameters);
+        if ($parameters->isSetByUser('persistent')) {
+            $this->onInvalidOption('persistent', $parameters);
         }
 
         return parent::checkParameters($parameters);
@@ -275,7 +275,7 @@ class PhpiredisConnection extends AbstractConnection
         $null = null;
         $selectable = array($socket);
 
-        $timeout = $parameters->connection_timeout;
+        $timeout = $parameters->timeout;
         $timeoutSecs = floor($timeout);
         $timeoutUSecs = ($timeout - $timeoutSecs) * 1000000;
 

+ 6 - 6
lib/Predis/Connection/StreamConnection.php

@@ -36,7 +36,7 @@ class StreamConnection extends AbstractConnection
      */
     public function __destruct()
     {
-        if (!$this->parameters->connection_persistent) {
+        if (!$this->parameters->persistent) {
             $this->disconnect();
         }
     }
@@ -72,15 +72,15 @@ class StreamConnection extends AbstractConnection
         $uri = "tcp://{$parameters->host}:{$parameters->port}/";
 
         $flags = STREAM_CLIENT_CONNECT;
-        if ($parameters->connection_async) {
+        if ($parameters->async_connect) {
             $flags |= STREAM_CLIENT_ASYNC_CONNECT;
         }
-        if ($parameters->connection_persistent) {
+        if ($parameters->persistent) {
             $flags |= STREAM_CLIENT_PERSISTENT;
         }
 
         $resource = @stream_socket_client(
-            $uri, $errno, $errstr, $parameters->connection_timeout, $flags
+            $uri, $errno, $errstr, $parameters->timeout, $flags
         );
 
         if (!$resource) {
@@ -109,12 +109,12 @@ class StreamConnection extends AbstractConnection
         $uri = "unix://{$parameters->path}";
 
         $flags = STREAM_CLIENT_CONNECT;
-        if ($parameters->connection_persistent) {
+        if ($parameters->persistent) {
             $flags |= STREAM_CLIENT_PERSISTENT;
         }
 
         $resource = @stream_socket_client(
-            $uri, $errno, $errstr, $parameters->connection_timeout, $flags
+            $uri, $errno, $errstr, $parameters->timeout, $flags
         );
 
         if (!$resource) {

+ 1 - 1
lib/Predis/Connection/WebdisConnection.php

@@ -102,7 +102,7 @@ class WebdisConnection implements SingleConnectionInterface
     {
         $options = array(
             CURLOPT_FAILONERROR => true,
-            CURLOPT_CONNECTTIMEOUT_MS => $parameters->connection_timeout * 1000,
+            CURLOPT_CONNECTTIMEOUT_MS => $parameters->timeout * 1000,
             CURLOPT_URL => "{$parameters->scheme}://{$parameters->host}:{$parameters->port}",
             CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
             CURLOPT_POST => true,

+ 6 - 6
lib/Predis/ConnectionParameters.php

@@ -53,9 +53,9 @@ class ConnectionParameters implements ConnectionParametersInterface
                 'port' => 6379,
                 'database' => null,
                 'password' => null,
-                'connection_async' => false,
-                'connection_persistent' => false,
-                'connection_timeout' => 5.0,
+                'async_connect' => false,
+                'persistent' => false,
+                'timeout' => 5.0,
                 'read_write_timeout' => null,
                 'alias' => null,
                 'weight' => null,
@@ -72,9 +72,9 @@ class ConnectionParameters implements ConnectionParametersInterface
 
             self::$validators = array(
                 'port' => $int,
-                'connection_async' => $bool,
-                'connection_persistent' => $bool,
-                'connection_timeout' => $float,
+                'async_connect' => $bool,
+                'persistent' => $bool,
+                'timeout' => $float,
                 'read_write_timeout' => $float,
                 'iterable_multibulk' => $bool,
                 'throw_errors' => $bool,

+ 2 - 2
tests/PHPUnit/ConnectionTestCase.php

@@ -28,7 +28,7 @@ abstract class ConnectionTestCase extends StandardTestCase
      */
     public function testThrowExceptionWhenUnableToConnect()
     {
-        $parameters = array('host' => '169.254.10.10', 'connection_timeout' => 0.5);
+        $parameters = array('host' => '169.254.10.10', 'timeout' => 0.5);
         $connection = $this->getConnection($profile, false, $parameters);
         $connection->executeCommand($this->getProfile()->createCommand('ping'));
     }
@@ -313,7 +313,7 @@ abstract class ConnectionTestCase extends StandardTestCase
      */
     public function testThrowsExceptionOnConnectionTimeout()
     {
-        $connection = $this->getConnection($_, false, array('host' => '169.254.10.10', 'connection_timeout' => 0.5));
+        $connection = $this->getConnection($_, false, array('host' => '169.254.10.10', 'timeout' => 0.5));
 
         $connection->connect();
     }

+ 6 - 6
tests/Predis/ConnectionParametersTest.php

@@ -32,9 +32,9 @@ class ConnectionParametersTest extends StandardTestCase
         $this->assertEquals($defaults['port'], $parameters->port);
         $this->assertEquals($defaults['throw_errors'], $parameters->throw_errors);
         $this->assertEquals($defaults['iterable_multibulk'], $parameters->iterable_multibulk);
-        $this->assertEquals($defaults['connection_async'], $parameters->connection_async);
-        $this->assertEquals($defaults['connection_persistent'], $parameters->connection_persistent);
-        $this->assertEquals($defaults['connection_timeout'], $parameters->connection_timeout);
+        $this->assertEquals($defaults['async_connect'], $parameters->async_connect);
+        $this->assertEquals($defaults['persistent'], $parameters->persistent);
+        $this->assertEquals($defaults['timeout'], $parameters->timeout);
         $this->assertEquals($defaults['read_write_timeout'], $parameters->read_write_timeout);
         $this->assertEquals($defaults['database'], $parameters->database);
         $this->assertEquals($defaults['password'], $parameters->password);
@@ -175,9 +175,9 @@ class ConnectionParametersTest extends StandardTestCase
             'port' => 6379,
             'database' => null,
             'password' => null,
-            'connection_async' => false,
-            'connection_persistent' => false,
-            'connection_timeout' => 5.0,
+            'async_connect' => false,
+            'persistent' => false,
+            'timeout' => 5.0,
             'read_write_timeout' => null,
             'alias' => null,
             'weight' => null,