IncrementExistingKeysBy
extends ScriptCommand
in package
Base class used to implement an higher level abstraction for commands based on Lua scripting with EVAL and EVALSHA.
Table of Contents
- $arguments : mixed
- $slot : mixed
- getArgument() : mixed|null
- Gets the argument of the command at the specified index.
- getArguments() : array<string|int, mixed>
- Gets the arguments of the command.
- getEvalArguments() : array<string|int, mixed>
- getId() : mixed
- {@inheritdoc}
- getKeys() : array<string|int, mixed>
- Returns the elements from the arguments that are identified as keys.
- getKeysCount() : int
- Specifies the number of arguments that should be considered as keys.
- getScript() : string
- Gets the body of a Lua script.
- getScriptHash() : string
- Calculates the SHA1 hash of the body of the script.
- getSlot() : int|null
- Returns the assigned slot of the command for clustering distribution.
- normalizeArguments() : array<string|int, mixed>
- Normalizes the arguments array passed to a Redis command.
- normalizeVariadic() : array<string|int, mixed>
- Normalizes the arguments array passed to a variadic Redis command.
- parseResponse() : mixed
- Parses a raw response and returns a PHP object.
- setArguments() : mixed
- Sets the arguments for the command.
- setRawArguments() : mixed
- Sets the raw arguments for the command without processing them.
- setSlot() : mixed
- Assign the specified slot to the command for clustering distribution.
- filterArguments() : array<string|int, mixed>
- Returns a filtered array of the arguments.
Properties
$arguments
private
mixed
$arguments
= array()
$slot
private
mixed
$slot
Methods
getArgument()
Gets the argument of the command at the specified index.
public
getArgument(mixed $index) : mixed|null
Parameters
- $index : mixed
-
Index of the desired argument.
Return values
mixed|null —getArguments()
Gets the arguments of the command.
public
getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEvalArguments()
public
getEvalArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —getId()
{@inheritdoc}
public
getId() : mixed
Return values
mixed —getKeys()
Returns the elements from the arguments that are identified as keys.
public
getKeys() : array<string|int, mixed>
Return values
array<string|int, mixed> —getKeysCount()
Specifies the number of arguments that should be considered as keys.
public
getKeysCount() : int
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.
Return values
int —getScript()
Gets the body of a Lua script.
public
getScript() : string
Return values
string —getScriptHash()
Calculates the SHA1 hash of the body of the script.
public
getScriptHash() : string
Return values
string —SHA1 hash.
getSlot()
Returns the assigned slot of the command for clustering distribution.
public
getSlot() : int|null
Return values
int|null —normalizeArguments()
Normalizes the arguments array passed to a Redis command.
public
static normalizeArguments(array<string|int, mixed> $arguments) : array<string|int, mixed>
Parameters
- $arguments : array<string|int, mixed>
-
Arguments for a command.
Return values
array<string|int, mixed> —normalizeVariadic()
Normalizes the arguments array passed to a variadic Redis command.
public
static normalizeVariadic(array<string|int, mixed> $arguments) : array<string|int, mixed>
Parameters
- $arguments : array<string|int, mixed>
-
Arguments for a command.
Return values
array<string|int, mixed> —parseResponse()
Parses a raw response and returns a PHP object.
public
parseResponse(mixed $data) : mixed
Parameters
- $data : mixed
-
Binary string containing the whole response.
Return values
mixed —setArguments()
Sets the arguments for the command.
public
setArguments(array<string|int, mixed> $arguments) : mixed
Parameters
- $arguments : array<string|int, mixed>
-
List of arguments.
Return values
mixed —setRawArguments()
Sets the raw arguments for the command without processing them.
public
setRawArguments(array<string|int, mixed> $arguments) : mixed
Parameters
- $arguments : array<string|int, mixed>
-
List of arguments.
Return values
mixed —setSlot()
Assign the specified slot to the command for clustering distribution.
public
setSlot(mixed $slot) : mixed
Parameters
- $slot : mixed
-
Slot ID.
Return values
mixed —filterArguments()
Returns a filtered array of the arguments.
protected
filterArguments(array<string|int, mixed> $arguments) : array<string|int, mixed>
Parameters
- $arguments : array<string|int, mixed>
-
List of arguments.