ArrayToXml::addAttributes() - Code Metrics - Inspection of "Fix for zero values interpreted as empty" - spatie/array-to-xml - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#112)

by Martin

created 2019-07-23 13:59 UTC

ArrayToXml::addAttributes() A

↳ Parent: ArrayToXml

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	6
rs	10
cc	2
nc	2
nop	2

<?php

namespace Spatie\ArrayToXml;

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

class ArrayToXml
{
    protected $document;

    protected $replaceSpacesByUnderScoresInKeyNames = 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
    {
        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;
    }

    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);
                } 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 => $value]);
        }
    }

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

spatie / array-to-xml

GitHub Access Token became invalid

Pull Request — master (#112)

ArrayToXml::addAttributes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like