Node::add() - Code Metrics - Inspection of "Add schema locations" - Kinedu/cfdi-xml - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 491bb5...2eaee0 )

by Orlando

created 2018-11-22 18:37 UTC

Node::add() B

↳ Parent: Node

Complexity

Conditions	9
Paths	60

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	53
c	0
b	0
f	0
rs	7.4698
cc	9
nc	60
nop	1

How to fix Long Method

<?php

/*
 * This file is part of the cfdi-xml project.
 *
 * (c) Kinedu
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Kinedu\CfdiXML\Common;

use DOMElement;
use DOMDocument;
use DOMNodeList;

class Node
{
    /**
     * Node document.
     *
     * @var DOMDocument
     */
    protected $document;

    /**
     * Node element.
     *
     * @var DOMElement
     */
    protected $element;

    /**
     * Define the parent node name.
     *
     * @var string|null
     */
    protected $parentNodeName = null;

    /**
     * Define the node name.
     *
     * @var string
     */
    protected $nodeName;

    /**
     * Node attributes.
     *
     * @var array
     */
    protected $attr = [];

    /**
     * Create a new node instance.
     *
     * @param array $attr
     */
    public function __construct(array ...$attr)
    {
        $this->attr = $attr;

        $this->document = new DOMDocument('1.0', 'UTF-8');
        $this->document->preserveWhiteSpace = false;
        $this->document->formatOutput = true;

        if ($nodeName = $this->getNodeName()) {
            $this->element = $this->document->createElement($nodeName);
            $this->document->appendChild($this->element);
            $this->setAttr($this->element, $this->getAttr());
        }
    }

    /**
     * Add a new node.
     *
     * @param \Kinedu\CfdiXML\Common\Node $node
     *
     * @return void
     */
    public function add(Node $node)
    {
        $wrapperElement = null;

        if ($node->schemaDefinition && $node->globalSchemaLocation) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->setSchemaDefinition(
                $node->getSchemaLocation()
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            );
        }

        $nodeElement = $this->document->createElement($node->getNodeName());
        $this->setAttr($nodeElement, $node->getAttr());

        foreach ($node->element->childNodes as $child) {
            $nodeElement->appendChild(
                $this->document->importNode($child, true)
            );
        }

        if ($wrapperName = $node->getWrapperNodeName()) {
            $wrapperElement = $this->getDirectChildElementByName(
                $this->element->childNodes,
                $wrapperName
            );

            if (!$wrapperElement) {
                $wrapperElement = $this->document->createElement($wrapperName);
                $this->element->appendChild($wrapperElement);
            }

            $this->setAttr($wrapperElement, $node->getAttr('wrapper'));
        }

        if ($parentName = $node->getParentNodeName()) {
            $currentElement = ($wrapperElement) ? $wrapperElement : $this->element;

            $parentNode = $this->getDirectChildElementByName(
                $currentElement->childNodes,
                $parentName
            );

            if (!$parentNode) {
                $parentElement = $this->document->createElement($parentName);
                $currentElement->appendChild($parentElement);
                $parentElement->appendChild($nodeElement);
                $this->setAttr($parentElement, $node->getAttr('parent'));
            } else {
                $parentNode->appendChild($nodeElement);
            }
        } else {
            $this->element->appendChild($nodeElement);
        }
    }

    /**
     * Search the direct child of an element.
     *
     * @param DOMNodeList $children
     * @param string $find
     *
     * @return DOMElement|null
     */
    protected function getDirectChildElementByName(DOMNodeList $children, string $find)
    {
        foreach ($children as $child) {
            if ($child->nodeName == $find) {
                return $child;
            }
        }

        return null;
    }

    /**
     * @param  string  $schemaDefinition
     * @return void
     */
    public function setSchemaDefinition(string $schemaDefinition)
    {
        $attrName = 'xsi:schemaLocation';

        $node = $this->element;

        if ($node->hasAttribute($attrName)) {
            $value = $node->getAttribute($attrName);
            $value = "{$value} {$schemaDefinition}";

            $node->setAttribute($attrName, $value);
        }
    }

    /**
     * Get node attributes.
     *
     * @param string $index
     *
     * @return array|null
     */
    public function getAttr(string $index = 'node')
    {
        $attrIndex = ['node', 'parent', 'wrapper'];

        $index = (in_array($index, $attrIndex))
            ? array_search($index, $attrIndex)
            : 0;

        return $this->attr[$index] ?? null;
    }

    /**
     * Adds attributes to an element.
     *
     * @param DOMElement $element
     * @param array $attr
     *
     * @return void
     */
    public function setAttr(DOMElement $element, array $attr = null)
    {
        if (!is_null($attr)) {
            foreach ($attr as $key => $value) {
                $element->setAttribute($key, $value);
            }
        }
    }

    /**
     * Get element.
     *
     * @return DOMElement
     */
    public function getElement(): DOMElement
    {
        return $this->element;
    }

    /**
     * Get document.
     *
     * @return DOMDocument
     */
    public function getDocument(): DOMDocument
    {
        return $this->document;
    }

    /**
     * Get wrapper node name.
     *
     * @return string|null
     */
    public function getWrapperNodeName()
    {
        return $this->wrapperNodeName ?? null;

    }

    /**
     * Get parent node name.
     *
     * @return string|null
     */
    public function getParentNodeName()
    {
        return $this->parentNodeName ?? null;
    }

    /**
     * Get node name.
     *
     * @return string
     */
    public function getNodeName()
    {
        return $this->nodeName ?? null;
    }
}


GitHub Access Token became invalid

Push — master ( 491bb5...2eaee0 )

Node::add() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

1			<?php
2
3			/*
4			* This file is part of the cfdi-xml project.
5			*
6			* (c) Kinedu
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Kinedu\CfdiXML\Common;
13
14			use DOMElement;
15			use DOMDocument;
16			use DOMNodeList;
17
18			class Node
19			{
20			/**
21			* Node document.
22			*
23			* @var DOMDocument
24			*/
25			protected $document;
26
27			/**
28			* Node element.
29			*
30			* @var DOMElement
31			*/
32			protected $element;
33
34			/**
35			* Define the parent node name.
36			*
37			* @var string\|null
38			*/
39			protected $parentNodeName = null;
40
41			/**
42			* Define the node name.
43			*
44			* @var string
45			*/
46			protected $nodeName;
47
48			/**
49			* Node attributes.
50			*
51			* @var array
52			*/
53			protected $attr = [];
54
55			/**
56			* Create a new node instance.
57			*
58			* @param array $attr
59			*/
60			public function __construct(array ...$attr)
61			{
62			$this->attr = $attr;
63
64			$this->document = new DOMDocument('1.0', 'UTF-8');
65			$this->document->preserveWhiteSpace = false;
66			$this->document->formatOutput = true;
67
68			if ($nodeName = $this->getNodeName()) {
69			$this->element = $this->document->createElement($nodeName);
70			$this->document->appendChild($this->element);
71			$this->setAttr($this->element, $this->getAttr());
72			}
73			}
74
75			/**
76			* Add a new node.
77			*
78			* @param \Kinedu\CfdiXML\Common\Node $node
79			*
80			* @return void
81			*/
82			public function add(Node $node)
83			{
84			$wrapperElement = null;
85
86			if ($node->schemaDefinition && $node->globalSchemaLocation) {
			0 ignored issues – show Bug introduced 2018-11-22 18:38 UTC by Report Bug Copy Issue Report The property `schemaDefinition` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2018-11-22 18:38 UTC by Report Bug Copy Issue Report The property `globalSchemaLocation` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
87			$this->setSchemaDefinition(
88			$node->getSchemaLocation()
			0 ignored issues – show Bug introduced 2018-11-22 18:38 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Kinedu\CfdiXML\Common\Node` as the method `getSchemaLocation()` does only exist in the following sub-classes of `Kinedu\CfdiXML\Common\Node`: `Kinedu\CfdiXML\Common\Complemento`, `Kinedu\CfdiXML\Common\ComplementoBase`, `Kinedu\CfdiXML\Common\ComplementoConcepto`, `Kinedu\CfdiXML\Common\Complemento\IEDU`, `Kinedu\CfdiXML\Common\Complemento\Pago`, `Kinedu\CfdiXML\Common\Co...nto\TimbreFiscalDigital`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
89			);
90			}
91
92			$nodeElement = $this->document->createElement($node->getNodeName());
93			$this->setAttr($nodeElement, $node->getAttr());
94
95			foreach ($node->element->childNodes as $child) {
96			$nodeElement->appendChild(
97			$this->document->importNode($child, true)
98			);
99			}
100
101			if ($wrapperName = $node->getWrapperNodeName()) {
102			$wrapperElement = $this->getDirectChildElementByName(
103			$this->element->childNodes,
104			$wrapperName
105			);
106
107			if (!$wrapperElement) {
108			$wrapperElement = $this->document->createElement($wrapperName);
109			$this->element->appendChild($wrapperElement);
110			}
111
112			$this->setAttr($wrapperElement, $node->getAttr('wrapper'));
113			}
114
115			if ($parentName = $node->getParentNodeName()) {
116			$currentElement = ($wrapperElement) ? $wrapperElement : $this->element;
117
118			$parentNode = $this->getDirectChildElementByName(
119			$currentElement->childNodes,
120			$parentName
121			);
122
123			if (!$parentNode) {
124			$parentElement = $this->document->createElement($parentName);
125			$currentElement->appendChild($parentElement);
126			$parentElement->appendChild($nodeElement);
127			$this->setAttr($parentElement, $node->getAttr('parent'));
128			} else {
129			$parentNode->appendChild($nodeElement);
130			}
131			} else {
132			$this->element->appendChild($nodeElement);
133			}
134			}
135
136			/**
137			* Search the direct child of an element.
138			*
139			* @param DOMNodeList $children
140			* @param string $find
141			*
142			* @return DOMElement\|null
143			*/
144			protected function getDirectChildElementByName(DOMNodeList $children, string $find)
145			{
146			foreach ($children as $child) {
147			if ($child->nodeName == $find) {
148			return $child;
149			}
150			}
151
152			return null;
153			}
154
155			/**
156			* @param string $schemaDefinition
157			* @return void
158			*/
159			public function setSchemaDefinition(string $schemaDefinition)
160			{
161			$attrName = 'xsi:schemaLocation';
162
163			$node = $this->element;
164
165			if ($node->hasAttribute($attrName)) {
166			$value = $node->getAttribute($attrName);
167			$value = "{$value} {$schemaDefinition}";
168
169			$node->setAttribute($attrName, $value);
170			}
171			}
172
173			/**
174			* Get node attributes.
175			*
176			* @param string $index
177			*
178			* @return array\|null
179			*/
180			public function getAttr(string $index = 'node')
181			{
182			$attrIndex = ['node', 'parent', 'wrapper'];
183
184			$index = (in_array($index, $attrIndex))
185			? array_search($index, $attrIndex)
186			: 0;
187
188			return $this->attr[$index] ?? null;
189			}
190
191			/**
192			* Adds attributes to an element.
193			*
194			* @param DOMElement $element
195			* @param array $attr
196			*
197			* @return void
198			*/
199			public function setAttr(DOMElement $element, array $attr = null)
200			{
201			if (!is_null($attr)) {
202			foreach ($attr as $key => $value) {
203			$element->setAttribute($key, $value);
204			}
205			}
206			}
207
208			/**
209			* Get element.
210			*
211			* @return DOMElement
212			*/
213			public function getElement(): DOMElement
214			{
215			return $this->element;
216			}
217
218			/**
219			* Get document.
220			*
221			* @return DOMDocument
222			*/
223			public function getDocument(): DOMDocument
224			{
225			return $this->document;
226			}
227
228			/**
229			* Get wrapper node name.
230			*
231			* @return string\|null
232			*/
233			public function getWrapperNodeName()
234			{
235			return $this->wrapperNodeName ?? null;
			0 ignored issues – show Bug introduced 2018-02-06 15:35 UTC by Report Bug Copy Issue Report The property `wrapperNodeName` does not seem to exist. Did you mean `nodeName`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
236			}
237
238			/**
239			* Get parent node name.
240			*
241			* @return string\|null
242			*/
243			public function getParentNodeName()
244			{
245			return $this->parentNodeName ?? null;
246			}
247
248			/**
249			* Get node name.
250			*
251			* @return string
252			*/
253			public function getNodeName()
254			{
255			return $this->nodeName ?? null;
256			}
257			}
258

Kinedu / cfdi-xml

GitHub Access Token became invalid

Push — master ( 491bb5...2eaee0 )

Node::add() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like