DOMDocument::addXPath() - Code Metrics - Inspection of "Encode data when calling addXPath()" - chadicus/dom-php - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#4)

by Chad

created 2017-01-19 21:16 UTC

DOMDocument::addXPath() B

↳ Parent: DOMDocument

Complexity

Conditions	5
Paths	6

Size

Total Lines	22
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.6737
c	0
b	0
f	0
cc	5
eloc	13
nc	6
nop	3

<?php

namespace Chadicus\Util;

/**
 * Static helper class for working with \DOM objects.
 */
abstract class DOMDocument
{
    /**
     * Coverts the given array to a \DOMDocument.
     *
     * @param array $array The array to covert.
     *
     * @return \DOMDocument
     */
    final public static function fromArray(array $array)
    {
        $document = new \DOMDocument();
        foreach (self::flatten($array) as $path => $value) {
            self::addXPath($document, $path, $value);
        }

        return $document;
    }

    /**
     * Converts the given \DOMDocument to an array.
     *
     * @param \DOMDocument $document The document to convert.
     *
     * @return array
     */
    final public static function toArray(\DOMDocument $document)
    {
        $result = [];
        $domXPath = new \DOMXPath($document);
        foreach ($domXPath->query('//*[not(*)] | //@*') as $node) {
            self::pathToArray($result, $node->getNodePath(), $node->nodeValue);
        }

        return $result;
    }

    /**
     * Helper method to add a new \DOMNode to the given document with the given value.
     *
     * @param \DOMDocument $document The document to which the node will be added.
     * @param string       $xpath    A valid xpath destination of the new node.
     * @param mixed        $value    The value for the new node.
     *
     * @return void
     *
     * @throws \DOMException Thrown if the given $xpath is not valid.
     */
    final public static function addXPath(\DOMDocument $document, $xpath, $value = null)
    {
        $domXPath = new \DOMXPath($document);
        $list = @$domXPath->query($xpath);
        if ($list === false) {
            throw new \DOMException("XPath {$xpath} is not valid.");
        }

        if ($list->length) {
            $list->item(0)->nodeValue = $value;
            return;
        }

        $pointer = $document;
        foreach (array_filter(explode('/', $xpath)) as $tagName) {
            $pointer = self::parseFragment($domXPath, $pointer, $tagName);
        }

        if ($value !== null) {
            $pointer->nodeValue = htmlentities($value, ENT_XML1, $document->actualEncoding, false);

        }
    }

    /**
     * Helper method to create element(s) from the given tagName.
     *
     * @param \DOMXPath $domXPath The DOMXPath object built using the owner document.
     * @param \DOMNode  $context  The node to which the new elements will be added.
     * @param string    $fragment The tag name of the element.
     *
     * @return \DOMElement|\DOMAttr The DOMNode that was created.
     */
    final private static function parseFragment(\DOMXPath $domXPath, \DOMNode $context, $fragment)
    {
        $document = $domXPath->document;

        if ($fragment[0] === '@') {
            $attributeName = substr($fragment, 1);
            $attribute = $context->attributes->getNamedItem($attributeName);
            if ($attribute === null) {
                $attribute = $document->createAttribute($attributeName);
                $context->appendChild($attribute);
            }

            return $attribute;
        }

        $matches = [];

        //match fragment with comparision operator (ex parent[child="foo"])
        $pattern = '^(?P<parent>[a-z][\w0-9-]*)\[(?P<child>[a-z@][\w0-9-]*)\s*=\s*["\'](?P<value>.*)[\'"]\]$';
        if (preg_match("/{$pattern}/i", $fragment, $matches)) {
            //Find or create the parent node
            $list = $domXPath->query($fragment, $context);
            $parent = $list->length ? $list->item(0) : $document->createElement($matches['parent']);
            //If child is an attribute, create and append. Attributes are overwritten if they exist
            if ($matches['child'][0] == '@') {
                $attribute = $document->createAttribute(substr($matches['child'], 1));
                $attribute->value = $matches['value'];
                $parent->appendChild($attribute);
                $context->appendChild($parent);
                return $parent;
            }

            //Assume child does not exist
            $parent->appendChild($document->createElement($matches['child'], $matches['value']));
            $context->appendChild($parent);
            return $parent;
        }

        //If the fragment did not match the above pattern, then assume it is
        //either '/parent/child  or /parent/child[n] Where n is the nth occurence of the child node
        $matches = [];
        preg_match('/^(?P<name>[a-z][\w0-9-]*)\[(?P<count>\d+)\]$/i', $fragment, $matches);
        //default count and name if pattern doesn't match.
        //There may be another pattern that I'm missing and should account for
        $matches += ['count' => 1, 'name' => $fragment];

        $count = $matches['count'];
        $tagName = $matches['name'];

        $list = $domXPath->query($tagName, $context);
        self::addMultiple($document, $context, $tagName, $count - $list->length);

        return $domXPath->query($tagName, $context)->item($count - 1);
    }

    /**
     * Helper method to add multiple identical nodes to the given context node.
     *
     * @param \DOMDocument $document The parent document.
     * @param \DOMNode     $context  The node to which the new elements will be added.
     * @param string       $tagName  The tag name of the element.
     * @param integer      $limit    The number of elements to create.
     *
     * @return void
     */
    final private static function addMultiple(\DOMDocument $document, \DOMNode $context, $tagName, $limit)
    {
        for ($i = 0; $i < $limit; $i++) {
            $context->appendChild($document->createElement($tagName));
        }
    }

    /**
     * Helper method to create all sub elements in the given array based on the given xpath.
     *
     * @param array  $array The array to which the new elements will be added.
     * @param string $path  The xpath defining the new elements.
     * @param mixed  $value The value for the last child element.
     *
     * @return void
     */
    final private static function pathToArray(array &$array, $path, $value = null)
    {
        $path = str_replace(['[', ']'], ['/', ''], $path);
        $parts = array_filter(explode('/', $path));
        $key = array_shift($parts);

        if (is_numeric($key)) {
            $key = (int)$key -1;
        }

        if (empty($parts)) {
            $array[$key] = $value;
            return;
        }

        self::arrayize($array, $key);

        //RECURSION!!
        self::pathToArray($array[$key], implode('/', $parts), $value);
    }

    /**
     * Helper method to ensure the value at the given $key is an array.
     *
     * @param array  $array The array for which element $key should be checked.
     * @param string $key   The key for which the value will be made into an array.
     *
     * @return void
     */
    final private static function arrayize(array &$array, $key)
    {
        if (!array_key_exists($key, $array)) {
            //key does not exist, set to empty array and return
            $array[$key] = [];
            return;
        }

        if (!is_array($array[$key])) {
            //key exists but is not an array
            $array[$key] = [$array[$key]];
        }//else key exists and is an array
    }

    /**
     * Helper method to flatten a multi-dimensional array into a single dimensional array whose keys are xpaths.
     *
     * @param array  $array  The array to flatten.
     * @param string $prefix The prefix to recursively add to the flattened keys.
     *
     * @return array
     */
    final private static function flatten(array $array, $prefix = '')
    {
        $result = [];
        foreach ($array as $key => $value) {
            if (is_int($key)) {
                $newKey = (substr($prefix, -1) == ']') ? $prefix : "{$prefix}[" . (++$key) . ']';
            } else {

                $newKey = $prefix . (empty($prefix) ? '' : '/') . $key;
            }

            if (is_array($value)) {
                $result = array_merge($result, self::flatten($value, $newKey));
                continue;
            }

            $result[$newKey] = $value;
        }

        return $result;
    }
}


1			<?php
2
3			namespace Chadicus\Util;
4
5			/**
6			* Static helper class for working with \DOM objects.
7			*/
8			abstract class DOMDocument
9			{
10			/**
11			* Coverts the given array to a \DOMDocument.
12			*
13			* @param array $array The array to covert.
14			*
15			* @return \DOMDocument
16			*/
17			final public static function fromArray(array $array)
18			{
19			$document = new \DOMDocument();
20			foreach (self::flatten($array) as $path => $value) {
21			self::addXPath($document, $path, $value);
22			}
23
24			return $document;
25			}
26
27			/**
28			* Converts the given \DOMDocument to an array.
29			*
30			* @param \DOMDocument $document The document to convert.
31			*
32			* @return array
33			*/
34			final public static function toArray(\DOMDocument $document)
35			{
36			$result = [];
37			$domXPath = new \DOMXPath($document);
38			foreach ($domXPath->query('//[not()] \| //@*') as $node) {
39			self::pathToArray($result, $node->getNodePath(), $node->nodeValue);
40			}
41
42			return $result;
43			}
44
45			/**
46			* Helper method to add a new \DOMNode to the given document with the given value.
47			*
48			* @param \DOMDocument $document The document to which the node will be added.
49			* @param string $xpath A valid xpath destination of the new node.
50			* @param mixed $value The value for the new node.
51			*
52			* @return void
53			*
54			* @throws \DOMException Thrown if the given $xpath is not valid.
55			*/
56			final public static function addXPath(\DOMDocument $document, $xpath, $value = null)
57			{
58			$domXPath = new \DOMXPath($document);
59			$list = @$domXPath->query($xpath);
60			if ($list === false) {
61			throw new \DOMException("XPath {$xpath} is not valid.");
62			}
63
64			if ($list->length) {
65			$list->item(0)->nodeValue = $value;
66			return;
67			}
68
69			$pointer = $document;
70			foreach (array_filter(explode('/', $xpath)) as $tagName) {
71			$pointer = self::parseFragment($domXPath, $pointer, $tagName);
72			}
73
74			if ($value !== null) {
75			$pointer->nodeValue = htmlentities($value, ENT_XML1, $document->actualEncoding, false);
			0 ignored issues – show Deprecated Code introduced 2017-01-19 21:19 UTC by Report Bug Copy Issue Report The property `DOMDocument::$actualEncoding` has been deprecated with message: use encoding instead This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
76			}
77			}
78
79			/**
80			* Helper method to create element(s) from the given tagName.
81			*
82			* @param \DOMXPath $domXPath The DOMXPath object built using the owner document.
83			* @param \DOMNode $context The node to which the new elements will be added.
84			* @param string $fragment The tag name of the element.
85			*
86			* @return \DOMElement\|\DOMAttr The DOMNode that was created.
87			*/
88			final private static function parseFragment(\DOMXPath $domXPath, \DOMNode $context, $fragment)
89			{
90			$document = $domXPath->document;
91
92			if ($fragment[0] === '@') {
93			$attributeName = substr($fragment, 1);
94			$attribute = $context->attributes->getNamedItem($attributeName);
95			if ($attribute === null) {
96			$attribute = $document->createAttribute($attributeName);
97			$context->appendChild($attribute);
98			}
99
100			return $attribute;
101			}
102
103			$matches = [];
104
105			//match fragment with comparision operator (ex parent[child="foo"])
106			$pattern = '^(?P<parent>[a-z][\w0-9-])\[(?P<child>[a-z@][\w0-9-])\s=\s["\'](?P<value>.*)[\'"]\]$';
107			if (preg_match("/{$pattern}/i", $fragment, $matches)) {
108			//Find or create the parent node
109			$list = $domXPath->query($fragment, $context);
110			$parent = $list->length ? $list->item(0) : $document->createElement($matches['parent']);
111			//If child is an attribute, create and append. Attributes are overwritten if they exist
112			if ($matches['child'][0] == '@') {
113			$attribute = $document->createAttribute(substr($matches['child'], 1));
114			$attribute->value = $matches['value'];
115			$parent->appendChild($attribute);
116			$context->appendChild($parent);
117			return $parent;
118			}
119
120			//Assume child does not exist
121			$parent->appendChild($document->createElement($matches['child'], $matches['value']));
122			$context->appendChild($parent);
123			return $parent;
124			}
125
126			//If the fragment did not match the above pattern, then assume it is
127			//either '/parent/child or /parent/child[n] Where n is the nth occurence of the child node
128			$matches = [];
129			preg_match('/^(?P<name>[a-z][\w0-9-]*)\[(?P<count>\d+)\]$/i', $fragment, $matches);
130			//default count and name if pattern doesn't match.
131			//There may be another pattern that I'm missing and should account for
132			$matches += ['count' => 1, 'name' => $fragment];
133
134			$count = $matches['count'];
135			$tagName = $matches['name'];
136
137			$list = $domXPath->query($tagName, $context);
138			self::addMultiple($document, $context, $tagName, $count - $list->length);
139
140			return $domXPath->query($tagName, $context)->item($count - 1);
141			}
142
143			/**
144			* Helper method to add multiple identical nodes to the given context node.
145			*
146			* @param \DOMDocument $document The parent document.
147			* @param \DOMNode $context The node to which the new elements will be added.
148			* @param string $tagName The tag name of the element.
149			* @param integer $limit The number of elements to create.
150			*
151			* @return void
152			*/
153			final private static function addMultiple(\DOMDocument $document, \DOMNode $context, $tagName, $limit)
154			{
155			for ($i = 0; $i < $limit; $i++) {
156			$context->appendChild($document->createElement($tagName));
157			}
158			}
159
160			/**
161			* Helper method to create all sub elements in the given array based on the given xpath.
162			*
163			* @param array $array The array to which the new elements will be added.
164			* @param string $path The xpath defining the new elements.
165			* @param mixed $value The value for the last child element.
166			*
167			* @return void
168			*/
169			final private static function pathToArray(array &$array, $path, $value = null)
170			{
171			$path = str_replace(['[', ']'], ['/', ''], $path);
172			$parts = array_filter(explode('/', $path));
173			$key = array_shift($parts);
174
175			if (is_numeric($key)) {
176			$key = (int)$key -1;
177			}
178
179			if (empty($parts)) {
180			$array[$key] = $value;
181			return;
182			}
183
184			self::arrayize($array, $key);
185
186			//RECURSION!!
187			self::pathToArray($array[$key], implode('/', $parts), $value);
188			}
189
190			/**
191			* Helper method to ensure the value at the given $key is an array.
192			*
193			* @param array $array The array for which element $key should be checked.
194			* @param string $key The key for which the value will be made into an array.
195			*
196			* @return void
197			*/
198			final private static function arrayize(array &$array, $key)
199			{
200			if (!array_key_exists($key, $array)) {
201			//key does not exist, set to empty array and return
202			$array[$key] = [];
203			return;
204			}
205
206			if (!is_array($array[$key])) {
207			//key exists but is not an array
208			$array[$key] = [$array[$key]];
209			}//else key exists and is an array
210			}
211
212			/**
213			* Helper method to flatten a multi-dimensional array into a single dimensional array whose keys are xpaths.
214			*
215			* @param array $array The array to flatten.
216			* @param string $prefix The prefix to recursively add to the flattened keys.
217			*
218			* @return array
219			*/
220			final private static function flatten(array $array, $prefix = '')
221			{
222			$result = [];
223			foreach ($array as $key => $value) {
224			if (is_int($key)) {
225			$newKey = (substr($prefix, -1) == ']') ? $prefix : "{$prefix}[" . (++$key) . ']';
226			} else {
			1 ignored issue – show introduced 2017-01-19 21:19 UTC by Report Bug Copy Issue Report Use of ELSE and ELSEIF is discouraged. An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. Loading history...
227			$newKey = $prefix . (empty($prefix) ? '' : '/') . $key;
228			}
229
230			if (is_array($value)) {
231			$result = array_merge($result, self::flatten($value, $newKey));
232			continue;
233			}
234
235			$result[$newKey] = $value;
236			}
237
238			return $result;
239			}
240			}
241

chadicus / dom-php

Pull Request — master (#4)

DOMDocument::addXPath() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like