Cycle\ORM\Collection\ArrayCollectionFactory

Complexity

Total Complexity

3

Size/Duplication

Total Lines	21
Duplicated Lines	0 %

Test Coverage

Coverage

75%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	withCollectionClass()	0	3	1
A	getInterface()	0	3	1
A	collect()	0	6	1

<?php

declare(strict_types=1);

namespace Cycle\ORM\Collection;

use Cycle\ORM\Exception\CollectionFactoryException;

/**
 * Stores related items to array.
 * In the case of a relation loaded lazily in a proxy mapper,
 * you should note that writing to such array collection should take place after an overloading:
 *
 *     // {$user->posts} is not loaded
 *
 *     // Bad code:
 *     // Exception or notice will be thrown
 *     // because the {$user->posts} value comes from a __get method.
 *     $user->posts[] = new Post;
 *
 *
 *     // Bad code:
 *     // Exception or notice will be thrown
 *     // because the {$user->posts} value comes from a __get method.
 *     $posts = &$user->posts;
 *
 *
 *     // Correct example:
 *     $user->post; // Resolve relation. It can be any `reading` code
 *     $user->post[] = new Post;
 *
 * @template TCollection of array
 *
 * @template-implements CollectionFactoryInterface<TCollection>
 */
final class ArrayCollectionFactory implements CollectionFactoryInterface
{
    public function getInterface(): ?string
    {
        return null;
    }

    /**
     * @psalm-param string $class
     */
    public function withCollectionClass(string $class): static
    {
        return $this;
    }

    public function collect(iterable $data): array
    {
        return match (true) {
            \is_array($data) => $data,
            $data instanceof \Traversable => \iterator_to_array($data),
            default => throw new CollectionFactoryException('Unsupported iterable type.'),
        };
    }
}