cycle / orm

src/Relation/HasMany.php

<?php

declare(strict_types=1);

namespace Cycle\ORM\Relation;

use Cycle\ORM\Exception\Relation\BadRelationValueException;
use Cycle\ORM\FactoryInterface;
use Cycle\ORM\Heap\Node;
use Cycle\ORM\MapperInterface;
use Cycle\ORM\ORMInterface;
use Cycle\ORM\Reference\EmptyReference;
use Cycle\ORM\Reference\Reference;
use Cycle\ORM\Reference\ReferenceInterface;
use Cycle\ORM\Relation;
use Cycle\ORM\Relation\Traits\HasSomeTrait;
use Cycle\ORM\Select;
use Cycle\ORM\Select\LoaderInterface;
use Cycle\ORM\Service\EntityFactoryInterface;
use Cycle\ORM\Service\SourceProviderInterface;
use Cycle\ORM\Transaction\Pool;
use Cycle\ORM\Transaction\Tuple;

/**
 * Provides the ability to own the collection of entities.
 *
 * @internal
 */
class HasMany extends AbstractRelation
{
    use HasSomeTrait;

The trait Cycle\ORM\Relation\Traits\HasSomeTrait requires some properties which are not provided by Cycle\ORM\Relation\HasMany: $state, $entity

    protected FactoryInterface $factory;
    protected Select $select;

    public function __construct(ORMInterface $orm, string $role, string $name, string $target, array $schema)
    {
        parent::__construct($orm, $role, $name, $target, $schema);
        $sourceProvider = $orm->getService(SourceProviderInterface::class);
        $this->factory = $orm->getFactory();

        // Prepare Select Statement
        $this->select = (new Select($orm, $this->target))
            ->scope($sourceProvider->getSource($this->target)->getScope())
            ->orderBy($this->schema[Relation::ORDER_BY] ?? []);
    }

    public function prepare(Pool $pool, Tuple $tuple, mixed $related, bool $load = true): void
    {
        $node = $tuple->node;
        $original = $node->getRelation($this->getName());
        $tuple->state->setRelation($this->getName(), $related);

        if ($original instanceof ReferenceInterface) {
            if (!$load && $this->compareReferences($original, $related) && !$original->hasValue()) {
                $tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_RESOLVED);
                return;
            }

            $original = $this->resolve($original, true);
            $node->setRelation($this->getName(), $original);
        }

        if ($related instanceof ReferenceInterface) {
            $related = $this->resolve($related, true);
            $tuple->state->setRelation($this->getName(), $related);
        } elseif (SpecialValue::isNotSet($related)) {
            $tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_RESOLVED);
            return;
        } elseif (!\is_iterable($related)) {
            if ($related === null) {
                $related = $this->collect([]);
            } else {
                throw new BadRelationValueException(\sprintf(
                    'Value for Has Many relation must be of the iterable type, %s given.',
                    \get_debug_type($related),
                ));
            }
        }
        if (!SpecialValue::isEmpty($original)) {
            foreach ($this->calcDeleted($related, $original) as $item) {

It seems like $related can also be of type null; however, parameter $related of Cycle\ORM\Relation\HasMany::calcDeleted() does only seem to accept iterable, maybe add an additional type check?

It seems like $original can also be of type null; however, parameter $original of Cycle\ORM\Relation\HasMany::calcDeleted() does only seem to accept iterable, maybe add an additional type check?

                $this->deleteChild($pool, $tuple, $item);
            }
        }

        if (\count($related) === 0) {

It seems like $related can also be of type null; however, parameter $value of count() does only seem to accept Countable|array, maybe add an additional type check?

            $tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_RESOLVED);
            return;
        }
        $tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_PROCESS);

        // $relationName = $this->getTargetRelationName()
        // Store new and existing items
        foreach ($related as $item) {
            $rTuple = $pool->attachStore($item, true);
            $this->assertValid($rTuple->node);
            if ($this->isNullable()) {
                // todo?
                // $rNode->setRelationStatus($relationName, RelationInterface::STATUS_DEFERRED);
            }
        }
    }

    public function queue(Pool $pool, Tuple $tuple): void
    {
        $node = $tuple->node;

The assignment to $node is dead and can be removed.

        $related = $tuple->state->getRelation($this->getName());
        $related = $this->extract($related);

        $tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_RESOLVED);

        if ($related instanceof ReferenceInterface && !$related->hasValue()) {

$related is never a sub-type of Cycle\ORM\Reference\ReferenceInterface.

            return;
        }

        // Fill related
        $relationName = $this->getTargetRelationName();
        foreach ($related as $item) {
            /** @var Tuple $rTuple */
            $rTuple = $pool->offsetGet($item);

            if ($this->inversion !== null) {
                if ($rTuple->node->getStatus() === Node::NEW) {
                    // For existing entities it can be unwanted
                    // if Reference to Parent will be rewritten by Parent Entity
                    $rTuple->state->setRelation($relationName, $tuple->entity);
                }

                if ($rTuple->state->getRelationStatus($relationName) === RelationInterface::STATUS_PREPARE) {
                    continue;
                }
            }
            $this->applyChanges($tuple, $rTuple);
            $rTuple->state->setRelationStatus($relationName, RelationInterface::STATUS_RESOLVED);
        }
    }

    /**
     * Init relation state and entity collection.
     */
    public function init(EntityFactoryInterface $factory, Node $node, array $data): iterable
    {
        $elements = [];
        foreach ($data as $item) {
            $elements[] = $factory->make($this->target, $item, Node::MANAGED);
        }

        $node->setRelation($this->getName(), $elements);
        return $this->collect($elements);
    }

    public function cast(?array $data): array
    {
        if (!$data) {

The expression $data of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return [];
        }

        /** @var array<non-empty-string, MapperInterface> $mappers Mappers cache */
        $mappers = [];

        foreach ($data as $key => $item) {
            $role = $item[LoaderInterface::ROLE_KEY] ?? $this->target;
            $mappers[$role] ??= $this->mapperProvider->getMapper($role);
            // break link
            unset($data[$key]);
            $data[$key] = $mappers[$role]->cast($item);
        }
        return $data;
    }

    public function initReference(Node $node): ReferenceInterface
    {
        $scope = $this->getReferenceScope($node);
        return $scope === null
            ? new EmptyReference($node->getRole(), [])
            : new Reference($this->target, $scope);
    }

    public function resolve(ReferenceInterface $reference, bool $load): ?iterable
    {
        if ($reference->hasValue()) {
            return $reference->getValue();
        }
        if ($reference->getScope() === []) {
            // nothing to proxy to
            $reference->setValue([]);
            return [];

The expression return array() returns the type array which is incompatible with the type-hinted return iterable|null.

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

        $scope = \array_merge($reference->getScope(), $this->schema[Relation::WHERE] ?? []);

        $iterator = (clone $this->select)->where($scope)->getIterator(findInHeap: true);
        $result = \iterator_to_array($iterator, false);

        $reference->setValue($result);

        return $result;

The expression return $result returns the type array which is incompatible with the type-hinted return iterable|null.

    }

    public function collect(mixed $data): iterable
    {
        if (!\is_iterable($data)) {
            throw new \InvalidArgumentException('Collected data in the HasMany relation should be iterable.');
        }
        return $this->factory->collection(
            $this->schema[Relation::COLLECTION_TYPE] ?? null,
        )->collect($data);
    }

    /**
     * Convert entity data into array.
     */
    public function extract(mixed $data): array
    {
        if ($data instanceof \Doctrine\Common\Collections\Collection) {
            return $data->toArray();
        }
        if ($data instanceof \Traversable) {
            return \iterator_to_array($data);
        }
        return \is_array($data) ? $data : [];
    }

    protected function getReferenceScope(Node $node): ?array
    {
        $scope = [];
        $nodeData = $node->getData();
        foreach ($this->innerKeys as $i => $key) {
            if (!isset($nodeData[$key])) {
                return null;
            }
            $scope[$this->outerKeys[$i]] = $nodeData[$key];
        }
        return $scope;
    }

    /**
     * Return objects which are subject of removal.
     */
    protected function calcDeleted(iterable $related, iterable $original): array
    {
        $related = $this->extract($related);
        $original = $this->extract($original);
        return \array_udiff(
            $original ?? [],
            $related,
            // static fn(object $a, object $b): int => strcmp(spl_object_hash($a), spl_object_hash($b))
            static fn(object $a, object $b): int => (int) ($a === $b) - 1,
        );
    }
}