b2pweb / bdf-prime

src/Connection/Result/ArrayResultSet.php

<?php

namespace Bdf\Prime\Connection\Result;

use ArrayIterator;
use Bdf\Prime\Connection\Result\FetchStrategy\ArrayFetchStrategyInterface;
use Bdf\Prime\Connection\Result\FetchStrategy\AssociativeArrayFetch;
use Bdf\Prime\Connection\Result\FetchStrategy\ClassArrayFetch;
use Bdf\Prime\Connection\Result\FetchStrategy\ColumnArrayFetch;
use Bdf\Prime\Connection\Result\FetchStrategy\ListArrayFetch;
use Bdf\Prime\Connection\Result\FetchStrategy\ObjectArrayFetch;
use Bdf\Prime\Exception\DBALException;

/**
 * Wrap simple associative array to ResultSet
 * This result is useful for caches
 *
 * @template T
 * @implements ResultSetInterface<T>
 */
final class ArrayResultSet extends ArrayIterator implements ResultSetInterface
{
    /**
     * @var ArrayFetchStrategyInterface<T>
     */
    private ArrayFetchStrategyInterface $strategy;

    /**
     * @param list<array<string, mixed>> $array

The type Bdf\Prime\Connection\Result\list was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param int $flags
     * @psalm-this-out ArrayResultSet<array<string, mixed>>
     */
    public function __construct($array = [], $flags = 0)
    {
        parent::__construct($array, $flags);

It seems like $array can also be of type Bdf\Prime\Connection\Result\list; however, parameter $array of ArrayIterator::__construct() does only seem to accept array, maybe add an additional type check?

        /** @var ArrayResultSet<array<string, mixed>> $this */
        $this->strategy = AssociativeArrayFetch::instance();
    }

    /**
     * {@inheritdoc}
     */
    public function fetchMode($mode, $options = null)
    {
        switch ($mode) {
            case self::FETCH_ASSOC:

The constant Bdf\Prime\Connection\Result\ResultSetInterface::FETCH_ASSOC has been deprecated: Use asAssociative() instead

                return $this->asAssociative();

            case self::FETCH_NUM:

The constant Bdf\Prime\Connection\Result\ResultSetInterface::FETCH_NUM has been deprecated: Use asList() instead

                return $this->asList();

            case self::FETCH_COLUMN:

The constant Bdf\Prime\Connection\Result\ResultSetInterface::FETCH_COLUMN has been deprecated: Use asColumn() instead

                return $this->asColumn($options ?? 0);

            case self::FETCH_OBJECT:

The constant Bdf\Prime\Connection\Result\ResultSetInterface::FETCH_OBJECT has been deprecated: Use asObject() instead

                return $this->asObject();

            case self::FETCH_CLASS:

The constant Bdf\Prime\Connection\Result\ResultSetInterface::FETCH_CLASS has been deprecated: Use asClass() instead

                return $this->asClass($options);

            default:
                throw new DBALException('Unsupported fetch mode ' . $mode);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function asAssociative(): ResultSetInterface
    {
        /** @var ArrayResultSet<array<string, mixed>> $this */
        $this->strategy = AssociativeArrayFetch::instance();

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function asList(): ResultSetInterface
    {
        /** @var ArrayResultSet<list<mixed>> $this */
        $this->strategy = ListArrayFetch::instance();

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function asObject(): ResultSetInterface
    {
        /** @var ArrayResultSet<\stdClass> $this */
        $this->strategy = ObjectArrayFetch::instance();

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * @param class-string<E> $className

The doc comment class-string<E> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<E>.

     * @param list<mixed> $constructorArguments
     *
     * @return static<E>
     *
     * @template E
     */
    public function asClass(string $className, array $constructorArguments = []): ResultSetInterface
    {
        /** @var ArrayResultSet<E> $this */
        $this->strategy = new ClassArrayFetch($className, $constructorArguments);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function asColumn(int $column = 0): ResultSetInterface
    {
        /** @var ArrayResultSet<mixed> $this */
        $this->strategy = new ColumnArrayFetch($column);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function all(): array
    {
        return $this->strategy->all($this->getArrayCopy());
    }

    /**
     * {@inheritdoc}
     */
    #[\ReturnTypeWillChange]
    public function current()
    {
        $value = parent::current();

        if ($value === null) {
            return false;
        }

        return $this->strategy->one($value);
    }

    /**
     * {@inheritdoc}
     */
    public function rewind(): void
    {
        parent::rewind();
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        return parent::count();
    }

    /**
     * {@inheritdoc}
     */
    public function isRead(): bool
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function isWrite(): bool
    {
        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function hasWrite(): bool
    {
        return false;
    }
}