cycle / orm

src/Collection/Pivoted/LoophpPivotedCollection.php

<?php

declare(strict_types=1);

namespace Cycle\ORM\Collection\Pivoted;

use loophp\collection\Collection;
use loophp\collection\CollectionDecorator;
use SplObjectStorage;

/**
 * Collection with associated relation context. Attention, pivot context is lost when collection is partitioned or
 * filtered.
 *
 * @psalm-template TKey of array-key
 * @psalm-template TEntity of object
 * @psalm-template TPivot of object
 *
 * @template-extends CollectionDecorator<TKey, TEntity>
 *
 * @template-implements PivotedCollectionInterface<TEntity, TPivot>
 */
class LoophpPivotedCollection extends CollectionDecorator implements PivotedCollectionInterface, \Countable
{
    /** @var SplObjectStorage<TEntity, TPivot> */
    protected SplObjectStorage $pivotContext;

    /**
     * @param array<TKey, TEntity> $elements
     * @param SplObjectStorage<TEntity, TPivot>|null $pivotData
     */
    final public function __construct(array $elements = [], SplObjectStorage $pivotData = null)
    {
        parent::__construct(Collection::fromIterable($elements));
        $this->pivotContext = $pivotData ?? new SplObjectStorage();
    }

    public function hasPivot(object $element): bool
    {
        return $this->pivotContext->offsetExists($element);
    }

    public function getPivot(object $element): mixed
    {
        return $this->pivotContext[$element] ?? null;
    }

    public function setPivot(object $element, mixed $pivot): void
    {
        $this->pivotContext[$element] = $pivot;
    }

    public function getPivotContext(): SplObjectStorage
    {
        return $this->pivotContext;
    }

    public function count(): int
    {
        return \iterator_count($this->innerCollection);
    }

    public static function fromIterable(iterable $iterable): static
    {
        return new static($iterable instanceof \Traversable ? \iterator_to_array($iterable) : $iterable);

It seems like $iterable instanceof Traversable ? iterator_to_array($iterable) : $iterable can also be of type iterable; however, parameter $elements of Cycle\ORM\Collection\Pivoted\LoophpPivotedCollection::__construct() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * @param array<K, V> $elements
     *
     * @return static<K, V, TPivot>
     *
     * @template K of TKey
     * @template V of TEntity
     */
    protected function createFrom(array $elements): static
    {
        $new = parent::fromIterable($elements);
        $new->pivotContext = $this->pivotContext;

        return $new;

The expression return $new returns the type loophp\collection\CollectionDecorator which includes types incompatible with the type-hinted return Cycle\ORM\Collection\Pivoted\LoophpPivotedCollection.

    }
}