From 9a38d2caec81a67bb3e5015f87ee40e8509d9d8f Mon Sep 17 00:00:00 2001 From: Daniele Alessandri Date: Sun, 22 Dec 2013 14:54:08 +0100 Subject: [PATCH] Move @property-read tags for parameters and options to interfaces. This actually makes sense since whatever the actual implementation is, classes implementing these interfaces should provide at least those properties that are actively used through the library. --- lib/Predis/Configuration/Options.php | 8 -------- lib/Predis/Configuration/OptionsInterface.php | 8 ++++++++ lib/Predis/Connection/Parameters.php | 18 ------------------ lib/Predis/Connection/ParametersInterface.php | 17 +++++++++++++++++ 4 files changed, 25 insertions(+), 26 deletions(-) diff --git a/lib/Predis/Configuration/Options.php b/lib/Predis/Configuration/Options.php index 66e2b28b..ba527cf0 100644 --- a/lib/Predis/Configuration/Options.php +++ b/lib/Predis/Configuration/Options.php @@ -15,14 +15,6 @@ namespace Predis\Configuration; * Manages Predis options with filtering, conversion and lazy initialization of * values using a mini-DI container approach. * - * @property-read mixed aggregate Custom connection aggregator. - * @property-read mixed cluster Aggregate connection for clustering. - * @property-read mixed connections Connection factory. - * @property-read mixed exceptions Toggles exceptions in client for -ERR responses. - * @property-read mixed prefix Key prefixing strategy using the given prefix. - * @property-read mixed profile Server profile. - * @property-read mixed replication Aggregate connection for replication. - * * @author Daniele Alessandri */ class Options implements OptionsInterface diff --git a/lib/Predis/Configuration/OptionsInterface.php b/lib/Predis/Configuration/OptionsInterface.php index 9ce0ddcb..5848fb19 100644 --- a/lib/Predis/Configuration/OptionsInterface.php +++ b/lib/Predis/Configuration/OptionsInterface.php @@ -14,6 +14,14 @@ namespace Predis\Configuration; /** * Defines an options container class. * + * @property-read mixed aggregate Custom connection aggregator. + * @property-read mixed cluster Aggregate connection for clustering. + * @property-read mixed connections Connection factory. + * @property-read mixed exceptions Toggles exceptions in client for -ERR responses. + * @property-read mixed prefix Key prefixing strategy using the given prefix. + * @property-read mixed profile Server profile. + * @property-read mixed replication Aggregate connection for replication. + * * @author Daniele Alessandri */ interface OptionsInterface diff --git a/lib/Predis/Connection/Parameters.php b/lib/Predis/Connection/Parameters.php index 0bc58cff..83441e48 100644 --- a/lib/Predis/Connection/Parameters.php +++ b/lib/Predis/Connection/Parameters.php @@ -16,24 +16,6 @@ use InvalidArgumentException; /** * Connection parameters used to initialize connections to Redis. * - * The actual list of supported connection parameters depends on the features - * supported by each connection backend class (please refer to their specific - * documentation), furthermore developers can pass their own custom parameters. - * - * These are the most common parameters used through the library: - * - * @property-read string scheme Connection scheme, such as 'tcp' or 'unix'. - * @property-read string host IP address or hostname of Redis. - * @property-read int port TCP port on which Redis is listening to. - * @property-read string path Path of a UNIX domain socket file. - * @property-read float timeout Timeout for the connect() operation. - * @property-read float read_write_timeout Timeout for read() and write() operations. - * @property-read bool async_connect Performs the connect() operation asynchronously. - * @property-read bool tcp_nodelay Toggles the Nagle's algorithm for coalescing. - * @property-read bool persistent Leaves the connection open after a GC collection. - * @property-read string password Password to access Redis (see the AUTH command). - * @property-read string database Database index (see the SELECT command). - * * @author Daniele Alessandri */ class Parameters implements ParametersInterface diff --git a/lib/Predis/Connection/ParametersInterface.php b/lib/Predis/Connection/ParametersInterface.php index 4fb1d2b5..faa9c60c 100644 --- a/lib/Predis/Connection/ParametersInterface.php +++ b/lib/Predis/Connection/ParametersInterface.php @@ -14,6 +14,23 @@ namespace Predis\Connection; /** * Interface for classes providing their own logic for connection parameters. * + * The actual list of connection parameters depends on the features supported by + * each connection backend class (please refer to their specific documentation), + * but the most common parameters used through the library are: + * + * @property-read string scheme Connection scheme, such as 'tcp' or 'unix'. + * @property-read string host IP address or hostname of Redis. + * @property-read int port TCP port on which Redis is listening to. + * @property-read string path Path of a UNIX domain socket file. + * @property-read string alias Alias for the connection. + * @property-read float timeout Timeout for the connect() operation. + * @property-read float read_write_timeout Timeout for read() and write() operations. + * @property-read bool async_connect Performs the connect() operation asynchronously. + * @property-read bool tcp_nodelay Toggles the Nagle's algorithm for coalescing. + * @property-read bool persistent Leaves the connection open after a GC collection. + * @property-read string password Password to access Redis (see the AUTH command). + * @property-read string database Database index (see the SELECT command). + * * @author Daniele Alessandri */ interface ParametersInterface