mirror of
https://github.com/predis/predis.git
synced 2026-10-16 08:46:28 +00:00
Daniele Alessandri
4e6ed3f26d
This is a starting point to add a documentation of the whole set of APIs and classes of Predis. The next step will be to actually improve and extend it.
67 lines
1.6 KiB
PHP
67 lines
1.6 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\Commands;
|
|
|
|
use Predis\Distribution\INodeKeyGenerator;
|
|
|
|
/**
|
|
* Defines an abstraction representing a Redis command.
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
interface ICommand
|
|
{
|
|
/**
|
|
* Gets the ID of a Redis command.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getId();
|
|
|
|
/**
|
|
* Returns an hash of the command using the provided algorithm against the
|
|
* key (used to calculate the distribution of keys with client-side sharding).
|
|
*
|
|
* @param INodeKeyGenerator $distributor Distribution algorithm.
|
|
* @return int
|
|
*/
|
|
public function getHash(INodeKeyGenerator $distributor);
|
|
|
|
/**
|
|
* Set the arguments of the command.
|
|
*
|
|
* @param array $arguments List of arguments.
|
|
*/
|
|
public function setArguments(Array $arguments);
|
|
|
|
/**
|
|
* Get the arguments of the command.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getArguments();
|
|
|
|
/**
|
|
* Prefixes all the keys in the arguments of the command.
|
|
*
|
|
* @param string $prefix String user to prefix the keys.
|
|
*/
|
|
public function prefixKeys($prefix);
|
|
|
|
/**
|
|
* Parses a reply buffer and returns a PHP object.
|
|
*
|
|
* @param string $data Binary string containing the whole reply.
|
|
* @return mixed
|
|
*/
|
|
public function parseResponse($data);
|
|
}
|