SearchResultBatchIterator

SearchResultBatchIterator.php

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
declare(strict_types=1);

namespace eZ\Publish\API\Repository\Values\Content\Search;

use eZ\Publish\API\Repository\SearchService;
use eZ\Publish\API\Repository\Values\Content\LocationQuery;
use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
use IteratorAggregate;
use Traversable;

class SearchResultBatchIterator implements IteratorAggregate
{
    public const DEFAULT_BATCH_SIZE = 25;

    /** @var \eZ\Publish\API\Repository\SearchService */
    private $searchService;

    /** @var \eZ\Publish\API\Repository\Values\Content\LocationQuery */
    private $query;

    /** @var array */
    private $languagesFilter;

    /** @var int */
    private $batchSize;

    public function __construct(SearchService $searchService, LocationQuery $query, array $languagesFilter = [])
    {
        $this->searchService = $searchService;
        $this->query = $query;
        $this->languagesFilter = $languagesFilter;

        $this->batchSize = self::DEFAULT_BATCH_SIZE;
    }

    public function getIterator(): Traversable
    {
        $query = clone $this->query;
        $query->limit = $this->batchSize;

        do {
            $results = $this->searchService->findLocations($query, $this->languagesFilter);
            foreach ($results->searchHits as $searchHit) {
                yield $searchHit;
            }

            $query->offset += $query->limit;
        } while($query->offset < $results->totalCount);
    }

    public function getQuery(): LocationQuery
    {
        return $this->query;
    }

    public function getBatchSize(): int
    {
        return $this->batchSize;
    }

    public function setBatchSize(int $batchSize): void
    {
        if ($batchSize < 1) {
            throw new InvalidArgumentException('$batchSize', 'value must be greater or equal to 1');
        }

        $this->batchSize = $batchSize;
    }
}

usage.php

<?php

$searchService = $this->reporsitory->getSearchService();

$query = new LocationQuery([
    'filter' => new ParentLocationId(2)
]);

$iterator = new SearchResultBatchIterator($searchService, $query);
$iterator->setBatchSize(3);

foreach ($iterator as $location) {
    $output->writeln("Location ID = " . $location->valueObject->id);
}

How would you use that iterator ?

Thank you for usage.php :)