Node::getSimpleXMLElement() - Code Metrics - ThrusterIO/xml-iterator - Measure and Improve Code Quality continuously with Scrutinizer

Node::getSimpleXMLElement() A
last analyzed 2016-09-22 13:16 UTC

↳ Parent: Node

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	7
cts	7
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	3
nop	0
crap	3

<?php

namespace Thruster\Component\XMLIterator;

use DOMNode;
use DOMDocument;
use SimpleXMLElement;
use BadMethodCallException;

/**
 * Class Node
 *
 * @package Thruster\Component\XMLIterator
 * @author  Aurimas Niekis <[email protected]>
 */
class Node
{
    /**
     * @var XMLReader
     */
    protected $reader;

    /**
     * @var int
     */
    private $nodeType;

    /**
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $localName;

    /**
     * @var SimpleXMLElement
     */
    private $simpleXML;

    /**
     * @var AttributeIterator
     */
    private $attributes;

    /**
     * @var string
     */
    private $string;

    public function __construct(XMLReader $reader)
    {
        $this->reader   = $reader;
        $this->nodeType = $reader->nodeType;
        $this->name     = $reader->name;
    }

    /**
     * @inheritdoc
     */
    public function __toString()
    {
        if (null === $this->string) {
            $this->string = $this->readString();
        }

        return $this->string;
    }

    /**
     * @return SimpleXMLElement
     */
    public function getSimpleXMLElement()
    {
        if (null === $this->simpleXML) {
            if ($this->reader->nodeType !== XMLReader::ELEMENT) {
                return null;
            }

            $node            = $this->expand();
            $this->simpleXML = simplexml_import_dom($node);
        }

        return $this->simpleXML;
    }

    /**
     * @return AttributeIterator|array
     */
    public function getAttributes()
    {
        if (null === $this->attributes) {
            $this->attributes = new AttributeIterator($this->reader);
        }

        return $this->attributes;
    }

    /**
     * @param string $name
     * @param null   $default
     *
     * @return string
     */
    public function getAttribute(string $name, $default = null)
    {
        return $this->reader->getAttribute($name) ?? $default;
    }

    /**
     * @param null $name
     * @param bool $descendantAxis
     *
     * @return ChildElementIterator
     */
    public function getChildElements($name = null, bool $descendantAxis = false) : ChildElementIterator
    {
        return new ChildElementIterator($this->reader, $name, $descendantAxis);
    }

    /**
     * @return ChildIterator|Node[]
     */
    public function getChildren() : ChildIterator
    {
        return new ChildIterator($this->reader);
    }

    /**
     * @return string name
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @return string local name
     */
    public function getLocalName()
    {
        return $this->localName;
    }

    public function getReader()
    {
        return $this->reader;
    }

    /**
     * @return string
     */
    public function readOuterXml()
    {
        return $this->reader->readOuterXml();
    }

    /**
     * XMLReader expand node and import it into a DOMNode with a DOMDocument
     *
     * This is for example useful for DOMDocument::saveXML() @see readOuterXml
     * or getting a SimpleXMLElement out of it @see getSimpleXMLElement
     *
     * @throws BadMethodCallException
     *
     * @param DOMNode $baseNode
     *
     * @return DOMNode
     */
    public function expand(DOMNode $baseNode = null)
    {
        if (null === $baseNode) {
            $baseNode = new DOMDocument();
        }

        if ($baseNode instanceof DOMDocument) {
            $doc = $baseNode;
        } else {
            $doc = $baseNode->ownerDocument;
        }

        if (false === $node = $this->reader->expand($baseNode)) {
            throw new BadMethodCallException('Unable to expand node.');
        }

        if ($node->ownerDocument !== $doc) {
            $node = $doc->importNode($node, true);
        }

        return $node;
    }

    /**
     * Decorated method
     *
     * @throws BadMethodCallException
     * @return string
     */
    public function readString()
    {
        return $this->reader->readString();
    }

    /**
     * Return node-type as human readable string (constant name)
     *
     * @param null $nodeType
     *
     * @return string
     */
    public function getNodeTypeName($nodeType = null)
    {
        $strings = [
            XMLReader::NONE                   => 'NONE',
            XMLReader::ELEMENT                => 'ELEMENT',
            XMLReader::ATTRIBUTE              => 'ATTRIBUTE',
            XMLREADER::TEXT                   => 'TEXT',
            XMLREADER::CDATA                  => 'CDATA',
            XMLReader::ENTITY_REF             => 'ENTITY_REF',
            XMLReader::ENTITY                 => 'ENTITY',
            XMLReader::PI                     => 'PI',
            XMLReader::COMMENT                => 'COMMENT',
            XMLReader::DOC                    => 'DOC',
            XMLReader::DOC_TYPE               => 'DOC_TYPE',
            XMLReader::DOC_FRAGMENT           => 'DOC_FRAGMENT',
            XMLReader::NOTATION               => 'NOTATION',
            XMLReader::WHITESPACE             => 'WHITESPACE',
            XMLReader::SIGNIFICANT_WHITESPACE => 'SIGNIFICANT_WHITESPACE',
            XMLReader::END_ELEMENT            => 'END_ELEMENT',
            XMLReader::END_ENTITY             => 'END_ENTITY',
            XMLReader::XML_DECLARATION        => 'XML_DECLARATION',
        ];

        if (null === $nodeType) {
            $nodeType = $this->nodeType;
        }

        return $strings[$nodeType];
    }

    /**
     * decorate method calls
     *
     * @param string $name
     * @param array  $args
     *
     * @return mixed
     */
    public function __call($name, $args)
    {
        return call_user_func_array([$this->reader, $name], $args);
    }

    /**
     * decorate property get
     *
     * @param string $name
     *
     * @return string
     */
    public function __get($name)
    {
        return $this->reader->$name;
    }

    /**
     * debug utility method
     *
     * @param XMLReader $reader
     * @param bool      $return (optional) prints by default but can return string
     *
     * @return string|null
     */
    public static function dump(XMLReader $reader, bool $return = false)
    {
        $node     = new self($reader);
        $nodeType = $reader->nodeType;
        $nodeName = $node->getNodeTypeName();
        $extra    = '';

        if ($reader->nodeType === XMLReader::ELEMENT) {
            $extra = '<' . $reader->name . '> ';
            $extra .= sprintf("(isEmptyElement: %s) ", $reader->isEmptyElement ? 'Yes' : 'No');
        }

        if ($reader->nodeType === XMLReader::END_ELEMENT) {
            $extra = '</' . $reader->name . '> ';
        }

        if ($reader->nodeType === XMLReader::ATTRIBUTE) {
            $str = $reader->value;
            $len = strlen($str);
            if ($len > 20) {
                $str = substr($str, 0, 17) . '...';
            }
            $str   = strtr($str, ["\n" => '\n']);
            $extra = sprintf('%s = (%d) "%s" ', $reader->name, strlen($str), $str);
        }

        if ($reader->nodeType === XMLReader::TEXT || $reader->nodeType === XMLReader::WHITESPACE ||
            $reader->nodeType === XMLReader::SIGNIFICANT_WHITESPACE
        ) {
            $str = $reader->readString();
            $len = strlen($str);
            if ($len > 20) {
                $str = substr($str, 0, 17) . '...';
            }
            $str   = strtr($str, ["\n" => '\n']);
            $extra = sprintf('(%d) "%s" ', strlen($str), $str);
        }

        $label = sprintf("(#%d) %s %s", $nodeType, $nodeName, $extra);

        if ($return) {
            return $label;
        }

        printf("%s%s\n", str_repeat('  ', $reader->depth), $label);

        return null;
    }
}


1		<?php
2
3		namespace Thruster\Component\XMLIterator;
4
5		use DOMNode;
6		use DOMDocument;
7		use SimpleXMLElement;
8		use BadMethodCallException;
9
10		/**
11		* Class Node
12		*
13		* @package Thruster\Component\XMLIterator
14		* @author Aurimas Niekis <[email protected]>
15		*/
16		class Node
17		{
18		/**
19		* @var XMLReader
20		*/
21		protected $reader;
22
23		/**
24		* @var int
25		*/
26		private $nodeType;
27
28		/**
29		* @var string
30		*/
31		private $name;
32
33		/**
34		* @var string
35		*/
36		private $localName;
37
38		/**
39		* @var SimpleXMLElement
40		*/
41		private $simpleXML;
42
43		/**
44		* @var AttributeIterator
45		*/
46		private $attributes;
47
48		/**
49		* @var string
50		*/
51		private $string;
52
53	26	public function __construct(XMLReader $reader)
54		{
55	26	$this->reader = $reader;
56	26	$this->nodeType = $reader->nodeType;
57	26	$this->name = $reader->name;
58	26	}
59
60		/**
61		* @inheritdoc
62		*/
63	1	public function __toString()
64		{
65	1	if (null === $this->string) {
66	1	$this->string = $this->readString();
67		}
68
69	1	return $this->string;
70		}
71
72		/**
73		* @return SimpleXMLElement
74		*/
75	1	public function getSimpleXMLElement()
76		{
77	1	if (null === $this->simpleXML) {
78	1	if ($this->reader->nodeType !== XMLReader::ELEMENT) {
79	1	return null;
80		}
81
82	1	$node = $this->expand();
83	1	$this->simpleXML = simplexml_import_dom($node);
84		}
85
86	1	return $this->simpleXML;
87		}
88
89		/**
90		* @return AttributeIterator\|array
91		*/
92	18	public function getAttributes()
93		{
94	18	if (null === $this->attributes) {
95	18	$this->attributes = new AttributeIterator($this->reader);
96		}
97
98	18	return $this->attributes;
99		}
100
101		/**
102		* @param string $name
103		* @param null $default
104		*
105		* @return string
106		*/
107		public function getAttribute(string $name, $default = null)
108		{
109		return $this->reader->getAttribute($name) ?? $default;
110		}
111
112		/**
113		* @param null $name
114		* @param bool $descendantAxis
115		*
116		* @return ChildElementIterator
117		*/
118	1	public function getChildElements($name = null, bool $descendantAxis = false) : ChildElementIterator
119		{
120	1	return new ChildElementIterator($this->reader, $name, $descendantAxis);
121		}
122
123		/**
124		* @return ChildIterator\|Node[]
125		*/
126		public function getChildren() : ChildIterator
127		{
128		return new ChildIterator($this->reader);
129		}
130
131		/**
132		* @return string name
133		*/
134	5	public function getName()
135		{
136	5	return $this->name;
137		}
138
139		/**
140		* @return string local name
141		*/
142		public function getLocalName()
143		{
144		return $this->localName;
145		}
146
147		public function getReader()
148		{
149		return $this->reader;
150		}
151
152		/**
153		* @return string
154		*/
155		public function readOuterXml()
156		{
157		return $this->reader->readOuterXml();
158		}
159
160		/**
161		* XMLReader expand node and import it into a DOMNode with a DOMDocument
162		*
163		* This is for example useful for DOMDocument::saveXML() @see readOuterXml
164		* or getting a SimpleXMLElement out of it @see getSimpleXMLElement
165		*
166		* @throws BadMethodCallException
167		*
168		* @param DOMNode $baseNode
169		*
170		* @return DOMNode
171		*/
172	2	public function expand(DOMNode $baseNode = null)
173		{
174	2	if (null === $baseNode) {
175	2	$baseNode = new DOMDocument();
176		}
177
178	2	if ($baseNode instanceof DOMDocument) {
179	2	$doc = $baseNode;
180		} else {
181		$doc = $baseNode->ownerDocument;
182		}
183
184	2	if (false === $node = $this->reader->expand($baseNode)) {
185		throw new BadMethodCallException('Unable to expand node.');
186		}
187
188	2	if ($node->ownerDocument !== $doc) {
189		$node = $doc->importNode($node, true);
190		}
191
192	2	return $node;
193		}
194
195		/**
196		* Decorated method
197		*
198		* @throws BadMethodCallException
199		* @return string
200		*/
201	6	public function readString()
202		{
203	6	return $this->reader->readString();
204		}
205
206		/**
207		* Return node-type as human readable string (constant name)
208		*
209		* @param null $nodeType
210		*
211		* @return string
212		*/
213	15	public function getNodeTypeName($nodeType = null)
214		{
215		$strings = [
216	15	XMLReader::NONE => 'NONE',
217	15	XMLReader::ELEMENT => 'ELEMENT',
218	15	XMLReader::ATTRIBUTE => 'ATTRIBUTE',
219	15	XMLREADER::TEXT => 'TEXT',
220	15	XMLREADER::CDATA => 'CDATA',
221	15	XMLReader::ENTITY_REF => 'ENTITY_REF',
222	15	XMLReader::ENTITY => 'ENTITY',
223	15	XMLReader::PI => 'PI',
224	15	XMLReader::COMMENT => 'COMMENT',
225	15	XMLReader::DOC => 'DOC',
226	15	XMLReader::DOC_TYPE => 'DOC_TYPE',
227	15	XMLReader::DOC_FRAGMENT => 'DOC_FRAGMENT',
228	15	XMLReader::NOTATION => 'NOTATION',
229	15	XMLReader::WHITESPACE => 'WHITESPACE',
230	15	XMLReader::SIGNIFICANT_WHITESPACE => 'SIGNIFICANT_WHITESPACE',
231	15	XMLReader::END_ELEMENT => 'END_ELEMENT',
232	15	XMLReader::END_ENTITY => 'END_ENTITY',
233	15	XMLReader::XML_DECLARATION => 'XML_DECLARATION',
234		];
235
236	15	if (null === $nodeType) {
237	15	$nodeType = $this->nodeType;
238		}
239
240	15	return $strings[$nodeType];
241		}
242
243		/**
244		* decorate method calls
245		*
246		* @param string $name
247		* @param array $args
248		*
249		* @return mixed
250		*/
251		public function __call($name, $args)
252		{
253		return call_user_func_array([$this->reader, $name], $args);
254		}
255
256		/**
257		* decorate property get
258		*
259		* @param string $name
260		*
261		* @return string
262		*/
263	2	public function __get($name)
264		{
265	2	return $this->reader->$name;
266		}
267
268		/**
269		* debug utility method
270		*
271		* @param XMLReader $reader
272		* @param bool $return (optional) prints by default but can return string
273		*
274		* @return string\|null
275		*/
276	14	public static function dump(XMLReader $reader, bool $return = false)
277		{
278	14	$node = new self($reader);
279	14	$nodeType = $reader->nodeType;
280	14	$nodeName = $node->getNodeTypeName();
281	14	$extra = '';
282
283	14	if ($reader->nodeType === XMLReader::ELEMENT) {
284	14	$extra = '<' . $reader->name . '> ';
285	14	$extra .= sprintf("(isEmptyElement: %s) ", $reader->isEmptyElement ? 'Yes' : 'No');
286		}
287
288	14	if ($reader->nodeType === XMLReader::END_ELEMENT) {
289	7	$extra = '</' . $reader->name . '> ';
290		}
291
292	14	if ($reader->nodeType === XMLReader::ATTRIBUTE) {
293		$str = $reader->value;
294		$len = strlen($str);
295		if ($len > 20) {
296		$str = substr($str, 0, 17) . '...';
297		}
298		$str = strtr($str, ["\n" => '\n']);
299		$extra = sprintf('%s = (%d) "%s" ', $reader->name, strlen($str), $str);
300		}
301
302	14	if ($reader->nodeType === XMLReader::TEXT \|\| $reader->nodeType === XMLReader::WHITESPACE \|\|
303	14	$reader->nodeType === XMLReader::SIGNIFICANT_WHITESPACE
304		) {
305	7	$str = $reader->readString();
306	7	$len = strlen($str);
307	7	if ($len > 20) {
308	3	$str = substr($str, 0, 17) . '...';
309		}
310	7	$str = strtr($str, ["\n" => '\n']);
311	7	$extra = sprintf('(%d) "%s" ', strlen($str), $str);
312		}
313
314	14	$label = sprintf("(#%d) %s %s", $nodeType, $nodeName, $extra);
315
316	14	if ($return) {
317	14	return $label;
318		}
319
320		printf("%s%s\n", str_repeat(' ', $reader->depth), $label);
321
322		return null;
323		}
324		}
325

ThrusterIO / xml-iterator

Node::getSimpleXMLElement() A last analyzed 2016-09-22 13:16 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Node::getSimpleXMLElement() A
last analyzed 2016-09-22 13:16 UTC