[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
@@ -17,8 +17,22 @@ use Predis\Protocol\ProtocolException;
use Predis\Network\IConnectionComposable;
use Predis\Iterators\MultiBulkResponseSimple;
/**
* Implements a response handler for iterable multi-bulk replies using the
* standard wire protocol defined by Redis.
*
* @link http://redis.io/topics/protocol
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
class ResponseMultiBulkStreamHandler implements IResponseHandler
{
/**
* Handles a multi-bulk reply returned by Redis in a streamable fashion.
*
* @param IConnectionComposable $connection Connection to Redis.
* @param string $lengthString Number of items in the multi-bulk reply.
* @return MultiBulkResponseSimple
*/
public function handle(IConnectionComposable $connection, $lengthString)
{
$length = (int) $lengthString;