Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits\IsAncestorRelation

Complexity

Total Complexity

20

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	matchOneOrMany()	0	17	4
A	getForeignKey()	0	3	1
A	addExpression()	0	7	3
A	getKeys()	0	6	1
A	getRelationExistenceQuery()	0	17	3
A	addEagerConstraints()	0	13	2
A	addConstraints()	0	10	3
A	getRelationExistenceQueryForSelfRelation()	0	23	3

<?php

namespace Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Query\Expression;

trait IsAncestorRelation
{
    use IsRecursiveRelation;

    /**
     * Set the base constraints on the relation query.
     *
     * @return void
     */
    public function addConstraints()
    {
        if (static::$constraints) {
            $constraint = function (Builder $query) {
                $key = $this->andSelf ? $this->getParentKey() : $this->getForeignKey();

The method getParentKey() does not exist on Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits\IsAncestorRelation. Since you implemented __call, consider adding a @method annotation.

                $query->where($this->getQualifiedLocalKeyName(), '=', $key);
            };

            $this->addExpression($constraint);
        }
    }

    /**
     * Set the constraints for an eager load of the relation.
     *
     * @param array $models
     * @return void
     */
    public function addEagerConstraints(array $models)
    {
        $whereIn = $this->whereInMethod($this->parent, $this->localKey);

The method whereInMethod() does not exist on Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits\IsAncestorRelation. Since you implemented __call, consider adding a @method annotation.

        $key = $this->andSelf ? $this->localKey : $this->getForeignKeyName();

The method getForeignKeyName() does not exist on Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits\IsAncestorRelation. Since you implemented __call, consider adding a @method annotation.

        $keys = $this->getKeys($models, $key);

        $constraint = function (Builder $query) use ($whereIn, $keys) {
            $query->$whereIn($this->getQualifiedLocalKeyName(), $keys);
        };

        $this->addExpression($constraint);
    }

    /**
     * Get all of the primary keys for an array of models.
     *
     * @param array $models
     * @param string $key
     * @return array
     */
    protected function getKeys(array $models, $key = null)
    {
        $keys = parent::getKeys($models, $key);

        return array_filter($keys, function ($value) {
            return !is_null($value);
        });
    }

    /**
     * Match the eagerly loaded results to their many parents.
     *
     * @param array $models
     * @param \Illuminate\Database\Eloquent\Collection $results
     * @param string $relation
     * @param string $type
     * @return array
     */
    public function matchOneOrMany(array $models, Collection $results, $relation, $type)
    {
        $dictionary = $this->buildDictionary($results);

        $attribute = $this->andSelf ? $this->localKey : $this->getForeignKeyName();

        foreach ($models as $model) {
            $key = $model->{$attribute};

            if (isset($dictionary[$key])) {
                $value = $this->getRelationValue($dictionary, $key, $type);

The method getRelationValue() does not exist on Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits\IsAncestorRelation. Since you implemented __call, consider adding a @method annotation.

                $model->setRelation($relation, $value);
            }
        }

        return $models;
    }

    /**
     * Add the constraints for a relationship query.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Illuminate\Database\Eloquent\Builder $parentQuery
     * @param array|mixed $columns
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function getRelationExistenceQuery(Builder $query, Builder $parentQuery, $columns = ['*'])
    {
        if ($query->getQuery()->from === $parentQuery->getQuery()->from) {
            return $this->getRelationExistenceQueryForSelfRelation($query, $parentQuery, $columns);
        }

        $key = $this->andSelf ? $this->localKey : $this->getForeignKeyName();

        $constraint = function (Builder $query) use ($key) {
            $query->whereColumn(
                $query->getQuery()->from.'.'.$this->localKey,

Are you sure $query->getQuery()->from of type Illuminate\Database\Query\Expression|string can be used in concatenation?

                '=',
                $this->parent->qualifyColumn($key)
            );
        };

        return $this->addExpression($constraint, $query->select($columns));

It seems like $query->select($columns) can also be of type Illuminate\Database\Query\Builder; however, parameter $query of Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits\IsAncestorRelation::addExpression() does only seem to accept Illuminate\Database\Eloquent\Builder|null, maybe add an additional type check?

    }

    /**
     * Add the constraints for a relationship query on the same table.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Illuminate\Database\Eloquent\Builder $parentQuery
     * @param array|mixed $columns
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, $columns = ['*'])
    {
        if ($columns instanceof Expression) {
            $columns = $this->replaceTableHash($query, $columns);
        }

        $table = $this->getRelationCountHash();

The method getRelationCountHash() does not exist on Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits\IsAncestorRelation. Since you implemented __call, consider adding a @method annotation.

        $from = $query->getModel()->getTable().' as '.$table;

        $query->getModel()->setTable($table);

        $key = $this->andSelf ? $this->localKey : $this->getForeignKeyName();

        $constraint = function (Builder $query) use ($table, $key) {
            $query->whereColumn(
                $table.'.'.$this->localKey,
                '=',
                $this->parent->qualifyColumn($key)
            );
        };

        return $this->addExpression($constraint, $query->select($columns), $from);

It seems like $query->select($columns) can also be of type Illuminate\Database\Query\Builder; however, parameter $query of Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Traits\IsAncestorRelation::addExpression() does only seem to accept Illuminate\Database\Eloquent\Builder|null, maybe add an additional type check?

    }

    /**
     * Add a recursive expression to the query.
     *
     * @param callable $constraint
     * @param \Illuminate\Database\Eloquent\Builder|null $query
     * @param string|null $from
     * @return \Illuminate\Database\Eloquent\Builder
     */
    protected function addExpression(callable $constraint, ?Builder $query = null, $from = null)
    {
        $query = $query ?: $this->query;

        $initialDepth = $this->andSelf ? 0 : -1;

        return $query->withRelationshipExpression('asc', $constraint, $initialDepth, $from);
    }

    /**
     * Get the key value of the parent's foreign key.
     *
     * @return mixed
     */
    public function getForeignKey()
    {
        return $this->parent->{$this->getForeignKeyName()};
    }
}