PHP 클래스 Credis_Client

Server/Connection:
파일 보기 프로젝트 열기: colinmollenhour/credis 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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