Bdf\Prime\Relations\MorphTo

Complexity

Total Complexity

15

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Test Coverage

Coverage

98.11%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	loadDistantFromType()	0	5	1
A	link()	0	9	2
A	relationQuery()	0	3	1
A	loadDistantFrom()	0	5	1
A	deleteAll()	0	7	1
A	updateDistantInfos()	0	8	2
A	join()	0	15	2
A	joinRepositories()	0	6	1
A	saveAll()	0	7	1
A	load()	0	18	3

<?php

namespace Bdf\Prime\Relations;

use Bdf\Prime\Collection\Indexer\EntityIndexer;
use Bdf\Prime\Collection\Indexer\EntityIndexerInterface;
use Bdf\Prime\Query\Contract\EntityJoinable;
use Bdf\Prime\Query\Contract\ReadOperation;
use Bdf\Prime\Query\Contract\WriteOperation;
use Bdf\Prime\Query\ReadCommandInterface;
use InvalidArgumentException;
use LogicException;

/**
 * MorphTo
 */
class MorphTo extends BelongsTo
{
    /**

Parameter $query should have a doc-comment as per coding-style.

Parameter $alias should have a doc-comment as per coding-style.

     * {@inheritdoc}
     *
     * The alias should have #[sub entity] at its end

Doc comment long description must end with a full stop

     */

Missing @throws tag in function comment

    public function join(EntityJoinable $query, string $alias): void

Expected 1 blank line before function; 0 found

    {
        $parts = explode('#', $alias);

        if (!isset($parts[1])) {
            throw new LogicException('Joins are not supported on polymorph without discriminator');
        }

        $this->loadDistantFromType(end($parts));

        //TODO should be in join clause

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

No space found before comment text; expected "// TODO should be in join clause" but found "//TODO should be in join clause"

        $query->where($this->getLocalAlias($query).$this->discriminator, $this->discriminatorValue);

        // Join to the real alias (i.e. without the discriminator)
        parent::join($query, $parts[0]);
    }

    /**

Parameter $alias should have a doc-comment as per coding-style.

Parameter $query should have a doc-comment as per coding-style.

Parameter $discriminator should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function joinRepositories(EntityJoinable $query, string $alias, $discriminator = null): array

The method parameter $query is never used

    {
        $this->loadDistantFromType($discriminator);

        return [
            $alias => $this->relationRepository()

A comma should follow the last multiline array item. Found: )

        ];
    }

    /**
     * {@inheritdoc}
     */
    #[ReadOperation]
    public function load(EntityIndexerInterface $collection, array $with = [], $constraints = [], array $without = []): void
    {
        if ($collection->empty()) {
            return;
        }

        $with = $this->rearrangeWith($with);
        $without = $this->rearrangeWithout($without);

        foreach ($collection->by($this->discriminator) as $type => $chunk) {
            $this->loadDistantFromType($type);

            parent::load(
                EntityIndexer::fromArray($this->local->mapper(), $chunk),
                $with[$type],
                $constraints,
                $without[$type]
            );
        }
    }

    /**

Parameter $owner should have a doc-comment as per coding-style.

     * {@inheritdoc}
     *
     * @fixme Do not works with EntityCollection

Comment refers to a FIXME task

     */

Missing @throws tag in function comment

    public function link($owner): ReadCommandInterface
    {
        if (is_array($owner)) {
            throw new InvalidArgumentException('MorphTo relation do not supports querying on collection');
        }

        $this->loadDistantFrom($owner);

        return parent::link($owner);
    }

    /**
     * {@inheritdoc}
     */
    #[WriteOperation]
    public function saveAll($owner, array $relations = []): int
    {
        $relations = $this->rearrangeWith($relations);
        $this->loadDistantFrom($owner);

        return parent::saveAll($owner, $relations[$this->discriminatorValue]);
    }

    /**
     * {@inheritdoc}
     */
    #[WriteOperation]
    public function deleteAll($owner, array $relations = []): int
    {
        $relations = $this->rearrangeWith($relations);
        $this->loadDistantFrom($owner);

        return parent::deleteAll($owner, $relations[$this->discriminatorValue]);
    }

    /**
     * Change the current discriminator value 
     * and update the distant repository of this relation
     * 
     * @param mixed $type
     */
    protected function loadDistantFromType($type)
    {
        $this->discriminatorValue = $type;

        $this->updateDistantInfos();
    }

    /**
     * Change the current discriminator value from the entity
     * and update the distant repository of this relation
     * 
     * @param object $entity
     */
    protected function loadDistantFrom($entity)
    {
        $this->updateDiscriminatorValue($entity);

        $this->updateDistantInfos();
    }

    /**
     * Update the distant repository of this relation
     */
    protected function updateDistantInfos()
    {
        $infos = $this->map($this->discriminatorValue);

        $this->distant    = $this->local->repository($infos['entity']);
        $this->distantKey = $infos['distantKey'];

        $this->setConstraints(isset($infos['constraints']) ? $infos['constraints'] : []);
    }

    /**

Parameter $constraints should have a doc-comment as per coding-style.

Parameter $keys should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    protected function relationQuery($keys, $constraints): ReadCommandInterface
    {
        return $this->query($keys, $constraints)->by($this->distantKey);

The method by() does not exist on Bdf\Prime\Query\QueryInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Bdf\Prime\Query\SqlQueryInterface. Are you sure you never get one of those?

    }
}