ChildNodeTrait - Code Metrics - Nayjest/Tree - Measure and Improve Code Quality continuously with Scrutinizer

ChildNodeTrait A
last analyzed 2016-06-15 18:40 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	6
Bugs	0	Features	3

Metric	Value
c	6
b	0
f	3
dl	0
loc	119
wmc	17
lcom	1
cbo	6
rs	10

11 Methods

Rating	Name	Size	Complexity
A	internalSetParent()	5	1
A	internalUnsetParent()	5	1
A	parent()	4	1
A	parents()	14	3
A	detach()	7	1
A	attachTo()	7	1
A	onParentChange()	10	2
A	checkParentRelation()	12	4
A	lock()	6	1
A	unlock()	6	1
A	isLocked()	4	1

<?php

namespace Nayjest\Tree;

use Evenement\EventEmitterTrait;
use Nayjest\Collection\Extended\ObjectCollection;
use Nayjest\Tree\Exception\LockedNodeException;
use Nayjest\Tree\Exception\NoParentException;
use Nayjest\Tree\Exception\ReadonlyNodeModifyException;

/**
 * Trait ChildNodeTrait.
 *
 * @implements ChildNodeInterface
 * @see ChildNodeInterface
 */
trait ChildNodeTrait
{
    use EventEmitterTrait;

    /**
     * @internal
     *
     * @var ParentNodeInterface|ChildNodeInterface
     * */
    private $parentNode;

    private $locked = false;

    /**
     * Attaches component to registry.
     *
     * @param ParentNodeInterface $parent
     *
     * @return null
     */
    final public function internalSetParent(ParentNodeInterface $parent)
    {
        $this->emit('parent.change', [$parent, $this]);
        $this->parentNode = $parent;
    }

    final public function internalUnsetParent()
    {
        $this->emit('parent.change', [null, $this]);
        $this->parentNode = null;
    }

    /**
     * Returns parent node.
     *
     * @return ParentNodeInterface|null
     */
    final public function parent()
    {
        return $this->parentNode;
    }

    /**
     * @return ObjectCollection
     */
    public function parents()
    {
        $parents = new ObjectCollection();
        $current = $this->parent();
        while ($current instanceof ParentNodeInterface) {
            $parents->add($current);
            if (!$current instanceof ChildNodeInterface) {
                break;
            }
            $current = $current->parent();
        }

        return $parents;
    }

    final public function detach()
    {
        $this->checkParentRelation($this->parentNode);
        $this->parentNode->children()->remove($this);

        return $this;
    }

    final public function attachTo(ParentNodeInterface $parent)
    {
        $this->checkParentRelation($parent);
        $parent->children()->add($this);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $this;
    }

    public function onParentChange(callable $callback, $once = false)
    {
        if ($once) {
            $this->once('parent.change', $callback);
        } else {
            $this->on('parent.change', $callback);
        }

        return $this;
    }

    private function checkParentRelation(ParentNodeInterface $parent = null)
    {
        if ($parent === null) {
            throw new NoParentException();
        }
        if (!$parent->isWritable()) {
            throw new ReadonlyNodeModifyException();
        }
        if ($this->isLocked()) {
            throw new LockedNodeException();
        }
    }

    public function lock()
    {
        $this->locked = true;

        return $this;
    }

    public function unlock()
    {
        $this->locked = false;

        return $this;
    }

    public function isLocked()
    {
        return $this->locked;
    }
}


1			<?php
2
3			namespace Nayjest\Tree;
4
5			use Evenement\EventEmitterTrait;
6			use Nayjest\Collection\Extended\ObjectCollection;
7			use Nayjest\Tree\Exception\LockedNodeException;
8			use Nayjest\Tree\Exception\NoParentException;
9			use Nayjest\Tree\Exception\ReadonlyNodeModifyException;
10
11			/**
12			* Trait ChildNodeTrait.
13			*
14			* @implements ChildNodeInterface
15			* @see ChildNodeInterface
16			*/
17			trait ChildNodeTrait
18			{
19			use EventEmitterTrait;
20
21			/**
22			* @internal
23			*
24			* @var ParentNodeInterface\|ChildNodeInterface
25			* */
26			private $parentNode;
27
28			private $locked = false;
29
30			/**
31			* Attaches component to registry.
32			*
33			* @param ParentNodeInterface $parent
34			*
35			* @return null
36			*/
37			final public function internalSetParent(ParentNodeInterface $parent)
38			{
39			$this->emit('parent.change', [$parent, $this]);
40			$this->parentNode = $parent;
41			}
42
43			final public function internalUnsetParent()
44			{
45			$this->emit('parent.change', [null, $this]);
46			$this->parentNode = null;
47			}
48
49			/**
50			* Returns parent node.
51			*
52			* @return ParentNodeInterface\|null
53			*/
54			final public function parent()
55			{
56			return $this->parentNode;
57			}
58
59			/**
60			* @return ObjectCollection
61			*/
62			public function parents()
63			{
64			$parents = new ObjectCollection();
65			$current = $this->parent();
66			while ($current instanceof ParentNodeInterface) {
67			$parents->add($current);
68			if (!$current instanceof ChildNodeInterface) {
69			break;
70			}
71			$current = $current->parent();
72			}
73
74			return $parents;
75			}
76
77			final public function detach()
78			{
79			$this->checkParentRelation($this->parentNode);
80			$this->parentNode->children()->remove($this);
81
82			return $this;
83			}
84
85			final public function attachTo(ParentNodeInterface $parent)
86			{
87			$this->checkParentRelation($parent);
88			$parent->children()->add($this);
			0 ignored issues – show Bug introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Nayjest\Collection\CollectionReadInterface` as the method `add()` does only exist in the following implementations of said interface: `Nayjest\Collection\Collection`, `Nayjest\Collection\Exten...ctTypedObjectCollection`, `Nayjest\Collection\Extended\LazyLoadCollection`, `Nayjest\Collection\Extended\ObjectCollection`, `Nayjest\Tree\NodeCollection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
89
90			return $this;
91			}
92
93			public function onParentChange(callable $callback, $once = false)
94			{
95			if ($once) {
96			$this->once('parent.change', $callback);
97			} else {
98			$this->on('parent.change', $callback);
99			}
100
101			return $this;
102			}
103
104			private function checkParentRelation(ParentNodeInterface $parent = null)
105			{
106			if ($parent === null) {
107			throw new NoParentException();
108			}
109			if (!$parent->isWritable()) {
110			throw new ReadonlyNodeModifyException();
111			}
112			if ($this->isLocked()) {
113			throw new LockedNodeException();
114			}
115			}
116
117			public function lock()
118			{
119			$this->locked = true;
120
121			return $this;
122			}
123
124			public function unlock()
125			{
126			$this->locked = false;
127
128			return $this;
129			}
130
131			public function isLocked()
132			{
133			return $this->locked;
134			}
135			}
136

Nayjest / Tree

ChildNodeTrait A last analyzed 2016-06-15 18:40 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

ChildNodeTrait A
last analyzed 2016-06-15 18:40 UTC