chubbyphp / chubbyphp-model

src/Collection/LazyModelCollection.php

<?php

declare(strict_types=1);

namespace Chubbyphp\Model\Collection;

use Chubbyphp\Model\ModelInterface;
use Chubbyphp\Model\ResolverInterface;
use Chubbyphp\Model\ModelSortTrait;

final class LazyModelCollection implements ModelCollectionInterface
{
    use ModelSortTrait;

    /**
     * @var ResolverInterface
     */
    private $resolver;

    /**
     * @var string
     */
    private $modelClass;

    /**
     * @var string
     */
    private $foreignField;

    /**
     * @var string
     */
    private $foreignId;

    /**
     * @var array|null
     */
    private $orderBy;

    /**
     * @var bool
     */
    private $resolved = false;

    /**
     * @var ModelInterface[]|array
     */
    private $initialModels;

    /**
     * @var ModelInterface[]|array
     */
    private $models;

    /**
     * @var \ReflectionProperty
     */
    private $propertyReflection;

    /**
     * @param ResolverInterface $resolver
     * @param string            $modelClass
     * @param string            $foreignField
     * @param string            $foreignId
     * @param array|null        $orderBy
     */
    public function __construct(

This method seems to be duplicated in your project.

        ResolverInterface $resolver,
        string $modelClass,
        string $foreignField,
        string $foreignId,
        array $orderBy = null
    ) {
        $this->resolver = $resolver;
        $this->modelClass = $modelClass;
        $this->foreignField = $foreignField;
        $this->foreignId = $foreignId;
        $this->orderBy = $orderBy;

        $this->propertyReflection = new \ReflectionProperty($this->modelClass, $this->foreignField);
        $this->propertyReflection->setAccessible(true);
    }

    private function resolveModels()
    {
        if ($this->resolved) {
            return;
        }

        $this->resolved = true;

        $criteria = [$this->foreignField => $this->foreignId];

        $models = [];
        foreach ($this->resolver->findBy($this->modelClass, $criteria, $this->orderBy) as $model) {
            $models[$model->getId()] = $model;
        }

        $this->initialModels = $models;
        $this->models = $models;
    }

    /**
     * @param ModelInterface $model
     *
     * @return ModelCollectionInterface
     */
    public function addModel(ModelInterface $model): ModelCollectionInterface
    {
        $this->resolveModels();

        $this->propertyReflection->setValue($model, $this->foreignId);

        $this->models[$model->getId()] = $model;

        return $this;
    }

    /**
     * @param ModelInterface $model
     *
     * @return ModelCollectionInterface
     */
    public function removeModel(ModelInterface $model): ModelCollectionInterface

This method seems to be duplicated in your project.

    {
        $this->resolveModels();

        if (isset($this->models[$model->getId()])) {
            $this->propertyReflection->setValue($model, null);

            unset($this->models[$model->getId()]);
        }

        return $this;
    }

    /**
     * @param ModelInterface[]|array $models
     *
     * @return ModelCollectionInterface
     */
    public function setModels(array $models): ModelCollectionInterface

This method seems to be duplicated in your project.

    {
        $this->resolveModels();

        foreach ($this->models as $model) {
            $this->removeModel($model);
        }
        foreach ($models as $model) {
            $this->addModel($model);
        }

        return $this;
    }

    /**
     * @return ModelInterface[]|array
     */
    public function getModels(): array
    {
        $this->resolveModels();

        return $this->sort($this->modelClass, array_values($this->models), $this->orderBy);
    }

    /**
     * @return ModelInterface[]|array
     */
    public function getInitialModels(): array
    {
        $this->resolveModels();

        return array_values($this->initialModels);
    }

    /**
     * @return \ArrayIterator
     */
    public function getIterator()
    {
        $this->resolveModels();

        return new \ArrayIterator($this->getModels());
    }

    /**
     * @return int
     */
    public function count()
    {
        $this->resolveModels();

        return count($this->getModels());
    }

    /**
     * @return array
     */
    public function jsonSerialize(): array

This method seems to be duplicated in your project.

    {
        $this->jsonSerializableOrException();

        $this->resolveModels();

        $serializedModels = [];
        foreach ($this->getModels() as $model) {
            $serializedModels[] = $model->jsonSerialize();
        }

        return $serializedModels;
    }

    /**
     * @throws \LogicException
     */
    private function jsonSerializableOrException()

This method seems to be duplicated in your project.

    {
        $reflectionClass = new \ReflectionClass($this->modelClass);
        if (!$reflectionClass->implementsInterface(\JsonSerializable::class)) {
            throw new \LogicException(
                sprintf('Model %s does not implement %s', $this->modelClass, \JsonSerializable::class)
            );
        }
    }

    /**
     * @return string
     */
    public function getForeignField(): string
    {
        return $this->foreignField;
    }

    /**
     * @return string
     */
    public function getForeignId(): string
    {
        return $this->foreignId;
    }
}