geckon01/predis
1
0
Fork 0
mirror of https://github.com/predis/predis.git synced 2026-08-24 19:19:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move @property-read tags for parameters and options to interfaces.

Browse Source 
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.
This commit is contained in:
Daniele Alessandri
2013-12-22 14:54:08 +01:00
parent cfa456fdd1
commit 9a38d2caec
4 changed files with 25 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/Predis/Configuration/Options.php
-8
View File
@@ -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 <suppakilla@gmail.com>
*/
class Options implements OptionsInterface
lib/Predis/Configuration/OptionsInterface.php
+8
View File
@@ -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 <suppakilla@gmail.com>
*/
interface OptionsInterface
lib/Predis/Connection/Parameters.php
-18
View File
@@ -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 <suppakilla@gmail.com>
*/
class Parameters implements ParametersInterface
lib/Predis/Connection/ParametersInterface.php
+17
View File
@@ -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 <suppakilla@gmail.com>
*/
interface ParametersInterface