• Home
• Predis
• Client

PHP Class Predis\Client

Show file Open project: nrk/predis Class Usage Examples

Public Methods

Method	Description
__call ( $commandID, $arguments )
__construct ( mixed $parameters = null, mixed $options = null )
connect ( )	Opens the underlying connection and connects to the server.
createCommand ( $commandID, $arguments = [] )
disconnect ( )	Closes the underlying connection and disconnects from the server.
executeCommand ( Predis\Command\CommandInterface $command )
executeRaw ( array $arguments, boolean &$error = null ) : mixed	Executes a command without filtering its arguments, parsing the response, applying any prefix to keys or throwing exceptions on Redis errors even regardless of client options.
getClientBy ( string $selector, string $value, callable | null $callable = null ) : predis\ClientInterface | mixed	Creates a new client from the specified .
getCommandFactory ( )
getConnection ( )
getIterator ( )
getOptions ( )
isConnected ( ) : boolean	Returns the current state of the underlying connection.
monitor ( ) : Consumer	Creates a new monitor consumer and returns it.
pipeline ( ) : Pipeline | array	Creates a new pipeline context and returns it, or returns the results of a pipeline executed inside the optionally provided callable object.
pubSubLoop ( ) : Consumer | null	Creates a new publish/subscribe context and returns it, or starts its loop inside the optionally provided callable object.
quit ( )	Closes the underlying connection and disconnects from the server.
transaction ( ) : MultiExec | array	Creates a new transaction context and returns it, or returns the results of a transaction executed inside the optionally provided callable object.

Protected Methods

Method	Description
createAggregateConnection ( mixed $parameters, string $option ) : Closure	Creates an aggregate connection.
createConnection ( mixed $parameters ) : Predis\Connection\ConnectionInterface	Creates single or aggregate connections from different types of arguments (string, array) or returns the passed argument if it is an instance of a class implementing Predis\Connection\ConnectionInterface.
createOptions ( mixed $options ) : Predis\Configuration\OptionsInterface	Creates a new instance of Predis\Configuration\Options from different types of arguments or simply returns the passed argument if it is an instance of Predis\Configuration\OptionsInterface.
createPipeline ( array $options = null, mixed $callable = null ) : Pipeline | array	Actual pipeline context initializer method.
createPubSub ( array $options = null, mixed $callable = null ) : Consumer | null	Actual publish/subscribe context initializer method.
createTransaction ( array $options = null, mixed $callable = null ) : MultiExec | array	Actual transaction context initializer method.
onErrorResponse ( Predis\Command\CommandInterface $command, Predis\Response\ErrorInterface $response ) : mixed	Handles -ERR responses returned by Redis.

Private Methods

Method	Description
sharedContextFactory ( string $initializer, array $argv = null ) : mixed	Executes the specified initializer method on $this by adjusting the actual invokation depending on the arity (0, 1 or 2 arguments). This is simply an utility method to create Redis contexts instances since they follow a common initialization path.

Method Details