mirror of
https://github.com/predis/predis.git
synced 2026-08-23 18:53:24 +00:00
Daniele Alessandri
e88938cdfd
This iterator allows to perform full iterations over fields and values of a
hash by wrapping the incremental nature of HSCAN just like we did for SCAN:
$client = new Predis\Client('tcp://127.0.0.1', ['profile' => '2.8']);
$iterator = new Predis\Iterator\Scan\HashIterator($client, "hash_key");
foreach ($iterator as $field => $value) {
echo "$field => $value" . PHP_EOL;
}
Being HSCAN closely related to SCAN, it is subject to the same behaviour,
see http://redis.io/commands/scan for reference.
57 lines
1.3 KiB
PHP
57 lines
1.3 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\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 <suppakilla@gmail.com>
|
|
* @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);
|
|
}
|
|
}
|