Umbrellio\LTree\Traits\HasTreeRelationships

Complexity

Total Complexity

6

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	belongsToParentsTree()	0	7	1
A	belongsToTree()	0	25	4
A	belongsToDescendantsTree()	0	12	1

<?php

declare(strict_types=1);

namespace Umbrellio\LTree\Traits;

use Illuminate\Database\Eloquent\Concerns\HasRelationships;
use Illuminate\Database\Eloquent\Model;
use Umbrellio\LTree\Exceptions\InvalidTraitInjectionClass;
use Umbrellio\LTree\Interfaces\LTreeModelInterface;
use Umbrellio\LTree\Relations\AbstractBelongsToTree;
use Umbrellio\LTree\Relations\BelongsToDescendantsTree;
use Umbrellio\LTree\Relations\BelongsToParentsTree;

/**
 * @mixin HasRelationships
 * @mixin LTreeModelTrait
 * @mixin Model
 */
trait HasTreeRelationships
{
    /**
     * @param null $ownerKey

Are you sure the doc-type for parameter $ownerKey is correct as it would always require null to be passed?

     * @return AbstractBelongsToTree
     *
     * @throws InvalidTraitInjectionClass
     */
    final protected function belongsToParentsTree(
        string $related,
        string $throwRelation,
        ?string $foreignKey = null,
        $ownerKey = null
    ) {
        return $this->belongsToTree(BelongsToParentsTree::class, $related, $throwRelation, $foreignKey, $ownerKey);
    }

    /**
     * @param null $ownerKey

Are you sure the doc-type for parameter $ownerKey is correct as it would always require null to be passed?

     * @return AbstractBelongsToTree
     *
     * @throws InvalidTraitInjectionClass
     */
    final protected function belongsToDescendantsTree(
        string $related,
        string $throwRelation,
        ?string $foreignKey = null,
        $ownerKey = null
    ) {
        return $this->belongsToTree(
            BelongsToDescendantsTree::class,
            $related,
            $throwRelation,
            $foreignKey,
            $ownerKey
        );
    }

    final private function belongsToTree(
        string $relationClass,
        string $related,
        string $throwRelation,
        ?string $foreignKey = null,
        $ownerKey = null
    ): AbstractBelongsToTree {
        $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?

        if (!$instance instanceof LTreeModelInterface) {
            throw new InvalidTraitInjectionClass(sprintf(
                'A class using this trait must implement an interface %s',
                LTreeModelInterface::class
            ));
        }

        if ($foreignKey === null) {
            $foreignKey = $this
                ->{$throwRelation}()
                ->getForeignKeyName();
        }

        $ownerKey = $ownerKey ?: $instance->getKeyName();

        return new $relationClass($instance->newQuery(), $this, $throwRelation, $foreignKey, $ownerKey);

The method newQuery() does not exist on Umbrellio\LTree\Interfaces\LTreeModelInterface.

    }
}