ArrayToXml::isArrayAllKeySequential() - Code Metrics - Inspection of "Add support for dropping XML declaration" - spatie/array-to-xml - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#145)

unknown

created 2020-09-14 18:40 UTC

ArrayToXml::isArrayAllKeySequential() A

↳ Parent: ArrayToXml

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\ArrayToXml;

use DOMDocument;
use DOMElement;
use DOMException;
use Exception;

class ArrayToXml
{
    protected $document;

    protected $replaceSpacesByUnderScoresInKeyNames = true;

    protected $addXmlDeclaration = true;

    protected $numericTagNamePrefix = 'numeric_';

    public function __construct(
        array $array,
        $rootElement = '',
        $replaceSpacesByUnderScoresInKeyNames = true,
        $xmlEncoding = null,
        $xmlVersion = '1.0',
        $domProperties = []
    ) {
        $this->document = new DOMDocument($xmlVersion, $xmlEncoding);

        if (! empty($domProperties)) {
            $this->setDomProperties($domProperties);
        }

        $this->replaceSpacesByUnderScoresInKeyNames = $replaceSpacesByUnderScoresInKeyNames;

        if ($this->isArrayAllKeySequential($array) && ! empty($array)) {
            throw new DOMException('Invalid Character Error');
        }

        $root = $this->createRootElement($rootElement);

        $this->document->appendChild($root);

        $this->convertElement($root, $array);
    }

    public function setNumericTagNamePrefix(string $prefix)
    {
        $this->numericTagNamePrefix = $prefix;
    }

    public static function convert(
        array $array,
        $rootElement = '',
        bool $replaceSpacesByUnderScoresInKeyNames = true,
        string $xmlEncoding = null,
        string $xmlVersion = '1.0',
        array $domProperties = []
    ) {
        $converter = new static(
            $array,
            $rootElement,
            $replaceSpacesByUnderScoresInKeyNames,
            $xmlEncoding,
            $xmlVersion,
            $domProperties
        );

        return $converter->toXml();
    }

    public function toXml(): string
    {
        if ($this->addXmlDeclaration === false) {
            return $this->document->saveXml($this->document->documentElement);
        }

        return $this->document->saveXML();
    }

    public function toDom(): DOMDocument
    {
        return $this->document;
    }

    protected function ensureValidDomProperties(array $domProperties)
    {
        foreach ($domProperties as $key => $value) {
            if (! property_exists($this->document, $key)) {
                throw new Exception($key.' is not a valid property of DOMDocument');
            }
        }
    }

    public function setDomProperties(array $domProperties)
    {
        $this->ensureValidDomProperties($domProperties);

        foreach ($domProperties as $key => $value) {
            $this->document->{$key} = $value;
        }

        return $this;
    }

    public function prettify()
    {
        $this->document->preserveWhiteSpace = false;
        $this->document->formatOutput = true;

        return $this;
    }

    public function dropXmlDeclaration()
    {
        $this->addXmlDeclaration = false;

        return $this;
    }

    private function convertElement(DOMElement $element, $value)
    {
        $sequential = $this->isArrayAllKeySequential($value);

        if (! is_array($value)) {
            $value = htmlspecialchars($value);

            $value = $this->removeControlCharacters($value);

            $element->nodeValue = $value;

            return;
        }

        foreach ($value as $key => $data) {
            if (! $sequential) {
                if (($key === '_attributes') || ($key === '@attributes')) {
                    $this->addAttributes($element, $data);
                } elseif ((($key === '_value') || ($key === '@value')) && is_string($data)) {
                    $element->nodeValue = htmlspecialchars($data);
                } elseif ((($key === '_cdata') || ($key === '@cdata')) && is_string($data)) {
                    $element->appendChild($this->document->createCDATASection($data));
                } elseif ((($key === '_mixed') || ($key === '@mixed')) && is_string($data)) {
                    $fragment = $this->document->createDocumentFragment();
                    $fragment->appendXML($data);
                    $element->appendChild($fragment);
                } elseif ($key === '__numeric') {
                    $this->addNumericNode($element, $data);
                } elseif (substr($key, 0, 9) === '__custom:') {
                    $this->addNode($element, explode(':', $key)[1], $data);
                } else {
                    $this->addNode($element, $key, $data);
                }
            } elseif (is_array($data)) {
                $this->addCollectionNode($element, $data);
            } else {
                $this->addSequentialNode($element, $data);
            }
        }
    }

    protected function addNumericNode(DOMElement $element, $value)
    {
        foreach ($value as $key => $item) {
            $this->convertElement($element, [$this->numericTagNamePrefix.$key => $item]);
        }
    }

    protected function addNode(DOMElement $element, $key, $value)
    {
        if ($this->replaceSpacesByUnderScoresInKeyNames) {
            $key = str_replace(' ', '_', $key);
        }

        $child = $this->document->createElement($key);
        $element->appendChild($child);
        $this->convertElement($child, $value);
    }

    protected function addCollectionNode(DOMElement $element, $value)
    {
        if ($element->childNodes->length === 0 && $element->attributes->length === 0) {

            $this->convertElement($element, $value);

            return;
        }

        $child = $this->document->createElement($element->tagName);
        $element->parentNode->appendChild($child);
        $this->convertElement($child, $value);
    }

    protected function addSequentialNode(DOMElement $element, $value)
    {
        if (empty($element->nodeValue) && ! is_numeric($element->nodeValue)) {
            $element->nodeValue = htmlspecialchars($value);

            return;
        }

        $child = new DOMElement($element->tagName);
        $child->nodeValue = htmlspecialchars($value);
        $element->parentNode->appendChild($child);
    }

    protected function isArrayAllKeySequential($value)
    {
        if (! is_array($value)) {
            return false;
        }

        if (count($value) <= 0) {
            return true;
        }

        if (\key($value) === '__numeric') {
            return false;
        }

        return array_unique(array_map('is_int', array_keys($value))) === [true];
    }

    protected function addAttributes(DOMElement $element, array $data)
    {
        foreach ($data as $attrKey => $attrVal) {
            $element->setAttribute($attrKey, $attrVal);
        }
    }

    protected function createRootElement($rootElement): DOMElement
    {
        if (is_string($rootElement)) {
            $rootElementName = $rootElement ?: 'root';

            return $this->document->createElement($rootElementName);
        }

        $rootElementName = $rootElement['rootElementName'] ?? 'root';

        $element = $this->document->createElement($rootElementName);

        foreach ($rootElement as $key => $value) {
            if ($key !== '_attributes' && $key !== '@attributes') {
                continue;
            }

            $this->addAttributes($element, $rootElement[$key]);
        }

        return $element;
    }

    protected function removeControlCharacters(string $value): string
    {
        return preg_replace('/[\x00-\x09\x0B\x0C\x0E-\x1F\x7F]/', '', $value);
    }
}


1			<?php
2
3			namespace Spatie\ArrayToXml;
4
5			use DOMDocument;
6			use DOMElement;
7			use DOMException;
8			use Exception;
9
10			class ArrayToXml
11			{
12			protected $document;
13
14			protected $replaceSpacesByUnderScoresInKeyNames = true;
15
16			protected $addXmlDeclaration = true;
17
18			protected $numericTagNamePrefix = 'numeric_';
19
20			public function __construct(
21			array $array,
22			$rootElement = '',
23			$replaceSpacesByUnderScoresInKeyNames = true,
24			$xmlEncoding = null,
25			$xmlVersion = '1.0',
26			$domProperties = []
27			) {
28			$this->document = new DOMDocument($xmlVersion, $xmlEncoding);
29
30			if (! empty($domProperties)) {
31			$this->setDomProperties($domProperties);
32			}
33
34			$this->replaceSpacesByUnderScoresInKeyNames = $replaceSpacesByUnderScoresInKeyNames;
35
36			if ($this->isArrayAllKeySequential($array) && ! empty($array)) {
37			throw new DOMException('Invalid Character Error');
38			}
39
40			$root = $this->createRootElement($rootElement);
41
42			$this->document->appendChild($root);
43
44			$this->convertElement($root, $array);
45			}
46
47			public function setNumericTagNamePrefix(string $prefix)
48			{
49			$this->numericTagNamePrefix = $prefix;
50			}
51
52			public static function convert(
53			array $array,
54			$rootElement = '',
55			bool $replaceSpacesByUnderScoresInKeyNames = true,
56			string $xmlEncoding = null,
57			string $xmlVersion = '1.0',
58			array $domProperties = []
59			) {
60			$converter = new static(
61			$array,
62			$rootElement,
63			$replaceSpacesByUnderScoresInKeyNames,
64			$xmlEncoding,
65			$xmlVersion,
66			$domProperties
67			);
68
69			return $converter->toXml();
70			}
71
72			public function toXml(): string
73			{
74			if ($this->addXmlDeclaration === false) {
75			return $this->document->saveXml($this->document->documentElement);
76			}
77
78			return $this->document->saveXML();
79			}
80
81			public function toDom(): DOMDocument
82			{
83			return $this->document;
84			}
85
86			protected function ensureValidDomProperties(array $domProperties)
87			{
88			foreach ($domProperties as $key => $value) {
89			if (! property_exists($this->document, $key)) {
90			throw new Exception($key.' is not a valid property of DOMDocument');
91			}
92			}
93			}
94
95			public function setDomProperties(array $domProperties)
96			{
97			$this->ensureValidDomProperties($domProperties);
98
99			foreach ($domProperties as $key => $value) {
100			$this->document->{$key} = $value;
101			}
102
103			return $this;
104			}
105
106			public function prettify()
107			{
108			$this->document->preserveWhiteSpace = false;
109			$this->document->formatOutput = true;
110
111			return $this;
112			}
113
114			public function dropXmlDeclaration()
115			{
116			$this->addXmlDeclaration = false;
117
118			return $this;
119			}
120
121			private function convertElement(DOMElement $element, $value)
122			{
123			$sequential = $this->isArrayAllKeySequential($value);
124
125			if (! is_array($value)) {
126			$value = htmlspecialchars($value);
127
128			$value = $this->removeControlCharacters($value);
129
130			$element->nodeValue = $value;
131
132			return;
133			}
134
135			foreach ($value as $key => $data) {
136			if (! $sequential) {
137			if (($key === '_attributes') \|\| ($key === '@attributes')) {
138			$this->addAttributes($element, $data);
139			} elseif ((($key === '_value') \|\| ($key === '@value')) && is_string($data)) {
140			$element->nodeValue = htmlspecialchars($data);
141			} elseif ((($key === '_cdata') \|\| ($key === '@cdata')) && is_string($data)) {
142			$element->appendChild($this->document->createCDATASection($data));
143			} elseif ((($key === '_mixed') \|\| ($key === '@mixed')) && is_string($data)) {
144			$fragment = $this->document->createDocumentFragment();
145			$fragment->appendXML($data);
146			$element->appendChild($fragment);
147			} elseif ($key === '__numeric') {
148			$this->addNumericNode($element, $data);
149			} elseif (substr($key, 0, 9) === '__custom:') {
150			$this->addNode($element, explode(':', $key)[1], $data);
151			} else {
152			$this->addNode($element, $key, $data);
153			}
154			} elseif (is_array($data)) {
155			$this->addCollectionNode($element, $data);
156			} else {
157			$this->addSequentialNode($element, $data);
158			}
159			}
160			}
161
162			protected function addNumericNode(DOMElement $element, $value)
163			{
164			foreach ($value as $key => $item) {
165			$this->convertElement($element, [$this->numericTagNamePrefix.$key => $item]);
166			}
167			}
168
169			protected function addNode(DOMElement $element, $key, $value)
170			{
171			if ($this->replaceSpacesByUnderScoresInKeyNames) {
172			$key = str_replace(' ', '_', $key);
173			}
174
175			$child = $this->document->createElement($key);
176			$element->appendChild($child);
177			$this->convertElement($child, $value);
178			}
179
180			protected function addCollectionNode(DOMElement $element, $value)
181			{
182			if ($element->childNodes->length === 0 && $element->attributes->length === 0) {
			0 ignored issues – show Bug introduced 2017-08-27 15:06 UTC by Report Bug Copy Issue Report The property `length` does not seem to exist in `DOMNamedNodeMap`. 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...
183			$this->convertElement($element, $value);
184
185			return;
186			}
187
188			$child = $this->document->createElement($element->tagName);
189			$element->parentNode->appendChild($child);
190			$this->convertElement($child, $value);
191			}
192
193			protected function addSequentialNode(DOMElement $element, $value)
194			{
195			if (empty($element->nodeValue) && ! is_numeric($element->nodeValue)) {
196			$element->nodeValue = htmlspecialchars($value);
197
198			return;
199			}
200
201			$child = new DOMElement($element->tagName);
202			$child->nodeValue = htmlspecialchars($value);
203			$element->parentNode->appendChild($child);
204			}
205
206			protected function isArrayAllKeySequential($value)
207			{
208			if (! is_array($value)) {
209			return false;
210			}
211
212			if (count($value) <= 0) {
213			return true;
214			}
215
216			if (\key($value) === '__numeric') {
217			return false;
218			}
219
220			return array_unique(array_map('is_int', array_keys($value))) === [true];
221			}
222
223			protected function addAttributes(DOMElement $element, array $data)
224			{
225			foreach ($data as $attrKey => $attrVal) {
226			$element->setAttribute($attrKey, $attrVal);
227			}
228			}
229
230			protected function createRootElement($rootElement): DOMElement
231			{
232			if (is_string($rootElement)) {
233			$rootElementName = $rootElement ?: 'root';
234
235			return $this->document->createElement($rootElementName);
236			}
237
238			$rootElementName = $rootElement['rootElementName'] ?? 'root';
239
240			$element = $this->document->createElement($rootElementName);
241
242			foreach ($rootElement as $key => $value) {
243			if ($key !== '_attributes' && $key !== '@attributes') {
244			continue;
245			}
246
247			$this->addAttributes($element, $rootElement[$key]);
248			}
249
250			return $element;
251			}
252
253			protected function removeControlCharacters(string $value): string
254			{
255			return preg_replace('/[\x00-\x09\x0B\x0C\x0E-\x1F\x7F]/', '', $value);
256			}
257			}
258

spatie / array-to-xml

GitHub Access Token became invalid

Pull Request — master (#145)

ArrayToXml::isArrayAllKeySequential() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like