[phpdoc] Add API documentation.

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.
This commit is contained in:
Daniele Alessandri
2011-10-18 17:55:58 +02:00
parent 1f2104ef7f
commit 4e6ed3f26d
210 changed files with 3818 additions and 48 deletions
@@ -14,8 +14,27 @@ namespace Predis\Protocol;
use Predis\Commands\ICommand;
use Predis\Network\IConnectionComposable;
/**
* Interface that defines a protocol processor that serializes Redis commands
* and parses replies returned by the server to PHP objects.
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
interface IProtocolProcessor extends IResponseReader
{
/**
* Writes a Redis command on the specified connection.
*
* @param IConnectionComposable $connection Connection to Redis.
* @param ICommand $command Redis command.
*/
public function write(IConnectionComposable $connection, ICommand $command);
/**
* Sets the options for the protocol processor.
*
* @param string $option Name of the option.
* @param mixed $value Value of the option.
*/
public function setOption($option, $value);
}