From b2db97d9839ff360f37429f9d736f0ddbf40a82c Mon Sep 17 00:00:00 2001 From: Daniele Alessandri Date: Thu, 7 Nov 2013 11:32:31 +0100 Subject: [PATCH] Tweak phpdocs for the abstract cursor-based iterator. --- lib/Predis/Collection/Iterator/CursorBasedIterator.php | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/Predis/Collection/Iterator/CursorBasedIterator.php b/lib/Predis/Collection/Iterator/CursorBasedIterator.php index adfcd909..3679d32a 100644 --- a/lib/Predis/Collection/Iterator/CursorBasedIterator.php +++ b/lib/Predis/Collection/Iterator/CursorBasedIterator.php @@ -17,12 +17,15 @@ use Predis\NotSupportedException; /** * Provides the base implementation for a fully-rewindable PHP iterator - * that can incrementally iterate over collections stored on Redis. + * that can incrementally iterate over cursor-based collections stored + * on Redis using commands in the `SCAN` family. * * Given their incremental nature with multiple fetches, these kind of * iterators offer limited guarantees about the returned elements because * the collection can change several times during the iteration process. * + * @see http://redis.io/commands/scan + * * @author Daniele Alessandri */ abstract class CursorBasedIterator implements Iterator @@ -58,7 +61,7 @@ abstract class CursorBasedIterator implements Iterator * the iteration. * * @param ClientInterface Client connected to Redis. - * @param string $commandID Command ID (e.g. `SCAN`). + * @param string $commandID Command ID. */ protected function requiredCommand(ClientInterface $client, $commandID) {