AutoTreeTrait::appendTo() - Code Metrics - Inspection of ""with" parameter to populateTree sighnature #5" - paulzi/yii2-auto-tree - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

unknown

created 2018-08-09 20:43 UTC

AutoTreeTrait::appendTo() A

↳ Parent: AutoTreeTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	1
cts	1
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

namespace paulzi\autotree;

use yii\base\InvalidCallException;

trait AutoTreeTrait
{
    /**
     * @var \yii\base\Behavior[]
     */
    private $_autoTreeMap;

    private $_autoTreeReturnBehavior = false;


    /**
     * @return array
     */
    private static function autoTreeAliases()
    {
        return [
            'paulzi\adjacencyList\AdjacencyListBehavior'       => 'al',
            'paulzi\adjacencylist\AdjacencyListBehavior'       => 'al',
            'paulzi\nestedSets\NestedSetsBehavior'             => 'ns',
            'paulzi\nestedsets\NestedSetsBehavior'             => 'ns',
            'paulzi\nestedIntervals\NestedIntervalsBehavior'   => 'ni',
            'paulzi\nestedintervals\NestedIntervalsBehavior'   => 'ni',
            'paulzi\materializedPath\MaterializedPathBehavior' => 'mp',
            'paulzi\materializedpath\MaterializedPathBehavior' => 'mp',
        ];
    }

    /**
     *
     */
    private function autoTreeInit()
    {
        /** @var \yii\base\Component|self $this */
        $aliases = $this->autoTreeAliases();
        foreach ($this->getBehaviors() as $behavior) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $className = $behavior::className();
            if (isset($aliases[$className]) && !isset($this->_autoTreeMap[$aliases[$className]])) {
                $this->_autoTreeMap[$aliases[$className]] = $behavior;
            }
        }
    }

    /**
     * @param string $method
     * @param array $list
     * @param array $arguments
     * @param bool $firstOnly
     * @return mixed
     */
    private function autoTreeCall($method, $list, $arguments = [], $firstOnly = true)
    {
        if ($this->_autoTreeMap === null) {
            $this->autoTreeInit();
        }

        $result  = null;
        $founded = false;
        foreach ($list as $alias) {
            if (isset($this->_autoTreeMap[$alias])) {
                $behavior = $this->_autoTreeMap[$alias];
                if (method_exists($behavior, $method)) {
                    if ($this->_autoTreeReturnBehavior) {
                        return $behavior;
                    }
                    $founded = true;
                    $result = call_user_func_array([$behavior, $method], $arguments);
                    if ($firstOnly) {
                        return $result;
                    }
                }
            }
        }

        if (!$founded) {
            throw new InvalidCallException("Method '{$method}' not founded");
        }

        return $result;
    }

    /**
     * @inheritdoc
     */
    public function __get($name)
    {
        /** @var \yii\db\BaseActiveRecord|self $this */
        // replace getParents() by getParentsOrdered() if behavior not support ordered query
        if ($name === 'parents') {

            $this->_autoTreeReturnBehavior = true;
            $behavior = $this->getParents();
            $this->_autoTreeReturnBehavior = false;
            if (method_exists($behavior, 'getParentsOrdered')) {
                $this->populateRelation($name, $behavior->getParentsOrdered());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }
        if ($name === 'descendants') {

            $this->_autoTreeReturnBehavior = true;
            $behavior = $this->getDescendants();
            $this->_autoTreeReturnBehavior = false;
            if (method_exists($behavior, 'getDescendantsOrdered')) {
                $this->populateRelation($name, $behavior->getDescendantsOrdered());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }
        return parent::__get($name);
    }

    /**
     * @param int|null $depth
     * @return \yii\db\ActiveQuery
     */
    public function getParents($depth = null)
    {
        return $this->autoTreeCall('getParents', ['mp', 'ns', 'ni', 'al'], [$depth]);
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getParent()
    {
        return $this->autoTreeCall('getParent', ['al', 'mp', 'ns', 'ni']);
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getRoot()
    {
        return $this->autoTreeCall('getRoot', ['mp', 'ns', 'ni', 'al']);
    }

    /**
     * @param int|null $depth
     * @param bool $andSelf
     * @return \yii\db\ActiveQuery
     */
    public function getDescendants($depth = null, $andSelf = false)
    {
        return $this->autoTreeCall('getDescendants', ['ns', 'ni', 'mp', 'al'], [$depth, $andSelf]);
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getChildren()
    {
        return $this->autoTreeCall('getChildren', ['al', 'ns', 'ni', 'mp']);
    }

    /**
     * @param int|null $depth
     * @return \yii\db\ActiveQuery
     */
    public function getLeaves($depth = null)
    {
        return $this->autoTreeCall('getLeaves', ['ns', 'al', 'mp', 'ni'], [$depth]);
    }

    /**
     * @return \yii\db\ActiveQuery
     * @throws \yii\base\NotSupportedException
     */
    public function getPrev()
    {
        return $this->autoTreeCall('getPrev', ['ns', 'mp', 'ni', 'al']);
    }

    /**
     * @return \yii\db\ActiveQuery
     * @throws \yii\base\NotSupportedException
     */
    public function getNext()
    {
        return $this->autoTreeCall('getNext', ['ns', 'mp', 'ni', 'al']);
    }

    /**
     * Populate children relations for self and all descendants
     * @param int $depth = null
     * @param string|array $with = null
     * @return self
     */
    public function populateTree($depth = null, $with = null)
    {
        return $this->autoTreeCall('populateTree', ['ns', 'ni', 'mp', 'al'], [$depth, $with]);
    }

    /**
     * @return bool
     */
    public function isRoot()
    {
        return $this->autoTreeCall('isRoot', ['al', 'ns', 'ni', 'mp']);
    }

    /**
     * @param \yii\db\BaseActiveRecord $node
     * @return bool
     */
    public function isChildOf($node)
    {
        return $this->autoTreeCall('isChildOf', ['ns', 'ni', 'mp', 'al'], [$node]);
    }

    /**
     * @return bool
     */
    public function isLeaf()
    {
        return $this->autoTreeCall('isLeaf', ['ns', 'al', 'ni', 'mp']);
    }

    /**
     * @return $this
     */
    public function makeRoot()
    {
        return $this->autoTreeCall('makeRoot', ['al', 'ns', 'ni', 'mp'], [], false);
    }

    /**
     * @param \yii\db\BaseActiveRecord $node
     * @return $this
     */
    public function prependTo($node)
    {
        return $this->autoTreeCall('prependTo', ['al', 'ns', 'ni', 'mp'], [$node], false);
    }

    /**
     * @param \yii\db\BaseActiveRecord $node
     * @return $this
     */
    public function appendTo($node)
    {
        return $this->autoTreeCall('appendTo', ['al', 'ns', 'ni', 'mp'], [$node], false);
    }

    /**
     * @param \yii\db\BaseActiveRecord $node
     * @return $this
     */
    public function insertBefore($node)
    {
        return $this->autoTreeCall('insertBefore', ['al', 'ns', 'ni', 'mp'], [$node], false);
    }

    /**
     * @param \yii\db\BaseActiveRecord $node
     * @return $this
     */
    public function insertAfter($node)
    {
        return $this->autoTreeCall('insertAfter', ['al', 'ns', 'ni', 'mp'], [$node], false);
    }

    /**
     * @return bool|int
     * @throws \Exception
     * @throws \yii\db\Exception
     */
    public function deleteWithChildren()
    {
        /** @var \yii\db\BaseActiveRecord|self $this */
        $this->autoTreeCall('preDeleteWithChildren', ['ns', 'ni', 'mp', 'al'], [], false);
        return $this->autoTreeCall('deleteWithChildren', ['ns', 'ni', 'mp', 'al']);
    }
}


1			<?php
2
3			namespace paulzi\autotree;
4
5			use yii\base\InvalidCallException;
6
7			trait AutoTreeTrait
8			{
9			/**
10			* @var \yii\base\Behavior[]
11			*/
12			private $_autoTreeMap;
13
14			private $_autoTreeReturnBehavior = false;
15
16
17			/**
18			* @return array
19			*/
20	61		private static function autoTreeAliases()
21			{
22			return [
23	61		'paulzi\adjacencyList\AdjacencyListBehavior' => 'al',
24	61		'paulzi\adjacencylist\AdjacencyListBehavior' => 'al',
25	61		'paulzi\nestedSets\NestedSetsBehavior' => 'ns',
26	61		'paulzi\nestedsets\NestedSetsBehavior' => 'ns',
27	61		'paulzi\nestedIntervals\NestedIntervalsBehavior' => 'ni',
28	61		'paulzi\nestedintervals\NestedIntervalsBehavior' => 'ni',
29	61		'paulzi\materializedPath\MaterializedPathBehavior' => 'mp',
30	61		'paulzi\materializedpath\MaterializedPathBehavior' => 'mp',
31	61		];
32			}
33
34			/**
35			*
36			*/
37	61		private function autoTreeInit()
38			{
39			/** @var \yii\base\Component\|self $this */
40	61		$aliases = $this->autoTreeAliases();
41	61		foreach ($this->getBehaviors() as $behavior) {
			0 ignored issues – show Bug introduced 2015-12-11 17:02 UTC by Report Bug Copy Issue Report It seems like `getBehaviors()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
42	61		$className = $behavior::className();
43	61		if (isset($aliases[$className]) && !isset($this->_autoTreeMap[$aliases[$className]])) {
44	61		$this->_autoTreeMap[$aliases[$className]] = $behavior;
45	61		}
46	61		}
47	61		}
48
49			/**
50			* @param string $method
51			* @param array $list
52			* @param array $arguments
53			* @param bool $firstOnly
54			* @return mixed
55			*/
56	61		private function autoTreeCall($method, $list, $arguments = [], $firstOnly = true)
57			{
58	61		if ($this->_autoTreeMap === null) {
59	61		$this->autoTreeInit();
60	61		}
61
62	61		$result = null;
63	61		$founded = false;
64	61		foreach ($list as $alias) {
65	61		if (isset($this->_autoTreeMap[$alias])) {
66	61		$behavior = $this->_autoTreeMap[$alias];
67	61		if (method_exists($behavior, $method)) {
68	61		if ($this->_autoTreeReturnBehavior) {
69	6		return $behavior;
70			}
71	61		$founded = true;
72	61		$result = call_user_func_array([$behavior, $method], $arguments);
73	61		if ($firstOnly) {
74	53		return $result;
75			}
76	27		}
77	27		}
78	43		}
79
80	27		if (!$founded) {
81			throw new InvalidCallException("Method '{$method}' not founded");
82			}
83
84	27		return $result;
85			}
86
87			/**
88			* @inheritdoc
89			*/
90	51		public function __get($name)
91			{
92			/** @var \yii\db\BaseActiveRecord\|self $this */
93			// replace getParents() by getParentsOrdered() if behavior not support ordered query
94	51	View Code Duplication	if ($name === 'parents') {
			0 ignored issues – show Duplication introduced 2015-12-11 17:02 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95	3		$this->_autoTreeReturnBehavior = true;
96	3		$behavior = $this->getParents();
97	3		$this->_autoTreeReturnBehavior = false;
98	3		if (method_exists($behavior, 'getParentsOrdered')) {
99			$this->populateRelation($name, $behavior->getParentsOrdered());
			0 ignored issues – show Bug introduced 2015-12-11 17:02 UTC by Report Bug Copy Issue Report It seems like `populateRelation()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
100			}
101	3		}
102	51	View Code Duplication	if ($name === 'descendants') {
			0 ignored issues – show Duplication introduced 2015-12-11 17:02 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
103	3		$this->_autoTreeReturnBehavior = true;
104	3		$behavior = $this->getDescendants();
105	3		$this->_autoTreeReturnBehavior = false;
106	3		if (method_exists($behavior, 'getDescendantsOrdered')) {
107			$this->populateRelation($name, $behavior->getDescendantsOrdered());
			0 ignored issues – show Bug introduced 2015-12-11 17:02 UTC by Report Bug Copy Issue Report It seems like `populateRelation()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
108			}
109	3		}
110	51		return parent::__get($name);
111			}
112
113			/**
114			* @param int\|null $depth
115			* @return \yii\db\ActiveQuery
116			*/
117	3		public function getParents($depth = null)
118			{
119	3		return $this->autoTreeCall('getParents', ['mp', 'ns', 'ni', 'al'], [$depth]);
120			}
121
122			/**
123			* @return \yii\db\ActiveQuery
124			*/
125	3		public function getParent()
126			{
127	3		return $this->autoTreeCall('getParent', ['al', 'mp', 'ns', 'ni']);
128			}
129
130			/**
131			* @return \yii\db\ActiveQuery
132			*/
133	3		public function getRoot()
134			{
135	3		return $this->autoTreeCall('getRoot', ['mp', 'ns', 'ni', 'al']);
136			}
137
138			/**
139			* @param int\|null $depth
140			* @param bool $andSelf
141			* @return \yii\db\ActiveQuery
142			*/
143	5		public function getDescendants($depth = null, $andSelf = false)
144			{
145	5		return $this->autoTreeCall('getDescendants', ['ns', 'ni', 'mp', 'al'], [$depth, $andSelf]);
146			}
147
148			/**
149			* @return \yii\db\ActiveQuery
150			*/
151	8		public function getChildren()
152			{
153	8		return $this->autoTreeCall('getChildren', ['al', 'ns', 'ni', 'mp']);
154			}
155
156			/**
157			* @param int\|null $depth
158			* @return \yii\db\ActiveQuery
159			*/
160	3		public function getLeaves($depth = null)
161			{
162	3		return $this->autoTreeCall('getLeaves', ['ns', 'al', 'mp', 'ni'], [$depth]);
163			}
164
165			/**
166			* @return \yii\db\ActiveQuery
167			* @throws \yii\base\NotSupportedException
168			*/
169	3		public function getPrev()
170			{
171	3		return $this->autoTreeCall('getPrev', ['ns', 'mp', 'ni', 'al']);
172			}
173
174			/**
175			* @return \yii\db\ActiveQuery
176			* @throws \yii\base\NotSupportedException
177			*/
178	3		public function getNext()
179			{
180	3		return $this->autoTreeCall('getNext', ['ns', 'mp', 'ni', 'al']);
181			}
182
183			/**
184			* Populate children relations for self and all descendants
185			* @param int $depth = null
186			* @param string\|array $with = null
187			* @return self
188			*/
189			public function populateTree($depth = null, $with = null)
190			{
191			return $this->autoTreeCall('populateTree', ['ns', 'ni', 'mp', 'al'], [$depth, $with]);
192			}
193
194			/**
195			* @return bool
196	12		*/
197			public function isRoot()
198	12		{
199			return $this->autoTreeCall('isRoot', ['al', 'ns', 'ni', 'mp']);
200			}
201
202			/**
203			* @param \yii\db\BaseActiveRecord $node
204			* @return bool
205	17		*/
206			public function isChildOf($node)
207	17		{
208			return $this->autoTreeCall('isChildOf', ['ns', 'ni', 'mp', 'al'], [$node]);
209			}
210
211			/**
212			* @return bool
213	3		*/
214			public function isLeaf()
215	3		{
216			return $this->autoTreeCall('isLeaf', ['ns', 'al', 'ni', 'mp']);
217			}
218
219			/**
220			* @return $this
221	6		*/
222			public function makeRoot()
223	6		{
224			return $this->autoTreeCall('makeRoot', ['al', 'ns', 'ni', 'mp'], [], false);
225			}
226
227			/**
228			* @param \yii\db\BaseActiveRecord $node
229			* @return $this
230	6		*/
231			public function prependTo($node)
232	6		{
233			return $this->autoTreeCall('prependTo', ['al', 'ns', 'ni', 'mp'], [$node], false);
234			}
235
236			/**
237			* @param \yii\db\BaseActiveRecord $node
238			* @return $this
239	3		*/
240			public function appendTo($node)
241	3		{
242			return $this->autoTreeCall('appendTo', ['al', 'ns', 'ni', 'mp'], [$node], false);
243			}
244
245			/**
246			* @param \yii\db\BaseActiveRecord $node
247			* @return $this
248	3		*/
249			public function insertBefore($node)
250	3		{
251			return $this->autoTreeCall('insertBefore', ['al', 'ns', 'ni', 'mp'], [$node], false);
252			}
253
254			/**
255			* @param \yii\db\BaseActiveRecord $node
256			* @return $this
257	6		*/
258			public function insertAfter($node)
259	6		{
260			return $this->autoTreeCall('insertAfter', ['al', 'ns', 'ni', 'mp'], [$node], false);
261			}
262
263			/**
264			* @return bool\|int
265			* @throws \Exception
266			* @throws \yii\db\Exception
267	3		*/
268			public function deleteWithChildren()
269			{
270	3		/** @var \yii\db\BaseActiveRecord\|self $this */
271	3		$this->autoTreeCall('preDeleteWithChildren', ['ns', 'ni', 'mp', 'al'], [], false);
272			return $this->autoTreeCall('deleteWithChildren', ['ns', 'ni', 'mp', 'al']);
273			}
274			}
275

paulzi / yii2-auto-tree

Pull Request — master (#6)

AutoTreeTrait::appendTo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like