diff --git a/lib/Predis/Iterator/Scan/HashIterator.php b/lib/Predis/Iterator/Scan/HashIterator.php new file mode 100644 index 00000000..078338f3 --- /dev/null +++ b/lib/Predis/Iterator/Scan/HashIterator.php @@ -0,0 +1,56 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Predis\Iterator\Scan; + +use Predis\ClientInterface; + +/** + * Abstracts the iteration of fields and values of an hash + * by leveraging the HSCAN command (Redis >= 2.8) wrapped + * in a fully-rewindable PHP iterator. + * + * @author Daniele Alessandri + * @link http://redis.io/commands/scan + */ +class HashIterator extends AbstractScanIterator +{ + protected $key; + + /** + * {@inheritdoc} + */ + public function __construct(ClientInterface $client, $key, $match = null, $count = null) + { + $this->requiredCommand($client, 'HSCAN'); + + parent::__construct($client, $match, $count); + + $this->key = $key; + } + + /** + * {@inheritdoc} + */ + protected function executeScanCommand() + { + return $this->client->hscan($this->key, $this->cursor, $this->getScanOptions()); + } + + /** + * {@inheritdoc} + */ + protected function extractNext() + { + $this->position = key($this->elements); + $this->current = array_shift($this->elements); + } +}