Arcanedev\LaravelNestedSet\Eloquent\Collection

Complexity

Total Complexity

20

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

65.45%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	linkNodes()	0	26	5
A	toTree()	0	21	4
B	getRootNodeId()	0	24	6
A	toFlattenedTree()	0	4	1
A	flattenTree()	0	10	2
A	flattenNode()	0	11	2

<?php namespace Arcanedev\LaravelNestedSet\Eloquent;

use Arcanedev\LaravelNestedSet\NodeTrait;
use Arcanedev\LaravelNestedSet\Utilities\NestedSet;
use Illuminate\Database\Eloquent\Collection as EloquentCollection;
use Illuminate\Database\Eloquent\Model;

/**
 * Class     Collection
 *
 * @package  Arcanedev\Taxonomies\Utilities
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class Collection extends EloquentCollection
{
    /**
     * Fill `parent` and `children` relationships for every node in the collection.
     *
     * This will overwrite any previously set relations.
     *
     * @return $this
     */
    public function linkNodes()
    {
        if ($this->isEmpty()) {
            return $this;
        }

        $groupedNodes = $this->groupBy($this->first()->getParentIdName());

        /** @var NodeTrait|Model $node */
        foreach ($this->items as $node) {
            if ( ! $node->getParentId()) {
                $node->setRelation('parent', null);
            }

            $children = $groupedNodes->get($node->getKey(), [ ]);

            /** @var Model|NodeTrait $child */
            foreach ($children as $child) {
                $child->setRelation('parent', $node);
            }

            $node->setRelation('children', EloquentCollection::make($children));
        }

        return $this;
    }

    /**
     * Build a tree from a list of nodes. Each item will have set children relation.
     * To successfully build tree "id", "_lft" and "parent_id" keys must present.
     * If `$root` is provided, the tree will contain only descendants of that node.
     *
     * @param  mixed  $root
     *
     * @return self
     */
    public function toTree($root = false)
    {
        if ($this->isEmpty()) {
            return new static;
        }

        $this->linkNodes();

        $items = [ ];

        $root = $this->getRootNodeId($root);

        /** @var Model|NodeTrait $node */
        foreach ($this->items as $node) {
            if ($node->getParentId() == $root) {
                $items[] = $node;
            }
        }

        return new static($items);
    }

    /**
     * Get root node id.
     *
     * @param  mixed  $root
     *
     * @return int
     */
    protected function getRootNodeId($root)
    {
        if (NestedSet::isNode($root)) {
            return $root->getKey();
        }

        if ($root !== false) {
            return $root;
        }

        // If root node is not specified we take parent id of node with
        // least lft value as root node id.
        $leastValue = null;

        /** @var Model|NodeTrait $node */
        foreach ($this->items as $node) {
            if ($leastValue === null || $node->getLft() < $leastValue) {
                $leastValue = $node->getLft();
                $root       = $node->getParentId();
            }
        }

        return $root;
    }

    /**
     * Build a list of nodes that retain the order that they were pulled from the database.
     *
     * @return self
     */
    public function toFlattenedTree()
    {
        return $this->toTree()->flattenTree();
    }

    /**
     * Flatten a tree into a non recursive array
     */
    public function flattenTree()
    {
        $items = [];

        foreach ($this->items as $node) {
            $items = array_merge($items, $this->flattenNode($node));
        }

        return new static($items);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Flatten a single node
     *
     * @param  \Arcanedev\LaravelNestedSet\NodeTrait  $node

The type NodeTrait for parameter $node is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     *
     * @return array
     */
    protected function flattenNode($node)
    {
        $items   = [];
        $items[] = $node;

        foreach ($node->children as $childNode) {

The property children does not seem to exist in Arcanedev\LaravelNestedSet\NodeTrait.

            $items = array_merge($items, $this->flattenNode($childNode));
        }

        return $items;
    }
}