ExtendableElementTrait::getElementExclusions() - Code Metrics - simplesamlphp/xml-common - Measure and Improve Code Quality continuously with Scrutinizer

ExtendableElementTrait::getElementExclusions() A
last analyzed 2025-10-27 22:10 UTC

↳ Parent: ExtendableElementTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
c	0
b	0
f	0
dl	0
loc	7
rs	10
cc	2
nc	2
nop	0

<?php

declare(strict_types=1);

namespace SimpleSAML\XML;

use DOMElement;
use RuntimeException;
use SimpleSAML\XML\Assert\Assert;
use SimpleSAML\XML\Chunk;
use SimpleSAML\XML\Constants as C;
use SimpleSAML\XML\Registry\ElementRegistry;
use SimpleSAML\XMLSchema\XML\Constants\NS;

use function array_diff;
use function array_map;
use function array_search;
use function defined;
use function implode;
use function is_array;
use function rtrim;
use function sprintf;

/**
 * Trait grouping common functionality for elements implementing the xs:any element.
 *
 * @package simplesamlphp/xml-common
 */
trait ExtendableElementTrait
{
    /** @var \SimpleSAML\XML\SerializableElementInterface[] */
    protected array $elements = [];


    /**
     * Parse an XML document and get the child elements from the specified namespace(s).
     * The namespace defaults to the XS_ANY_ELT_NAMESPACE constant on the element.
     * NOTE: In case the namespace is ##any, this method will also return local non-namespaced elements!
     *
     * @param \DOMElement $xml
     * @param string|string[]|null $namespace
     * @return list<\SimpleSAML\XML\SerializableElementInterface> $elements
     */
    protected static function getChildElementsFromXML(
        DOMElement $xml,
        string|array|null $namespace = null,
    ): array {
        $namespace = $namespace ?? self::XS_ANY_ELT_NAMESPACE;
        $exclusionList = self::getElementExclusions();
        $registry = ElementRegistry::getInstance();
        $elements = [];

        // Validate namespace value
        if (!is_array($namespace)) {
            // Must be one of the predefined values
            Assert::oneOf($namespace, NS::$PREDEFINED);

            foreach ($xml->childNodes as $elt) {
                if (!($elt instanceof DOMElement)) {
                    continue;
                } elseif (in_array([$elt->namespaceURI, $elt->localName], $exclusionList, true)) {
                    continue;
                } elseif ($namespace === NS::OTHER && in_array($elt->namespaceURI, [self::NS, null], true)) {

                    continue;
                } elseif ($namespace === NS::TARGETNAMESPACE && $elt->namespaceURI !== self::NS) {
                    continue;
                } elseif ($namespace === NS::LOCAL && $elt->namespaceURI !== null) {
                    continue;
                }

                $handler = $registry->getElementHandler($elt->namespaceURI, $elt->localName);
                $elements[] = ($handler === null) ? Chunk::fromXML($elt) : $handler::fromXML($elt);
            }
        } else {
            // Array must be non-empty and cannot contain ##any or ##other
            Assert::notEmpty($namespace);
            Assert::allStringNotEmpty($namespace);
            Assert::allNotSame($namespace, NS::ANY);
            Assert::allNotSame($namespace, NS::OTHER);

            // Replace the ##targetedNamespace with the actual namespace
            if (($key = array_search(NS::TARGETNAMESPACE, $namespace)) !== false) {
                $namespace[$key] = self::NS;
            }

            // Replace the ##local with null
            if (($key = array_search(NS::LOCAL, $namespace)) !== false) {
                $namespace[$key] = null;
            }

            foreach ($xml->childNodes as $elt) {
                if (!($elt instanceof DOMElement)) {
                    continue;
                } elseif (in_array([$elt->namespaceURI, $elt->localName], $exclusionList, true)) {
                    continue;
                } elseif (!in_array($elt->namespaceURI, $namespace, true)) {
                    continue;
                }

                $handler = $registry->getElementHandler($elt->namespaceURI, $elt->localName);
                $elements[] = ($handler === null) ? Chunk::fromXML($elt) : $handler::fromXML($elt);
            }
        }

        return $elements;

    }


    /**
     * Set an array with all elements present.
     *
     * @param \SimpleSAML\XML\SerializableElementInterface[] $elements
     * @return void
     */
    protected function setElements(array $elements): void
    {
        Assert::maxCount($elements, C::UNBOUNDED_LIMIT);
        Assert::allIsInstanceOf($elements, SerializableElementInterface::class);

        $namespace = $this->getElementNamespace();
        // Validate namespace value
        if (!is_array($namespace)) {
            // Must be one of the predefined values
            Assert::oneOf($namespace, NS::$PREDEFINED);
        } else {
            // Array must be non-empty and cannot contain ##any or ##other
            Assert::notEmpty($namespace);
            Assert::allNotSame($namespace, NS::ANY);
            Assert::allNotSame($namespace, NS::OTHER);
        }

        // Get namespaces for all elements
        /** @var array<\SimpleSAML\XML\AbstractElement|\SimpleSAML\XML\Chunk> $elements */
        $actual_namespaces = array_map(
            /**
             * @return string|null
             */
            function (AbstractElement|Chunk $elt): ?string {
                return ($elt instanceof Chunk) ? $elt->getNamespaceURI() : $elt::getNamespaceURI();
            },
            $elements,
        );

        if ($namespace === NS::LOCAL) {
            // If ##local then all namespaces must be null
            Assert::allNull($actual_namespaces);
        } elseif (is_array($namespace)) {
            // Make a local copy of the property that we can edit
            $allowed_namespaces = $namespace;

            // Replace the ##targetedNamespace with the actual namespace
            if (($key = array_search(NS::TARGETNAMESPACE, $allowed_namespaces)) !== false) {
                $allowed_namespaces[$key] = self::NS;
            }

            // Replace the ##local with null
            if (($key = array_search(NS::LOCAL, $allowed_namespaces)) !== false) {
                $allowed_namespaces[$key] = null;
            }

            $diff = array_diff($actual_namespaces, $allowed_namespaces);
            Assert::isEmpty(
                $diff,
                sprintf(
                    'Elements from namespaces [ %s ] are not allowed inside a %s element.',
                    rtrim(implode(', ', $diff)),
                    self::NS,
                ),
            );
        } elseif ($namespace === NS::OTHER) {
            // Must be any namespace other than the parent element, excluding elements with no namespace
            Assert::notInArray(null, $actual_namespaces);
            Assert::allNotSame($actual_namespaces, self::NS);
        } elseif ($namespace === NS::TARGETNAMESPACE) {
            // Must be the same namespace as the one of the parent element
            Assert::allSame($actual_namespaces, self::NS);
        } else {
            // XS_ANY_NS_ANY
        }

        $exclusionList = self::getElementExclusions();
        foreach ($elements as $i => $elt) {
            if (in_array([$elt->getNamespaceURI(), $elt->getLocalName()], $exclusionList, true)) {
                unset($elements[$i]);
            }
        }

        $this->elements = $elements;
    }


    /**
     * Get an array with all elements present.
     *
     * @return \SimpleSAML\XML\SerializableElementInterface[]
     */
    public function getElements(): array
    {
        return $this->elements;
    }


    /**
     * @return string|string[]
     */
    public function getElementNamespace(): array|string
    {
        Assert::true(
            defined('self::XS_ANY_ELT_NAMESPACE'),
            self::getClassName(self::class)
            . '::XS_ANY_ELT_NAMESPACE constant must be defined and set to the namespace for the xs:any element.',
            RuntimeException::class,
        );

        return self::XS_ANY_ELT_NAMESPACE;
    }


    /**
     * Get the exclusions list for getChildElementsFromXML.
     *
     * @return array{array{string|null, string}}|array{}

     */
    public static function getElementExclusions(): array
    {
        if (defined('self::XS_ANY_ELT_EXCLUSIONS')) {
            return self::XS_ANY_ELT_EXCLUSIONS;
        }

        return [];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\XML;
6
7			use DOMElement;
8			use RuntimeException;
9			use SimpleSAML\XML\Assert\Assert;
10			use SimpleSAML\XML\Chunk;
11			use SimpleSAML\XML\Constants as C;
12			use SimpleSAML\XML\Registry\ElementRegistry;
13			use SimpleSAML\XMLSchema\XML\Constants\NS;
14
15			use function array_diff;
16			use function array_map;
17			use function array_search;
18			use function defined;
19			use function implode;
20			use function is_array;
21			use function rtrim;
22			use function sprintf;
23
24			/**
25			* Trait grouping common functionality for elements implementing the xs:any element.
26			*
27			* @package simplesamlphp/xml-common
28			*/
29			trait ExtendableElementTrait
30			{
31			/** @var \SimpleSAML\XML\SerializableElementInterface[] */
32			protected array $elements = [];
33
34
35			/**
36			* Parse an XML document and get the child elements from the specified namespace(s).
37			* The namespace defaults to the XS_ANY_ELT_NAMESPACE constant on the element.
38			* NOTE: In case the namespace is ##any, this method will also return local non-namespaced elements!
39			*
40			* @param \DOMElement $xml
41			* @param string\|string[]\|null $namespace
42			* @return list<\SimpleSAML\XML\SerializableElementInterface> $elements
43			*/
44			protected static function getChildElementsFromXML(
45			DOMElement $xml,
46			string\|array\|null $namespace = null,
47			): array {
48			$namespace = $namespace ?? self::XS_ANY_ELT_NAMESPACE;
49			$exclusionList = self::getElementExclusions();
50			$registry = ElementRegistry::getInstance();
51			$elements = [];
52
53			// Validate namespace value
54			if (!is_array($namespace)) {
55			// Must be one of the predefined values
56			Assert::oneOf($namespace, NS::$PREDEFINED);
57
58			foreach ($xml->childNodes as $elt) {
59			if (!($elt instanceof DOMElement)) {
60			continue;
61			} elseif (in_array([$elt->namespaceURI, $elt->localName], $exclusionList, true)) {
62			continue;
63			} elseif ($namespace === NS::OTHER && in_array($elt->namespaceURI, [self::NS, null], true)) {
			0 ignored issues – show Bug introduced 2025-06-28 19:06 UTC by Report Bug Copy Issue Report The constant `SimpleSAML\XML\ExtendableElementTrait::NS` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
64			continue;
65			} elseif ($namespace === NS::TARGETNAMESPACE && $elt->namespaceURI !== self::NS) {
66			continue;
67			} elseif ($namespace === NS::LOCAL && $elt->namespaceURI !== null) {
68			continue;
69			}
70
71			$handler = $registry->getElementHandler($elt->namespaceURI, $elt->localName);
72			$elements[] = ($handler === null) ? Chunk::fromXML($elt) : $handler::fromXML($elt);
73			}
74			} else {
75			// Array must be non-empty and cannot contain ##any or ##other
76			Assert::notEmpty($namespace);
77			Assert::allStringNotEmpty($namespace);
78			Assert::allNotSame($namespace, NS::ANY);
79			Assert::allNotSame($namespace, NS::OTHER);
80
81			// Replace the ##targetedNamespace with the actual namespace
82			if (($key = array_search(NS::TARGETNAMESPACE, $namespace)) !== false) {
83			$namespace[$key] = self::NS;
84			}
85
86			// Replace the ##local with null
87			if (($key = array_search(NS::LOCAL, $namespace)) !== false) {
88			$namespace[$key] = null;
89			}
90
91			foreach ($xml->childNodes as $elt) {
92			if (!($elt instanceof DOMElement)) {
93			continue;
94			} elseif (in_array([$elt->namespaceURI, $elt->localName], $exclusionList, true)) {
95			continue;
96			} elseif (!in_array($elt->namespaceURI, $namespace, true)) {
97			continue;
98			}
99
100			$handler = $registry->getElementHandler($elt->namespaceURI, $elt->localName);
101			$elements[] = ($handler === null) ? Chunk::fromXML($elt) : $handler::fromXML($elt);
102			}
103			}
104
105			return $elements;
			0 ignored issues – show Bug Best Practice introduced 2025-06-28 19:06 UTC by Report Bug Copy Issue Report The expression `return $elements` returns the type `array\|array<mixed,SimpleSAML\XML\Chunk\|mixed>` which is incompatible with the documented return type `SimpleSAML\XML\list`. Loading history...
106			}
107
108
109			/**
110			* Set an array with all elements present.
111			*
112			* @param \SimpleSAML\XML\SerializableElementInterface[] $elements
113			* @return void
114			*/
115			protected function setElements(array $elements): void
116			{
117			Assert::maxCount($elements, C::UNBOUNDED_LIMIT);
118			Assert::allIsInstanceOf($elements, SerializableElementInterface::class);
119
120			$namespace = $this->getElementNamespace();
121			// Validate namespace value
122			if (!is_array($namespace)) {
123			// Must be one of the predefined values
124			Assert::oneOf($namespace, NS::$PREDEFINED);
125			} else {
126			// Array must be non-empty and cannot contain ##any or ##other
127			Assert::notEmpty($namespace);
128			Assert::allNotSame($namespace, NS::ANY);
129			Assert::allNotSame($namespace, NS::OTHER);
130			}
131
132			// Get namespaces for all elements
133			/** @var array<\SimpleSAML\XML\AbstractElement\|\SimpleSAML\XML\Chunk> $elements */
134			$actual_namespaces = array_map(
135			/**
136			* @return string\|null
137			*/
138			function (AbstractElement\|Chunk $elt): ?string {
139			return ($elt instanceof Chunk) ? $elt->getNamespaceURI() : $elt::getNamespaceURI();
140			},
141			$elements,
142			);
143
144			if ($namespace === NS::LOCAL) {
145			// If ##local then all namespaces must be null
146			Assert::allNull($actual_namespaces);
147			} elseif (is_array($namespace)) {
148			// Make a local copy of the property that we can edit
149			$allowed_namespaces = $namespace;
150
151			// Replace the ##targetedNamespace with the actual namespace
152			if (($key = array_search(NS::TARGETNAMESPACE, $allowed_namespaces)) !== false) {
153			$allowed_namespaces[$key] = self::NS;
154			}
155
156			// Replace the ##local with null
157			if (($key = array_search(NS::LOCAL, $allowed_namespaces)) !== false) {
158			$allowed_namespaces[$key] = null;
159			}
160
161			$diff = array_diff($actual_namespaces, $allowed_namespaces);
162			Assert::isEmpty(
163			$diff,
164			sprintf(
165			'Elements from namespaces [ %s ] are not allowed inside a %s element.',
166			rtrim(implode(', ', $diff)),
167			self::NS,
168			),
169			);
170			} elseif ($namespace === NS::OTHER) {
171			// Must be any namespace other than the parent element, excluding elements with no namespace
172			Assert::notInArray(null, $actual_namespaces);
173			Assert::allNotSame($actual_namespaces, self::NS);
174			} elseif ($namespace === NS::TARGETNAMESPACE) {
175			// Must be the same namespace as the one of the parent element
176			Assert::allSame($actual_namespaces, self::NS);
177			} else {
178			// XS_ANY_NS_ANY
179			}
180
181			$exclusionList = self::getElementExclusions();
182			foreach ($elements as $i => $elt) {
183			if (in_array([$elt->getNamespaceURI(), $elt->getLocalName()], $exclusionList, true)) {
184			unset($elements[$i]);
185			}
186			}
187
188			$this->elements = $elements;
189			}
190
191
192			/**
193			* Get an array with all elements present.
194			*
195			* @return \SimpleSAML\XML\SerializableElementInterface[]
196			*/
197			public function getElements(): array
198			{
199			return $this->elements;
200			}
201
202
203			/**
204			* @return string\|string[]
205			*/
206			public function getElementNamespace(): array\|string
207			{
208			Assert::true(
209			defined('self::XS_ANY_ELT_NAMESPACE'),
210			self::getClassName(self::class)
211			. '::XS_ANY_ELT_NAMESPACE constant must be defined and set to the namespace for the xs:any element.',
212			RuntimeException::class,
213			);
214
215			return self::XS_ANY_ELT_NAMESPACE;
216			}
217
218
219			/**
220			* Get the exclusions list for getChildElementsFromXML.
221			*
222			* @return array{array{string\|null, string}}\|array{}
			0 ignored issues – show Documentation Bug introduced 2025-06-28 19:06 UTC by Report Bug Copy Issue Report The doc comment `array{array{string\|null, string}}\|array{}` at position `2` could not be parsed: Expected ':' at position 2, but found 'array'. Loading history...
223			*/
224			public static function getElementExclusions(): array
225			{
226			if (defined('self::XS_ANY_ELT_EXCLUSIONS')) {
227			return self::XS_ANY_ELT_EXCLUSIONS;
228			}
229
230			return [];
231			}
232			}
233

simplesamlphp / xml-common

ExtendableElementTrait::getElementExclusions() A last analyzed 2025-10-27 22:10 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ExtendableElementTrait::getElementExclusions() A
last analyzed 2025-10-27 22:10 UTC