PHP Класс Credis_Client

Server/Connection:
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$authPassword string
$closeOnDestruct boolean
$commandNames array
$commands string
$connectFailures integer
$connected boolean
$host string Host of the Redis server
$isMulti boolean
$isWatching boolean
$maxConnectRetries integer
$persistent string Unique identifier for persistent connections
$port integer Port on which the Redis server is running
$readTimeout float Timeout for reading response from Redis server
$redis resource | Redis Socket connection to the Redis server or Redis library instance
$redisMulti
$renamedCommands array
$requests integer
$selectedDb integer
$standalone boolean
$subscribed boolean
$timeout float Timeout for connecting to Redis server
$usePipeline boolean
$wrapperMethods array Aliases for backwards compatibility with phpredis

Открытые методы

Метод Описание
__call ( $name, $args )
__construct ( string $host = '127.0.0.1', integer $port = 6379, float $timeout = null, string $persistent = '', integer $db, string $password = null ) Creates a Redisent connection to the Redis server on host {@link $host} and port {@link $port}.
__destruct ( )
auth ( string $password ) : boolean
close ( ) : boolean
connect ( ) : Credis_Client
forceStandalone ( ) : Credis_Client
getHost ( ) : string Return the host of the Redis instance
getPersistence ( ) : string
getPort ( ) : integer Return the port of the Redis instance
getRenamedCommand ( $command )
getSelectedDb ( ) : integer Return the selected database
hscan ( integer &$Iterator, string $field, string $pattern = null, integer $count = null ) : boolean | Array
isConnected ( ) : boolean
isSubscribed ( ) : boolean
pSubscribe ( string | array $patterns, $callback )
pUnsubscribe ( ) : array
renameCommand ( string | callable | array $command, string | null $alias = NULL ) Enabled command renaming and provide mapping method. Supported methods are:
scan ( integer &$Iterator, string $pattern = null, $count = null ) : boolean | Array
select ( integer $index ) : boolean
setCloseOnDestruct ( boolean $flag ) : Credis_Client
setMaxConnectRetries ( integer $retries ) : Credis_Client
setReadTimeout ( integer $timeout ) : Credis_Client Set the read timeout for the connection. Use 0 to disable timeouts entirely (or use a very long timeout if not supported).
sscan ( integer &$Iterator, string $field, string $pattern = null, $count = null ) : boolean | Array
subscribe ( string | array $channels, $callback )
unsubscribe ( ) : array
zscan ( integer &$Iterator, string $field, string $pattern = null, $count = null ) : boolean | Array

Защищенные методы

Метод Описание
convertHost ( )
read_reply ( $name = '' )
write_command ( $command )

Приватные методы

Метод Описание
_flattenArguments ( array $arguments, &$out = [] ) : array Flatten arguments
_map ( $arg )
_prepare_command ( array $args ) : string Build the Redis unified protocol command

Описание методов

__call() публичный Метод

public __call ( $name, $args )

__construct() публичный Метод

$host may also be a path to a unix socket or a string in the form of tcp://[hostname]:[port] or unix://[path]
public __construct ( string $host = '127.0.0.1', integer $port = 6379, float $timeout = null, string $persistent = '', integer $db, string $password = null )
$host string The hostname of the Redis server
$port integer The port number of the Redis server
$timeout float Timeout period in seconds
$persistent string Flag to establish persistent connection
$db integer The selected datbase of the Redis server
$password string The authentication password of the Redis server

__destruct() публичный Метод

public __destruct ( )

auth() публичный Метод

public auth ( string $password ) : boolean
$password string
Результат boolean

close() публичный Метод

public close ( ) : boolean
Результат boolean

connect() публичный Метод

public connect ( ) : Credis_Client
Результат Credis_Client

convertHost() защищенный Метод

protected convertHost ( )

forceStandalone() публичный Метод

public forceStandalone ( ) : Credis_Client
Результат Credis_Client

getHost() публичный Метод

Return the host of the Redis instance
public getHost ( ) : string
Результат string

getPersistence() публичный Метод

public getPersistence ( ) : string
Результат string

getPort() публичный Метод

Return the port of the Redis instance
public getPort ( ) : integer
Результат integer

getRenamedCommand() публичный Метод

public getRenamedCommand ( $command )
$command

getSelectedDb() публичный Метод

Return the selected database
public getSelectedDb ( ) : integer
Результат integer

hscan() публичный Метод

public hscan ( integer &$Iterator, string $field, string $pattern = null, integer $count = null ) : boolean | Array
$Iterator integer
$field string
$pattern string
$count integer
Результат boolean | Array | Array

isConnected() публичный Метод

public isConnected ( ) : boolean
Результат boolean

isSubscribed() публичный Метод

public isSubscribed ( ) : boolean
Результат boolean

pSubscribe() публичный Метод

public pSubscribe ( string | array $patterns, $callback )
$patterns string | array
$callback

pUnsubscribe() публичный Метод

public pUnsubscribe ( ) : array
Результат array

read_reply() защищенный Метод

protected read_reply ( $name = '' )

renameCommand() публичный Метод

1. renameCommand('foo') // Salted md5 hash for all commands -> md5('foo'.$command) 2. renameCommand(function($command){ return 'my'.$command; }); // Callable 3. renameCommand('get', 'foo') // Single command -> alias 4. renameCommand(['get' => 'foo', 'set' => 'bar']) // Full map of [command -> alias]
public renameCommand ( string | callable | array $command, string | null $alias = NULL )
$command string | callable | array
$alias string | null

scan() публичный Метод

public scan ( integer &$Iterator, string $pattern = null, $count = null ) : boolean | Array
$Iterator integer
$pattern string
Результат boolean | Array | Array

select() публичный Метод

public select ( integer $index ) : boolean
$index integer
Результат boolean

setCloseOnDestruct() публичный Метод

public setCloseOnDestruct ( boolean $flag ) : Credis_Client
$flag boolean
Результат Credis_Client

setMaxConnectRetries() публичный Метод

public setMaxConnectRetries ( integer $retries ) : Credis_Client
$retries integer
Результат Credis_Client

setReadTimeout() публичный Метод

Set the read timeout for the connection. Use 0 to disable timeouts entirely (or use a very long timeout if not supported).
public setReadTimeout ( integer $timeout ) : Credis_Client
$timeout integer 0 (or -1) for no timeout, otherwise number of seconds
Результат Credis_Client

sscan() публичный Метод

public sscan ( integer &$Iterator, string $field, string $pattern = null, $count = null ) : boolean | Array
$Iterator integer
$field string
$pattern string
Результат boolean | Array | Array

subscribe() публичный Метод

public subscribe ( string | array $channels, $callback )
$channels string | array
$callback

unsubscribe() публичный Метод

public unsubscribe ( ) : array
Результат array

write_command() защищенный Метод

protected write_command ( $command )

zscan() публичный Метод

public zscan ( integer &$Iterator, string $field, string $pattern = null, $count = null ) : boolean | Array
$Iterator integer
$field string
$pattern string
Результат boolean | Array | Array

Описание свойств

$authPassword защищенное свойство

protected string $authPassword
Результат string

$closeOnDestruct защищенное свойство

protected bool $closeOnDestruct
Результат boolean

$commandNames защищенное свойство

protected array $commandNames
Результат array

$commands защищенное свойство

protected string $commands
Результат string

$connectFailures защищенное свойство

protected int $connectFailures
Результат integer

$connected защищенное свойство

protected bool $connected
Результат boolean

$host защищенное свойство

Host of the Redis server
protected string $host
Результат string

$isMulti защищенное свойство

protected bool $isMulti
Результат boolean

$isWatching защищенное свойство

protected bool $isWatching
Результат boolean

$maxConnectRetries защищенное свойство

protected int $maxConnectRetries
Результат integer

$persistent защищенное свойство

Unique identifier for persistent connections
protected string $persistent
Результат string

$port защищенное свойство

Port on which the Redis server is running
protected int $port
Результат integer

$readTimeout защищенное свойство

Timeout for reading response from Redis server
protected float $readTimeout
Результат float

$redis защищенное свойство

Socket connection to the Redis server or Redis library instance
protected resource|Redis $redis
Результат resource | Redis

$redisMulti защищенное свойство

protected $redisMulti

$renamedCommands защищенное свойство

protected array $renamedCommands
Результат array

$requests защищенное свойство

protected int $requests
Результат integer

$selectedDb защищенное свойство

protected int $selectedDb
Результат integer

$standalone защищенное свойство

protected bool $standalone
Результат boolean

$subscribed защищенное свойство

protected bool $subscribed
Результат boolean

$timeout защищенное свойство

Timeout for connecting to Redis server
protected float $timeout
Результат float

$usePipeline защищенное свойство

protected bool $usePipeline
Результат boolean

$wrapperMethods защищенное свойство

Aliases for backwards compatibility with phpredis
protected array $wrapperMethods
Результат array