Status
in package
implements
ResponseInterface
Represents a status response returned by Redis.
Tags
Interfaces, Classes and Traits
- ResponseInterface
- Represents a complex response object from Redis.
Table of Contents
- $OK : mixed
- $payload : mixed
- $QUEUED : mixed
- __construct() : mixed
- __toString() : string
- Converts the response object to its string representation.
- get() : string
- Returns an instance of a status response object.
- getPayload() : string
- Returns the payload of status response.
Properties
$OK
private
static mixed
$OK
$payload
private
mixed
$payload
$QUEUED
private
static mixed
$QUEUED
Methods
__construct()
public
__construct(string $payload) : mixed
Parameters
- $payload : string
-
Payload of the status response as returned by Redis.
Return values
mixed —__toString()
Converts the response object to its string representation.
public
__toString() : string
Return values
string —get()
Returns an instance of a status response object.
public
static get(string $payload) : string
Common status responses such as OK or QUEUED are cached in order to lower the global memory usage especially when using pipelines.
Parameters
- $payload : string
-
Status response payload.
Return values
string —getPayload()
Returns the payload of status response.
public
getPayload() : string