Staudenmeir\LaravelAdjacencyList\IdeHelper\RecursiveRelationsHook

Complexity

Total Complexity

8

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	addRelationship()	0	19	2
A	run()	0	19	6

<?php

namespace Staudenmeir\LaravelAdjacencyList\IdeHelper;

use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;
use Staudenmeir\LaravelAdjacencyList\Eloquent\Collection as TreeCollection;
use Staudenmeir\LaravelAdjacencyList\Eloquent\Graph\Collection as GraphCollection;
use Staudenmeir\LaravelAdjacencyList\Eloquent\HasGraphRelationships;
use Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships;

/**
 * @template RT { name: string, manyRelation: boolean, comment: string }
 */
class RecursiveRelationsHook implements ModelHookInterface
{
    /**
     * @var array<array<RT>>
     */
    protected static array $treeRelationships = [
        [
            'name' => 'ancestors',
            'manyRelation' => true,
            'comment' => "The model's recursive parents.",
        ],
        [
            'name' => 'ancestorsAndSelf',
            'manyRelation' => true,
            'comment' => "The model's recursive parents and itself.",
        ],
        [
            'name' => 'bloodline',
            'manyRelation' => true,
            'comment' => "The model's ancestors, descendants and itself.",
        ],
        [
            'name' => 'children',
            'manyRelation' => true,
            'comment' => "The model's direct children.",
        ],
        [
            'name' => 'childrenAndSelf',
            'manyRelation' => true,
            'comment' => "The model's direct children and itself.",
        ],
        [
            'name' => 'descendants',
            'manyRelation' => true,
            'comment' => "The model's recursive children.",
        ],
        [
            'name' => 'descendantsAndSelf',
            'manyRelation' => true,
            'comment' => "The model's recursive children and itself.",
        ],
        [
            'name' => 'parent',
            'manyRelation' => false,
            'comment' => "The model's direct parent.",
        ],
        [
            'name' => 'parentAndSelf',
            'manyRelation' => true,
            'comment' => "The model's direct parent and itself.",
        ],
        [
            'name' => 'rootAncestor',
            'manyRelation' => false,
            'comment' => "The model's topmost parent.",
        ],
        [
            'name' => 'siblings',
            'manyRelation' => true,
            'comment' => "The parent's other children.",
        ],
        [
            'name' => 'siblingsAndSelf',
            'manyRelation' => true,
            'comment' => "All the parent's children.",
        ]
    ];

    /**
     * @var array<array<RT>>
     */
    protected static array $graphRelationships = [
        [
            'name' => 'ancestors',
            'manyRelation' => true,
            'comment' => "The node's recursive parents.",
        ],
        [
            'name' => 'ancestorsAndSelf',
            'manyRelation' => true,
            'comment' => "The node's recursive parents and itself.",
        ],
        [
            'name' => 'children',
            'manyRelation' => true,
            'comment' => "The node's direct children.",
        ],
        [
            'name' => 'childrenAndSelf',
            'manyRelation' => true,
            'comment' => "The node's direct children and itself.",
        ],
        [
            'name' => 'descendants',
            'manyRelation' => true,
            'comment' => "The node's recursive children.",
        ],
        [
            'name' => 'descendantsAndSelf',
            'manyRelation' => true,
            'comment' => "The node's recursive children and itself.",
        ],
        [
            'name' => 'parents',
            'manyRelation' => true,
            'comment' => "The node's direct parents.",
        ],
        [
            'name' => 'parentsAndSelf',
            'manyRelation' => true,
            'comment' => "The node's direct parents and itself.",
        ],
    ];

    public function run(ModelsCommand $command, Model $model): void
    {
        $traits = class_uses_recursive($model);

        if (in_array(HasRecursiveRelationships::class, $traits)) {
            foreach (static::$treeRelationships as $relationship) {
                $type = $relationship['manyRelation']
                    ? '\\' . TreeCollection::class . '|\\' . $model::class . '[]'
                    : '\\' . $model::class;

                $this->addRelationship($command, $relationship, $type);
            }
        }

        if (in_array(HasGraphRelationships::class, $traits)) {
            foreach (static::$graphRelationships as $relationship) {
                $type = '\\' . GraphCollection::class . '|\\' . $model::class . '[]';

                $this->addRelationship($command, $relationship, $type);
            }
        }
    }

    protected function addRelationship(ModelsCommand $command, array $relationship, string $type): void
    {
        $command->setProperty(
            $relationship['name'],
            $type,
            true,
            false,
            $relationship['comment'],
            !$relationship['manyRelation']
        );

        if ($relationship['manyRelation']) {
            $command->setProperty(
                Str::snake($relationship['name']) . '_count',
                'int',
                true,
                false,
                null,
                true
            );
        }
    }
}