Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships

Complexity

Total Complexity

34

Size/Duplication

Total Lines	402
Duplicated Lines	0 %

Test Coverage

Coverage

98.02%

Importance

Changes	2
Bugs	0	Features	0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	hasManyOfDescendantsAndSelf()	0	14	3
A	getQualifiedLocalKeyName()	0	3	1
A	newHasManyOfDescendants()	0	3	1
A	getLocalKeyName()	0	3	1
A	hasManyOfDescendants()	0	14	3
A	rootAncestor()	0	7	1
A	getCustomPaths()	0	3	1
A	newRootAncestor()	0	3	1
A	siblings()	0	8	1
A	descendants()	0	8	1
A	getFirstPathSegment()	0	5	1
A	getQualifiedParentKeyName()	0	3	1
A	siblingsAndSelf()	0	8	1
A	getPathName()	0	3	1
A	newDescendants()	0	3	1
A	descendantsAndSelf()	0	8	1
A	newSiblings()	0	3	1
A	getExpressionName()	0	3	1
A	newEloquentBuilder()	0	3	1
A	newAncestors()	0	3	1
A	parentAndSelf()	0	3	1
A	getPathSeparator()	0	3	1
A	ancestors()	0	8	1
A	children()	0	3	1
A	ancestorsAndSelf()	0	8	1
A	parent()	0	3	1
A	hasNestedPath()	0	5	1
A	getDepthName()	0	3	1
A	childrenAndSelf()	0	3	1
A	getParentKeyName()	0	3	1

<?php

namespace Staudenmeir\LaravelAdjacencyList\Eloquent;

use Illuminate\Database\Eloquent\Builder;

This use statement conflicts with another class in this namespace, Staudenmeir\LaravelAdjacencyList\Eloquent\Builder. Consider defining an alias.

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;
use Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors;
use Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Descendants;
use Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\HasManyOfDescendants;
use Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\RootAncestor;
use Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Siblings;
use Staudenmeir\LaravelCte\Eloquent\QueriesExpressions;

trait HasRecursiveRelationships
{
    use HasRecursiveRelationshipScopes, QueriesExpressions;

    /**
     * Get the name of the parent key column.
     *
     * @return string
     */
    public function getParentKeyName()
    {
        return 'parent_id';
    }

    /**
     * Get the qualified parent key column.
     *
     * @return string
     */
    public function getQualifiedParentKeyName()
    {
        return (new static)->getTable().'.'.$this->getParentKeyName();

It seems like getTable() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Get the name of the local key column.
     *
     * @return string
     */
    public function getLocalKeyName()
    {
        return $this->getKeyName();

It seems like getKeyName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Get the qualified local key column.
     *
     * @return string
     */
    public function getQualifiedLocalKeyName()
    {
        return $this->qualifyColumn($this->getLocalKeyName());

It seems like qualifyColumn() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Get the name of the depth column.
     *
     * @return string
     */
    public function getDepthName()
    {
        return 'depth';
    }

    /**
     * Get the name of the path column.
     *
     * @return string
     */
    public function getPathName()
    {
        return 'path';
    }

    /**
     * Get the path separator.
     *
     * @return string
     */
    public function getPathSeparator()
    {
        return '.';
    }

    /**
     * Get the additional custom paths.
     *
     * @return array
     */
    public function getCustomPaths()
    {
        return [];
    }

    /**
     * Get the name of the common table expression.
     *
     * @return string
     */
    public function getExpressionName()
    {
        return 'laravel_cte';
    }
    
    /**
     * Get the model's ancestors.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors
     */
    public function ancestors()
    {
        return $this->newAncestors(
            (new static)->newQuery(),

It seems like newQuery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newAncestors().

            $this->getQualifiedParentKeyName(),
            $this->getLocalKeyName(),
            false
        );
    }

    /**
     * Get the model's ancestors and itself.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors
     */
    public function ancestorsAndSelf()
    {
        return $this->newAncestors(
            (new static)->newQuery(),
            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newAncestors().

            $this->getQualifiedParentKeyName(),
            $this->getLocalKeyName(),
            true
        );
    }

    /**
     * Instantiate a new Ancestors relationship.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Illuminate\Database\Eloquent\Model $parent
     * @param string $foreignKey
     * @param string $localKey
     * @param bool $andSelf
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors
     */
    protected function newAncestors(Builder $query, Model $parent, $foreignKey, $localKey, $andSelf)
    {
        return new Ancestors($query, $parent, $foreignKey, $localKey, $andSelf);
    }

    /**
     * Get the model's children.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function children()
    {
        return $this->hasMany(static::class, $this->getParentKeyName(), $this->getLocalKeyName());

The method hasMany() does not exist on Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships. Did you maybe mean hasManyOfDescendantsAndSelf()?

    }

    /**
     * Get the model's children and itself.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Descendants
     */
    public function childrenAndSelf()
    {
        return $this->descendantsAndSelf()->whereDepth('<=', 1);

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

    }

    /**
     * Get the model's descendants.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Descendants
     */
    public function descendants()
    {
        return $this->newDescendants(
            (new static)->newQuery(),
            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newDescendants().

            $this->getQualifiedParentKeyName(),
            $this->getLocalKeyName(),
            false
        );
    }

    /**
     * Get the model's descendants and itself.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Descendants
     */
    public function descendantsAndSelf()
    {
        return $this->newDescendants(
            (new static)->newQuery(),
            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newDescendants().

            $this->getQualifiedParentKeyName(),
            $this->getLocalKeyName(),
            true
        );
    }

    /**
     * Instantiate a new Descendants relationship.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Illuminate\Database\Eloquent\Model $parent
     * @param string $foreignKey
     * @param string $localKey
     * @param bool $andSelf
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Descendants
     */
    protected function newDescendants(Builder $query, Model $parent, $foreignKey, $localKey, $andSelf)
    {
        return new Descendants($query, $parent, $foreignKey, $localKey, $andSelf);
    }

    /**
     * Get the model's parent.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function parent()
    {
        return $this->belongsTo(static::class, $this->getParentKeyName(), $this->getLocalKeyName());

It seems like belongsTo() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Get the model's parent and itself.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors
     */
    public function parentAndSelf()
    {
        return $this->ancestorsAndSelf()->whereDepth('>=', -1);

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

    }

    /**
     * Get the model's root ancestor.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\RootAncestor
     */
    public function rootAncestor()
    {
        return $this->newRootAncestor(
            (new static)->newQuery(),
            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newRootAncestor().

            $this->getQualifiedParentKeyName(),
            $this->getLocalKeyName()
        );
    }

    /**
     * Instantiate a new RootAncestor relationship.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Illuminate\Database\Eloquent\Model $parent
     * @param string $foreignKey
     * @param string $localKey
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\RootAncestor
     */
    protected function newRootAncestor(Builder $query, Model $parent, $foreignKey, $localKey)
    {
        return new RootAncestor($query, $parent, $foreignKey, $localKey);
    }

    /**
     * Get the model's siblings.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Siblings
     */
    public function siblings()
    {
        return $this->newSiblings(
            (new static)->newQuery(),
            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newSiblings().

            $this->getQualifiedParentKeyName(),
            $this->getParentKeyName(),
            false
        );
    }

    /**
     * Get the model's siblings and itself.
     *
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Siblings
     */
    public function siblingsAndSelf()
    {
        return $this->newSiblings(
            (new static)->newQuery(),
            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newSiblings().

            $this->getQualifiedParentKeyName(),
            $this->getParentKeyName(),
            true
        );
    }

    /**
     * Instantiate a new Siblings relationship.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Illuminate\Database\Eloquent\Model $parent
     * @param string $foreignKey
     * @param string $localKey
     * @param bool $andSelf
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Siblings
     */
    protected function newSiblings(Builder $query, Model $parent, $foreignKey, $localKey, $andSelf)
    {
        return new Siblings($query, $parent, $foreignKey, $localKey, $andSelf);
    }

    /**
     * Define a one-to-many relationship of the model's descendants.
     *
     * @param string $related
     * @param string|null $foreignKey
     * @param string|null $localKey
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\HasManyOfDescendants
     */
    public function hasManyOfDescendants($related, $foreignKey = null, $localKey = null)
    {
        $instance = $this->newRelatedInstance($related);

It seems like newRelatedInstance() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $foreignKey = $foreignKey ?: $this->getForeignKey();

It seems like getForeignKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $localKey = $localKey ?: $this->getKeyName();

        return $this->newHasManyOfDescendants(
            $instance->newQuery(),
            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newHasManyOfDescendants().

            $instance->qualifyColumn($foreignKey),
            $localKey,
            false
        );
    }

    /**
     * Define a one-to-many relationship of the model's descendants and itself.
     *
     * @param string $related
     * @param string|null $foreignKey
     * @param string|null $localKey
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\HasManyOfDescendants
     */
    public function hasManyOfDescendantsAndSelf($related, $foreignKey = null, $localKey = null)
    {
        $instance = $this->newRelatedInstance($related);

        $foreignKey = $foreignKey ?: $this->getForeignKey();

        $localKey = $localKey ?: $this->getKeyName();

        return $this->newHasManyOfDescendants(
            $instance->newQuery(),
            $this,

$this of type Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships::newHasManyOfDescendants().

            $instance->qualifyColumn($foreignKey),
            $localKey,
            true
        );
    }

    /**
     * Instantiate a new HasManyOfDescendants relationship.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Illuminate\Database\Eloquent\Model $parent
     * @param string $foreignKey
     * @param string $localKey
     * @param bool $andSelf
     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\HasManyOfDescendants
     */
    protected function newHasManyOfDescendants(Builder $query, Model $parent, $foreignKey, $localKey, $andSelf)
    {
        return new HasManyOfDescendants($query, $parent, $foreignKey, $localKey, $andSelf);
    }

    /**
     * Get the first segment of the model's path.
     *
     * @return string
     */
    public function getFirstPathSegment()
    {
        $path = $this->attributes[$this->getPathName()];

        return explode($this->getPathSeparator(), $path)[0];
    }

    /**
     * Determine whether the model's path is nested.
     *
     * @return bool
     */
    public function hasNestedPath()
    {
        $path = $this->attributes[$this->getPathName()];

        return Str::contains($path, $this->getPathSeparator());
    }

    /**
     * Create a new Eloquent query builder for the model.
     *
     * @param \Illuminate\Database\Query\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder|static
     */
    public function newEloquentBuilder($query)
    {
        return new \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder($query);
    }
}