Node::isNull() - Code Metrics - Inspection of "Add NullNode implementation" - byrokrat/autogiro - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2b24be...ec86c3 )

by Hannes

created 2018-08-23 08:28 UTC

Node::isNull() A

↳ Parent: Node

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * This file is part of byrokrat\autogiro.
 *
 * byrokrat\autogiro is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * byrokrat\autogiro is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with byrokrat\autogiro. If not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright 2016-18 Hannes Forsgård
 */

declare(strict_types = 1);

namespace byrokrat\autogiro\Tree;

use byrokrat\autogiro\Visitor\VisitorInterface;

/**
 * Defines a node in the parse tree
 */
abstract class Node
{
    /**
     * @var array
     */
    private $attributes = [];

    /**
     * @var array[]
     */
    private $children = [];

    /**
     * @var int
     */
    private $lineNr = 0;

    /**
     * @var mixed
     */
    private $value = '';

    public function __construct(int $lineNr = 0, $value = '')
    {
        $this->lineNr = $lineNr;
        $this->value = $value;
    }

    /**
     * Accept a visitor
     */
    public function accept(VisitorInterface $visitor): void
    {
        $visitor->visitBefore($this);

        foreach ($this->getChildren() as $node) {
            $node->accept($visitor);
        }

        $visitor->visitAfter($this);
    }

    /**
     * Get line number this node definition started at
     */
    public function getLineNr(): int
    {
        return $this->lineNr;
    }

    /**
     * Get node name
     */
    public function getName(): string
    {
        return basename(str_replace('\\', '/', get_class($this)));
    }

    /**
     * Get node type identifier
     */
    abstract public function getType(): string;

    /**
     * Get raw value wrapped by node
     *
     * @return mixed Loaded node value
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Check if this is a null object implementation
     */
    public function isNull(): bool
    {
        return false;
    }

    /**
     * Set a custom attribute on node
     *
     * @param string $name  Name of attribute
     * @param mixed  $value Value of attribute
     */
    public function setAttribute(string $name, $value): void
    {
        $this->attributes[$name] = $value;
    }

    /**
     * Get custom attribute
     *
     * @param  string $name Name of attribute
     * @return mixed  Value of attribute
     */
    public function getAttribute(string $name)
    {
        return $this->attributes[$name] ?? null;
    }

    /**
     * Check if attribute has been set
     */
    public function hasAttribute(string $name): bool
    {
        return isset($this->attributes[$name]);
    }

    /**
     * Get all registered attributes
     */
    public function getAttributes(): array
    {
        return $this->attributes;
    }

    /**
     * Set a child node
     */
    public function addChild(string $name, Node $node): void
    {
        $this->children[] = [$name, $node];
    }

    /**
     * Get child node
     */
    public function getChild(string $name): Node

    {
        foreach ($this->children as list($nodeName, $node)) {
            if (strcasecmp($nodeName, $name) == 0) {
                return $node;
            }
        }

        return new NullNode;
    }

    /**
     * Check if child exists
     */
    public function hasChild(string $name): bool

    {
        foreach ($this->children as list($nodeName, $node)) {
            if (strcasecmp($nodeName, $name) == 0) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get registered child nodes
     *
     * @return iterable & Node[]
     */
    public function getChildren(string $name = ''): iterable
    {
        foreach ($this->children as list($nodeName, $node)) {
            if (!$name || strcasecmp($nodeName, $name) == 0) {
                yield $node;
            }
        }
    }
}


1		<?php
2		/**
3		* This file is part of byrokrat\autogiro.
4		*
5		* byrokrat\autogiro is free software: you can redistribute it and/or
6		* modify it under the terms of the GNU General Public License as published
7		* by the Free Software Foundation, either version 3 of the License, or
8		* (at your option) any later version.
9		*
10		* byrokrat\autogiro is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License
16		* along with byrokrat\autogiro. If not, see <http://www.gnu.org/licenses/>.
17		*
18		* Copyright 2016-18 Hannes Forsgård
19		*/
20
21		declare(strict_types = 1);
22
23		namespace byrokrat\autogiro\Tree;
24
25		use byrokrat\autogiro\Visitor\VisitorInterface;
26
27		/**
28		* Defines a node in the parse tree
29		*/
30		abstract class Node
31		{
32		/**
33		* @var array
34		*/
35		private $attributes = [];
36
37		/**
38		* @var array[]
39		*/
40		private $children = [];
41
42		/**
43		* @var int
44		*/
45		private $lineNr = 0;
46
47		/**
48		* @var mixed
49		*/
50		private $value = '';
51
52		public function __construct(int $lineNr = 0, $value = '')
53		{
54		$this->lineNr = $lineNr;
55		$this->value = $value;
56		}
57
58		/**
59		* Accept a visitor
60		*/
61		public function accept(VisitorInterface $visitor): void
62		{
63		$visitor->visitBefore($this);
64
65		foreach ($this->getChildren() as $node) {
66		$node->accept($visitor);
67		}
68
69		$visitor->visitAfter($this);
70		}
71
72		/**
73		* Get line number this node definition started at
74		*/
75		public function getLineNr(): int
76		{
77		return $this->lineNr;
78		}
79
80		/**
81		* Get node name
82		*/
83		public function getName(): string
84		{
85		return basename(str_replace('\\', '/', get_class($this)));
86		}
87
88		/**
89		* Get node type identifier
90		*/
91		abstract public function getType(): string;
92
93		/**
94		* Get raw value wrapped by node
95		*
96		* @return mixed Loaded node value
97		*/
98		public function getValue()
99		{
100		return $this->value;
101		}
102
103		/**
104		* Check if this is a null object implementation
105		*/
106		public function isNull(): bool
107		{
108		return false;
109		}
110
111		/**
112		* Set a custom attribute on node
113		*
114		* @param string $name Name of attribute
115		* @param mixed $value Value of attribute
116		*/
117		public function setAttribute(string $name, $value): void
118		{
119		$this->attributes[$name] = $value;
120		}
121
122		/**
123		* Get custom attribute
124		*
125		* @param string $name Name of attribute
126		* @return mixed Value of attribute
127		*/
128		public function getAttribute(string $name)
129		{
130		return $this->attributes[$name] ?? null;
131		}
132
133		/**
134		* Check if attribute has been set
135		*/
136		public function hasAttribute(string $name): bool
137		{
138		return isset($this->attributes[$name]);
139		}
140
141		/**
142		* Get all registered attributes
143		*/
144		public function getAttributes(): array
145		{
146		return $this->attributes;
147		}
148
149		/**
150		* Set a child node
151		*/
152		public function addChild(string $name, Node $node): void
153		{
154		$this->children[] = [$name, $node];
155		}
156
157		/**
158		* Get child node
159		*/
160	View Code Duplication	public function getChild(string $name): Node
		0 ignored issues – show Duplication introduced 2018-08-23 08:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
161		{
162		foreach ($this->children as list($nodeName, $node)) {
163		if (strcasecmp($nodeName, $name) == 0) {
164		return $node;
165		}
166		}
167
168		return new NullNode;
169		}
170
171		/**
172		* Check if child exists
173		*/
174	View Code Duplication	public function hasChild(string $name): bool
		0 ignored issues – show Duplication introduced 2018-08-23 08:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
175		{
176		foreach ($this->children as list($nodeName, $node)) {
177		if (strcasecmp($nodeName, $name) == 0) {
178		return true;
179		}
180		}
181
182		return false;
183		}
184
185		/**
186		* Get registered child nodes
187		*
188		* @return iterable & Node[]
189		*/
190		public function getChildren(string $name = ''): iterable
191		{
192		foreach ($this->children as list($nodeName, $node)) {
193		if (!$name \|\| strcasecmp($nodeName, $name) == 0) {
194		yield $node;
195		}
196		}
197		}
198		}
199

byrokrat / autogiro

Push — master ( 2b24be...ec86c3 )

Node::isNull() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like