mirror of
https://github.com/predis/predis.git
synced 2026-10-13 07:18:10 +00:00
Daniele Alessandri
373d30b070
Status response objects are needed mostly to make it possible from the
client perspective to differentiate a status response with the payload
"OK" from a normale bulk reply containing "OK".
The biggest change is for commands returning +OK responses: these were
previously translated to TRUE (bool value), but they are now returned
as instances of Predis\Response\Status. Just to illustrate an example
of the possibilities with this change we will use SET since it is the
most widely used command returning +OK:
$response = $client->set('foo', 'bar');
echo $response; // 'OK'
$response == 'OK'; // TRUE
isset($response->ok); // TRUE
$response == true; // TRUE
$response === true; // FALSE
$response instanceof Predis\Response\ObjectInterface; // TRUE
$response instanceof Predis\Response\Status; // TRUE
For those checking responses returned by commands such as SET or PONG,
the breaking change basically lies in the usage of strict comparison:
doing $response === true will now evaluate to FALSE instead of TRUE.
By default Predis caches common status responses such as OK or QUEUED
to lower the memory usage when using pipelines or transactions.
82 lines
1.7 KiB
PHP
82 lines
1.7 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Predis package.
|
|
*
|
|
* (c) Daniele Alessandri <suppakilla@gmail.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Predis\Response;
|
|
|
|
/**
|
|
* Represents a status response returned by Redis.
|
|
*
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
class Status implements ObjectInterface
|
|
{
|
|
private static $OK;
|
|
private static $QUEUED;
|
|
|
|
private $payload;
|
|
|
|
/**
|
|
* @param string $payload Payload of the status response as returned by Redis.
|
|
*/
|
|
public function __construct($payload)
|
|
{
|
|
$this->payload = $payload;
|
|
}
|
|
|
|
/**
|
|
* Converts the response object to its string representation.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString()
|
|
{
|
|
return $this->payload;
|
|
}
|
|
|
|
/**
|
|
* Returns the payload of status response.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getPayload()
|
|
{
|
|
return $this->payload;
|
|
}
|
|
|
|
/**
|
|
* Returns a new instance of a status response object.
|
|
*
|
|
* Common status responses such as OK or QUEUED are cached to lower the
|
|
* memory usage especially when using pipelines.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get($payload)
|
|
{
|
|
switch ($payload) {
|
|
case 'OK':
|
|
if (!isset(self::$OK)) {
|
|
self::$OK = new self('OK');
|
|
}
|
|
return self::$OK;
|
|
|
|
case 'OK':
|
|
if (!isset(self::$QUEUED)) {
|
|
self::$QUEUED = new self('QUEUED');
|
|
}
|
|
return self::$QUEUED;
|
|
|
|
default:
|
|
return new self($payload);
|
|
}
|
|
}
|
|
}
|