Cycle\ORM\Select\Loader\ManyToManyLoader

Complexity

Total Complexity

26

Size/Duplication

Total Lines	215
Duplicated Lines	0 %

Test Coverage

Coverage

97.87%

Importance

Changes	3
Bugs	2	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	loadChild()	0	8	2
A	__construct()	0	19	1
C	configureQuery()	0	91	14
A	__clone()	0	4	1
A	withContext()	0	13	1
A	loadRelation()	0	17	4
A	createNode()	0	6	1
A	mountColumns()	0	9	1
A	initNode()	0	7	1

<?php

declare(strict_types=1);

namespace Cycle\ORM\Select\Loader;

use Cycle\Database\Injection\Parameter;
use Cycle\Database\Query\SelectQuery;
use Cycle\ORM\Exception\LoaderException;
use Cycle\ORM\FactoryInterface;
use Cycle\ORM\Parser\AbstractNode;
use Cycle\ORM\Parser\SingularNode;
use Cycle\ORM\Service\SourceProviderInterface;
use Cycle\ORM\Relation;
use Cycle\ORM\SchemaInterface;
use Cycle\ORM\Select\JoinableLoader;
use Cycle\ORM\Select\LoaderInterface;
use Cycle\ORM\Select\Traits\OrderByTrait;
use Cycle\ORM\Select\Traits\WhereTrait;

/**
 * @internal
 */
class ManyToManyLoader extends JoinableLoader
{
    use OrderByTrait;
    use WhereTrait;

    /**
     * Default set of relation options. Child implementation might defined their of default options.
     */
    protected array $options = [
        'load' => false,
        'scope' => true,
        'method' => self::POSTLOAD,
        'minify' => true,
        'as' => null,
        'using' => null,
        'where' => null,
        'orderBy' => null,
        'pivot' => null,
    ];

    protected PivotLoader $pivot;

    public function __construct(
        SchemaInterface $ormSchema,
        SourceProviderInterface $sourceProvider,
        FactoryInterface $factory,
        string $name,
        string $target,
        array $schema,
    ) {
        parent::__construct($ormSchema, $sourceProvider, $factory, $name, $target, $schema);
        $this->pivot = new PivotLoader(
            $ormSchema,
            $sourceProvider,
            $factory,
            'pivot',
            $schema[Relation::THROUGH_ENTITY],
            $schema,
        );
        $this->options['where'] = $schema[Relation::WHERE] ?? [];
        $this->options['orderBy'] = $schema[Relation::ORDER_BY] ?? [];
    }

    public function withContext(LoaderInterface $parent, array $options = []): static
    {
        /** @var ManyToManyLoader $loader */
        $loader = parent::withContext($parent, $options);
        $loader->pivot = $loader->pivot->withContext(
            $loader,
            [
                'load' => $loader->isLoaded(),
                'method' => $options['method'] ?? self::JOIN,
            ] + ($options['pivot'] ?? []),
        );

        return $loader;

The expression return $loader returns the type Cycle\ORM\Select\AbstractLoader which includes types incompatible with the type-hinted return Cycle\ORM\Select\Loader\ManyToManyLoader.

    }

    public function loadRelation(
        string|LoaderInterface $relation,
        array $options,
        bool $join = false,
        bool $load = false,
    ): LoaderInterface {
        if ($relation === '@' || $relation === '@.@') {
            unset($options['method']);
            if ($options !== []) {
                // re-configure
                $this->pivot = $this->pivot->withContext($this, $options);
            }

            return $this->pivot;
        }

        return parent::loadRelation($relation, $options, $join, $load);
    }

    public function configureQuery(SelectQuery $query, array $outerKeys = []): SelectQuery
    {
        if ($this->isLoaded() && $this->isJoined() && (int) $query->getLimit() !== 0) {
            throw new LoaderException('Unable to load data using join with limit on parent query');
        }

        if ($this->options['using'] !== null) {
            // use pre-defined query
            return parent::configureQuery($this->pivot->configureQuery($query), $outerKeys);
        }


        $localPrefix = $this->getAlias() . '.';
        $pivotPrefix = $this->pivot->getAlias() . '.';

        // Manually join pivoted table
        if ($this->isJoined()) {
            $parentKeys = (array) $this->schema[Relation::INNER_KEY];
            $throughOuterKeys = (array) $this->pivot->schema[Relation::THROUGH_OUTER_KEY];
            $parentPrefix = $this->parent->getAlias() . '.';

The method getAlias() does not exist on null.

            $on = [];
            foreach ((array) $this->pivot->schema[Relation::THROUGH_INNER_KEY] as $i => $key) {
                $field = $pivotPrefix . $this->pivot->fieldAlias($key);
                $on[$field] = $parentPrefix . $this->parent->fieldAlias($parentKeys[$i]);
            }

            $query->join(
                $this->getJoinMethod(),
                $this->pivot->getJoinTable(),
            )->on($on);

            $on = [];
            foreach ((array) $this->schema[Relation::OUTER_KEY] as $i => $key) {
                $field = $localPrefix . $this->fieldAlias($key);
                $on[$field] = $pivotPrefix . $this->pivot->fieldAlias($throughOuterKeys[$i]);
            }

            $query->join(
                $this->getJoinMethod(),
                $this->getJoinTable(),
            )->on($on);
        } elseif ($outerKeys !== []) {
            // reset all the columns when query is isolated (we have to do it manually
            // since underlying loader believes it's loaded)
            $query->columns([]);

            $outerKeyList = (array) $this->schema[Relation::OUTER_KEY];
            $on = [];
            foreach ((array) $this->pivot->schema[Relation::THROUGH_OUTER_KEY] as $i => $key) {
                $field = $pivotPrefix . $this->pivot->fieldAlias($key);
                $on[$field] = $localPrefix . $this->fieldAlias($outerKeyList[$i]);
            }

            $query->join(
                $this->getJoinMethod(),
                $this->pivot->getJoinTable(),
            )->on($on);

            $fields = [];
            foreach ((array) $this->pivot->schema[Relation::THROUGH_INNER_KEY] as $key) {
                $fields[] = $pivotPrefix . $this->pivot->fieldAlias($key);
            }

            if (\count($fields) === 1) {
                $query->andWhere($fields[0], 'IN', new Parameter(\array_column($outerKeys, \key($outerKeys[0]))));
            } else {
                $query->andWhere(
                    static function (SelectQuery $select) use ($outerKeys, $fields): void {
                        foreach ($outerKeys as $set) {
                            $select->orWhere(\array_combine($fields, \array_values($set)));
                        }
                    },
                );
            }
        }

        // user specified WHERE conditions
        $this->setWhere(
            $query,
            $this->isJoined() ? 'onWhere' : 'where',
            $this->options['where'] ?? $this->schema[Relation::WHERE] ?? [],
        );

        // user specified ORDER_BY rules
        $this->setOrderBy(
            $query,
            $this->getAlias(),
            $this->options['orderBy'] ?? $this->schema[Relation::ORDER_BY] ?? [],
        );

        return parent::configureQuery($this->pivot->configureQuery($query));
    }

    public function createNode(): AbstractNode
    {
        $node = $this->pivot->createNode();
        $node->joinNode('@', parent::createNode());

        return $node;
    }

    /**
     * Make sure that pivot loader is always carried with parent relation.
     */
    public function __clone()
    {
        parent::__clone();
        $this->pivot = clone $this->pivot;
    }

    protected function loadChild(AbstractNode $node, bool $includeRole = false): void
    {
        $rootNode = $node->getNode('@');
        foreach ($this->load as $relation => $loader) {
            $loader->loadData($rootNode->getNode($relation), $includeRole);
        }

        $this->pivot->loadChild($node, $includeRole);
    }

    protected function mountColumns(
        SelectQuery $query,
        bool $minify = false,
        string $prefix = '',
        bool $overwrite = false,

The parameter $overwrite is not used and could be removed.

        bool $addToGroup = false,
    ): SelectQuery {
        // columns are reset on earlier stage to allow pivot loader mount it's own aliases
        return parent::mountColumns($query, $minify, $prefix, false, $addToGroup);
    }

    protected function initNode(): AbstractNode
    {
        return new SingularNode(
            $this->columnNames(),
            (array) $this->define(SchemaInterface::PRIMARY_KEY),
            (array) $this->schema[Relation::OUTER_KEY],
            (array) $this->schema[Relation::THROUGH_OUTER_KEY],
        );
    }
}