Yiisoft\Db\Query\BatchQueryResult

Complexity

Total Complexity

16

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	next()	0	4	1
A	batchSize()	0	5	1
A	setPopulatedMethod()	0	5	1
A	__construct()	0	2	1
A	valid()	0	3	1
A	fetchData()	0	9	2
A	getQuery()	0	3	1
A	getRows()	0	15	3
A	current()	0	3	1
A	key()	0	3	1
A	getBatchSize()	0	3	1
A	rewind()	0	9	2

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Query;

use Closure;
use Throwable;
use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidConfigException;

/**
 * Represents the result of a batch query execution.
 *
 * A batch query is a group of many SQL statements that are executed together as a single unit.
 */
final class BatchQueryResult implements BatchQueryResultInterface
{
    private int $batchSize = 100;
    private int $index = -1;
    /**
     * @var array The data retrieved in the current batch.
     */
    private array $batch = [];
    /**
     * @var DataReaderInterface|null The data reader associated with this batch query.
     */
    private DataReaderInterface|null $dataReader = null;

    private Closure|null $populateMethod = null;

    public function __construct(private QueryInterface $query)
    {
    }

    public function rewind(): void
    {
        if ($this->index === 0) {
            return;
        }

        $this->dataReader = null;
        $this->batch = $this->fetchData();
        $this->index = 0;
    }

    public function next(): void
    {
        $this->batch = $this->fetchData();
        ++$this->index;
    }

    /**
     * Fetches the next batch of data.
     *
     * @throws Exception
     * @throws InvalidConfigException
     * @throws Throwable
     *
     * @return array The data fetched.
     */
    private function fetchData(): array
    {
        $rows = $this->getRows();

        if ($this->populateMethod !== null) {
            return (array) ($this->populateMethod)($rows, $this->query->getIndexBy());
        }

        return $rows;
    }

    /**
     * Reads and collects rows for batch.
     */
    private function getRows(): array
    {
        $rows = [];

        $this->dataReader ??= $this->query->createCommand()->query();

        for (
            $leftCount = $this->batchSize;
            $leftCount > 0 && $this->dataReader->valid();
            --$leftCount, $this->dataReader->next()
        ) {
            $rows[] = $this->dataReader->current();
        }

        return $rows;
    }

    public function key(): int
    {
        return $this->index;
    }

    public function current(): array
    {
        return $this->batch;
    }

    public function valid(): bool
    {
        return !empty($this->batch);
    }

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

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

    public function batchSize(int $value): static
    {
        $this->batchSize = $value;

        return $this;
    }

    public function setPopulatedMethod(Closure|null $populateMethod = null): static
    {
        $this->populateMethod = $populateMethod;

        return $this;
    }
}