mirror of
https://github.com/predis/predis.git
synced 2026-08-22 10:31:10 +00:00
Daniele Alessandri
9a38d2caec
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.
61 lines
2.2 KiB
PHP
61 lines
2.2 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Predis package.
|
|
*
|
|
* (c) Daniele Alessandri <suppakilla@gmail.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
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
|
|
{
|
|
/**
|
|
* Checks if the specified parameters is set.
|
|
*
|
|
* @param string $parameter Name of the parameter.
|
|
* @return bool
|
|
*/
|
|
public function __isset($parameter);
|
|
|
|
/**
|
|
* Returns the value of the specified parameter.
|
|
*
|
|
* @param string $parameter Name of the parameter.
|
|
* @return mixed
|
|
*/
|
|
public function __get($parameter);
|
|
|
|
/**
|
|
* Returns an array representation of the connection parameters.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function toArray();
|
|
}
|