PHP Class Predis\Command\ScriptCommand

Author: Daniele Alessandri ([email protected])
Inheritance: extends ServerEvalSHA
Show file Open project: nrk/predis Class Usage Examples

Public Methods

Method Description
getEvalArguments ( ) : array Returns arguments for EVAL command.
getEvalCommand ( ) : RawCommand Returns the equivalent EVAL command as a raw command instance.
getId ( )
getKeys ( ) : array Returns the elements from the arguments that are identified as keys.
getScript ( ) : string Gets the body of a Lua script.
getScriptHash ( ) : string Calculates the SHA1 hash of the body of the script.
setArguments ( array $arguments )

Protected Methods

Method Description
getKeysCount ( ) : integer Specifies the number of arguments that should be considered as keys.

Method Details

getEvalArguments() public method

Returns arguments for EVAL command.
public getEvalArguments ( ) : array
return array

getEvalCommand() public method

Returns the equivalent EVAL command as a raw command instance.
public getEvalCommand ( ) : RawCommand
return RawCommand

getId() public method

public getId ( )

getKeys() public method

Returns the elements from the arguments that are identified as keys.
public getKeys ( ) : array
return array

getKeysCount() protected method

The default behaviour for the base class is to return 0 to indicate that all the elements of the arguments array should be considered as keys, but subclasses can enforce a static number of keys.
protected getKeysCount ( ) : integer
return integer

getScript() abstract public method

Gets the body of a Lua script.
abstract public getScript ( ) : string
return string

getScriptHash() public method

Calculates the SHA1 hash of the body of the script.
public getScriptHash ( ) : string
return string SHA1 hash.

setArguments() public method

public setArguments ( array $arguments )
$arguments array