mirror of
https://github.com/predis/predis.git
synced 2026-09-01 21:27:46 +00:00
Fix some errors in phpdocs.
[ci skip]
This commit is contained in:
@@ -240,8 +240,8 @@ class Client implements ClientInterface
|
|||||||
* Retrieves the specified connection from the aggregate connection when the
|
* Retrieves the specified connection from the aggregate connection when the
|
||||||
* client is in cluster or replication mode.
|
* client is in cluster or replication mode.
|
||||||
*
|
*
|
||||||
* @param string $connectionID Index or alias of the single connection.
|
* @param string $connectionID Index or alias of the single connection.
|
||||||
* @return SingleConnectionInterface
|
* @return Connection\SingleConnectionInterface
|
||||||
*/
|
*/
|
||||||
public function getConnectionById($connectionID)
|
public function getConnectionById($connectionID)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -59,8 +59,8 @@ abstract class CursorBasedIterator implements Iterator
|
|||||||
* Ensures that the client supports the specified Redis command required to
|
* Ensures that the client supports the specified Redis command required to
|
||||||
* fetch elements from the server to perform the iteration.
|
* fetch elements from the server to perform the iteration.
|
||||||
*
|
*
|
||||||
* @param ClientInterface Client connected to Redis.
|
* @param ClientInterface $client Client connected to Redis.
|
||||||
* @param string $commandID Command ID.
|
* @param string $commandID Command ID.
|
||||||
*/
|
*/
|
||||||
protected function requiredCommand(ClientInterface $client, $commandID)
|
protected function requiredCommand(ClientInterface $client, $commandID)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -65,8 +65,8 @@ class ListKey implements Iterator
|
|||||||
* Ensures that the client instance supports the specified Redis command
|
* Ensures that the client instance supports the specified Redis command
|
||||||
* required to fetch elements from the server to perform the iteration.
|
* required to fetch elements from the server to perform the iteration.
|
||||||
*
|
*
|
||||||
* @param ClientInterface Client connected to Redis.
|
* @param ClientInterface $client Client connected to Redis.
|
||||||
* @param string $commandID Command ID.
|
* @param string $commandID Command ID.
|
||||||
*/
|
*/
|
||||||
protected function requiredCommand(ClientInterface $client, $commandID)
|
protected function requiredCommand(ClientInterface $client, $commandID)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -59,9 +59,7 @@ abstract class Command implements CommandInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the argument from the arguments list at the specified index.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param array $arguments Position of the argument.
|
|
||||||
*/
|
*/
|
||||||
public function getArgument($index)
|
public function getArgument($index)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ class PubSubPubsub extends Command
|
|||||||
/**
|
/**
|
||||||
* Returns the processed response to PUBSUB NUMSUB.
|
* Returns the processed response to PUBSUB NUMSUB.
|
||||||
*
|
*
|
||||||
* @param array List of channels
|
* @param array $channels List of channels
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
protected static function processNumsub(array $channels)
|
protected static function processNumsub(array $channels)
|
||||||
|
|||||||
@@ -46,6 +46,7 @@ class RawCommand implements CommandInterface
|
|||||||
*
|
*
|
||||||
* @param string $commandID Redis command ID.
|
* @param string $commandID Redis command ID.
|
||||||
* @param string ... Arguments list for the command.
|
* @param string ... Arguments list for the command.
|
||||||
|
* @return CommandInterface
|
||||||
*/
|
*/
|
||||||
public static function create($commandID /* [ $arg, ... */)
|
public static function create($commandID /* [ $arg, ... */)
|
||||||
{
|
{
|
||||||
@@ -89,9 +90,7 @@ class RawCommand implements CommandInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the argument from the arguments list at the specified index.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param array $arguments Position of the argument.
|
|
||||||
*/
|
*/
|
||||||
public function getArgument($index)
|
public function getArgument($index)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ class ServerSentinel extends Command
|
|||||||
/**
|
/**
|
||||||
* Returns a processed response to SENTINEL MASTERS or SENTINEL SLAVES.
|
* Returns a processed response to SENTINEL MASTERS or SENTINEL SLAVES.
|
||||||
*
|
*
|
||||||
* @param array List of Redis servers.
|
* @param array $servers List of Redis servers.
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
protected static function processMastersOrSlaves(array $servers)
|
protected static function processMastersOrSlaves(array $servers)
|
||||||
|
|||||||
@@ -50,7 +50,8 @@ abstract class AbstractConnection implements SingleConnectionInterface
|
|||||||
/**
|
/**
|
||||||
* Checks some of the parameters used to initialize the connection.
|
* Checks some of the parameters used to initialize the connection.
|
||||||
*
|
*
|
||||||
* @param ParametersInterface $parameters Initialization parameters for the connection.
|
* @param ParametersInterface $parameters Initialization parameters for the connection.
|
||||||
|
* @return ParametersInterface
|
||||||
*/
|
*/
|
||||||
protected function assertParameters(ParametersInterface $parameters)
|
protected function assertParameters(ParametersInterface $parameters)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ class Parameters implements ParametersInterface
|
|||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param array Named array of connection parameters.
|
* @param array $parameters Named array of connection parameters.
|
||||||
*/
|
*/
|
||||||
public function __construct(array $parameters = array())
|
public function __construct(array $parameters = array())
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -481,7 +481,7 @@ class RedisCluster implements ClusterConnectionInterface, IteratorAggregate, Cou
|
|||||||
* Returns the underlying command hash strategy used to hash commands by
|
* Returns the underlying command hash strategy used to hash commands by
|
||||||
* using keys found in their arguments.
|
* using keys found in their arguments.
|
||||||
*
|
*
|
||||||
* @return ClusterStrategyInterface
|
* @return \Predis\Cluster\StrategyInterface
|
||||||
*/
|
*/
|
||||||
public function getClusterStrategy()
|
public function getClusterStrategy()
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -64,8 +64,8 @@ class ResponseReader implements ResponseReaderInterface
|
|||||||
/**
|
/**
|
||||||
* Returns the response handler associated to a certain type of response.
|
* Returns the response handler associated to a certain type of response.
|
||||||
*
|
*
|
||||||
* @param string $prefix Identifier of the type of response.
|
* @param string $prefix Identifier of the type of response.
|
||||||
* @return ResponseHandlerInterface
|
* @return Handler\ResponseHandlerInterface
|
||||||
*/
|
*/
|
||||||
public function getHandler($prefix)
|
public function getHandler($prefix)
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user