SimpleXMLElement::children() - Code Metrics - Inspection of "Fix tests on Windows" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix_windows_test ( db6202...c04b37 )

by Adrien

created 2016-08-10 17:47 UTC

SimpleXMLElement::children() A

↳ Parent: SimpleXMLElement

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
ccs	0
cts	6
cp	0
rs	9.4285
cc	2
eloc	5
nc	2
nop	0
crap	6

<?php

namespace Box\Spout\Reader\Wrapper;

use Box\Spout\Reader\Exception\XMLProcessingException;


/**
 * Class SimpleXMLElement
 * Wrapper around the built-in SimpleXMLElement. This class does not extend \SimpleXMLElement
 * because it its constructor is final... Instead, it is used as a passthrough.
 * @see \SimpleXMLElement
 *
 * @package Box\Spout\Reader\Wrapper
 */
class SimpleXMLElement
{
    use XMLInternalErrorsHelper;

    /** @var \SimpleXMLElement Instance of the wrapped SimpleXMLElement object */
    protected $simpleXMLElement;

    /**
     * Creates a new SimpleXMLElement object
     * @see \SimpleXMLElement::__construct
     *
     * @param string $xmlData A well-formed XML string
     * @throws \Box\Spout\Reader\Exception\XMLProcessingException If the XML string is not well-formed
     */
    public function __construct($xmlData)
    {
        $this->useXMLInternalErrors();

        try {
            $this->simpleXMLElement = new \SimpleXMLElement($xmlData);
        } catch (\Exception $exception) {
            // if the data is invalid, the constructor will throw an Exception
            $this->resetXMLInternalErrorsSetting();
            throw new XMLProcessingException($this->getLastXMLErrorMessage());
        }

        $this->resetXMLInternalErrorsSetting();
    }

    /**
     * Returns the attribute for the given name.
     *
     * @param string $name Attribute name
     * @param string|null|void $namespace An optional namespace for the retrieved attributes
     * @return string|null The attribute value or NULL if attribute not found
     */
    public function getAttribute($name, $namespace = null)
    {
        $isPrefix = ($namespace !== null);
        $attributes = $this->simpleXMLElement->attributes($namespace, $isPrefix);
        $attributeValue = $attributes->{$name};

        return ($attributeValue !== null) ? (string) $attributeValue : null;
    }

    /**
     * Creates a prefix/ns context for the next XPath query
     * @see \SimpleXMLElement::registerXPathNamespace
     *
     * @param string $prefix The namespace prefix to use in the XPath query for the namespace given in "namespace".
     * @param string $namespace The namespace to use for the XPath query. This must match a namespace in
     *                          use by the XML document or the XPath query using "prefix" will not return any results.
     * @return bool TRUE on success or FALSE on failure.
     */
    public function registerXPathNamespace($prefix, $namespace)
    {
        return $this->simpleXMLElement->registerXPathNamespace($prefix, $namespace);
    }

    /**
     * Runs XPath query on XML data
     * @see \SimpleXMLElement::xpath
     *
     * @param string $path An XPath path
     * @return SimpleXMLElement[]|bool an array of SimpleXMLElement objects or FALSE in case of an error.
     */
    public function xpath($path)
    {
        $elements = $this->simpleXMLElement->xpath($path);

        if ($elements !== false) {
            $wrappedElements = [];
            foreach ($elements as $element) {
                $wrappedElement = $this->wrapSimpleXMLElement($element);

                if ($wrappedElement !== null) {
                    $wrappedElements[] = $this->wrapSimpleXMLElement($element);
                }
            }

            $elements = $wrappedElements;
        }

        return $elements;
    }

    /**
     * Wraps the given element into an instance of the wrapper
     *
     * @param \SimpleXMLElement $element Element to be wrapped
     * @return SimpleXMLElement|null The wrapped element or NULL if the given element is invalid
     */
    protected function wrapSimpleXMLElement(\SimpleXMLElement $element)
    {
        $wrappedElement = null;
        $elementAsXML = $element->asXML();

        if ($elementAsXML !== false) {
            $wrappedElement = new SimpleXMLElement($elementAsXML);
        }

        return $wrappedElement;
    }

    /**
     * Remove all nodes matching the given XPath query.
     * It does not map to any \SimpleXMLElement function.
     *
     * @param string $path An XPath path
     * @return void
     */
    public function removeNodesMatchingXPath($path)
    {
        $nodesToRemove = $this->simpleXMLElement->xpath($path);

        foreach ($nodesToRemove as $nodeToRemove) {
            unset($nodeToRemove[0]);
        }
    }

    /**
     * Returns the first child matching the given tag name
     *
     * @param string $tagName
     * @return SimpleXMLElement|null The first child matching the tag name or NULL if none found
     */
    public function getFirstChildByTagName($tagName)
    {
        $doesElementExist = isset($this->simpleXMLElement->{$tagName});

        /** @var \SimpleXMLElement $realElement */
        $realElement = $this->simpleXMLElement->{$tagName};

        return $doesElementExist ? $this->wrapSimpleXMLElement($realElement) : null;
    }

    /**
     * Returns the immediate children.
     *
     * @return array The children
     */
    public function children()
    {
        $children = [];

        foreach ($this->simpleXMLElement->children() as $child) {
            $children[] = $this->wrapSimpleXMLElement($child);
        }

        return $children;
    }

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


1		<?php
2
3		namespace Box\Spout\Reader\Wrapper;
4
5		use Box\Spout\Reader\Exception\XMLProcessingException;
6
7
8		/**
9		* Class SimpleXMLElement
10		* Wrapper around the built-in SimpleXMLElement. This class does not extend \SimpleXMLElement
11		* because it its constructor is final... Instead, it is used as a passthrough.
12		* @see \SimpleXMLElement
13		*
14		* @package Box\Spout\Reader\Wrapper
15		*/
16		class SimpleXMLElement
17		{
18		use XMLInternalErrorsHelper;
19
20		/** @var \SimpleXMLElement Instance of the wrapped SimpleXMLElement object */
21		protected $simpleXMLElement;
22
23		/**
24		* Creates a new SimpleXMLElement object
25		* @see \SimpleXMLElement::__construct
26		*
27		* @param string $xmlData A well-formed XML string
28		* @throws \Box\Spout\Reader\Exception\XMLProcessingException If the XML string is not well-formed
29		*/
30	93	public function __construct($xmlData)
31		{
32	93	$this->useXMLInternalErrors();
33
34		try {
35	93	$this->simpleXMLElement = new \SimpleXMLElement($xmlData);
36	93	} catch (\Exception $exception) {
37		// if the data is invalid, the constructor will throw an Exception
38	6	$this->resetXMLInternalErrorsSetting();
39	6	throw new XMLProcessingException($this->getLastXMLErrorMessage());
40		}
41
42	87	$this->resetXMLInternalErrorsSetting();
43	87	}
44
45		/**
46		* Returns the attribute for the given name.
47		*
48		* @param string $name Attribute name
49		* @param string\|null\|void $namespace An optional namespace for the retrieved attributes
50		* @return string\|null The attribute value or NULL if attribute not found
51		*/
52	84	public function getAttribute($name, $namespace = null)
53		{
54	84	$isPrefix = ($namespace !== null);
55	84	$attributes = $this->simpleXMLElement->attributes($namespace, $isPrefix);
56	84	$attributeValue = $attributes->{$name};
57
58	84	return ($attributeValue !== null) ? (string) $attributeValue : null;
59		}
60
61		/**
62		* Creates a prefix/ns context for the next XPath query
63		* @see \SimpleXMLElement::registerXPathNamespace
64		*
65		* @param string $prefix The namespace prefix to use in the XPath query for the namespace given in "namespace".
66		* @param string $namespace The namespace to use for the XPath query. This must match a namespace in
67		* use by the XML document or the XPath query using "prefix" will not return any results.
68		* @return bool TRUE on success or FALSE on failure.
69		*/
70	63	public function registerXPathNamespace($prefix, $namespace)
71		{
72	63	return $this->simpleXMLElement->registerXPathNamespace($prefix, $namespace);
73		}
74
75		/**
76		* Runs XPath query on XML data
77		* @see \SimpleXMLElement::xpath
78		*
79		* @param string $path An XPath path
80		* @return SimpleXMLElement[]\|bool an array of SimpleXMLElement objects or FALSE in case of an error.
81		*/
82	66	public function xpath($path)
83		{
84	66	$elements = $this->simpleXMLElement->xpath($path);
85
86	66	if ($elements !== false) {
87	66	$wrappedElements = [];
88	66	foreach ($elements as $element) {
89	66	$wrappedElement = $this->wrapSimpleXMLElement($element);
90
91	66	if ($wrappedElement !== null) {
92	66	$wrappedElements[] = $this->wrapSimpleXMLElement($element);
93	66	}
94	66	}
95
96	66	$elements = $wrappedElements;
97	66	}
98
99	66	return $elements;
100		}
101
102		/**
103		* Wraps the given element into an instance of the wrapper
104		*
105		* @param \SimpleXMLElement $element Element to be wrapped
106		* @return SimpleXMLElement\|null The wrapped element or NULL if the given element is invalid
107		*/
108	69	protected function wrapSimpleXMLElement(\SimpleXMLElement $element)
109		{
110	69	$wrappedElement = null;
111	69	$elementAsXML = $element->asXML();
112
113	69	if ($elementAsXML !== false) {
114	69	$wrappedElement = new SimpleXMLElement($elementAsXML);
115	69	}
116
117	69	return $wrappedElement;
118		}
119
120		/**
121		* Remove all nodes matching the given XPath query.
122		* It does not map to any \SimpleXMLElement function.
123		*
124		* @param string $path An XPath path
125		* @return void
126		*/
127	66	public function removeNodesMatchingXPath($path)
128		{
129	66	$nodesToRemove = $this->simpleXMLElement->xpath($path);
130
131	66	foreach ($nodesToRemove as $nodeToRemove) {
132	9	unset($nodeToRemove[0]);
133	66	}
134	66	}
135
136		/**
137		* Returns the first child matching the given tag name
138		*
139		* @param string $tagName
140		* @return SimpleXMLElement\|null The first child matching the tag name or NULL if none found
141		*/
142	3	public function getFirstChildByTagName($tagName)
143		{
144	3	$doesElementExist = isset($this->simpleXMLElement->{$tagName});
145
146		/** @var \SimpleXMLElement $realElement */
147	3	$realElement = $this->simpleXMLElement->{$tagName};
148
149	3	return $doesElementExist ? $this->wrapSimpleXMLElement($realElement) : null;
150		}
151
152		/**
153		* Returns the immediate children.
154		*
155		* @return array The children
156		*/
157		public function children()
158		{
159		$children = [];
160
161		foreach ($this->simpleXMLElement->children() as $child) {
162		$children[] = $this->wrapSimpleXMLElement($child);
163		}
164
165		return $children;
166		}
167
168		/**
169		* @return string
170		*/
171	63	public function __toString()
172		{
173	63	return $this->simpleXMLElement->__toString();
174		}
175		}
176

box / spout

Push — fix_windows_test ( db6202...c04b37 )

SimpleXMLElement::children() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like