AbstractSePartsType::fromXML() - Code Metrics - simplesamlphp/ws-security - Measure and Improve Code Quality continuously with Scrutinizer

AbstractSePartsType::fromXML() A
last analyzed 2025-12-14 17:24 UTC

↳ Parent: AbstractSePartsType

Complexity

Conditions	1
Paths	1

Size

Total Lines	23
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

namespace SimpleSAML\WSSecurity\XML\sp_200702;

use DOMElement;
use SimpleSAML\WSSecurity\Assert\Assert;
use SimpleSAML\XML\ExtendableAttributesTrait;
use SimpleSAML\XML\ExtendableElementTrait;
use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
use SimpleSAML\XMLSchema\Exception\TooManyElementsException;
use SimpleSAML\XMLSchema\XML\Constants\NS;

use function array_pop;
use function sprintf;

/**
 * Class representing WS security policy AbstractSePartsType.
 *
 * @package simplesamlphp/ws-security
 */
abstract class AbstractSePartsType extends AbstractSpElement
{
    use ExtendableElementTrait;

    use ExtendableAttributesTrait;


    /** The namespace-attribute for the xs:any element */
    public const XS_ANY_ELT_NAMESPACE = NS::OTHER;

    /** The namespace-attribute for the xs:anyAttribute element */
    public const XS_ANY_ATTR_NAMESPACE = NS::ANY;


    /**
     * AbstractSePartsType constructor.
     *
     * @param \SimpleSAML\WSSecurity\XML\sp_200702\Body|null $body
     * @param \SimpleSAML\WSSecurity\XML\sp_200702\Header[] $header
     * @param \SimpleSAML\WSSecurity\XML\sp_200702\Attachments|null $attachments
     * @param \SimpleSAML\XML\SerializableElementInterface[] $details
     * @param \SimpleSAML\XML\Attribute[] $namespacedAttributes
     */
    final public function __construct(
        protected ?Body $body = null,
        protected array $header = [],
        protected ?Attachments $attachments = null,
        array $details = [],
        array $namespacedAttributes = [],
    ) {
        $this->setElements($details);
        $this->setAttributesNS($namespacedAttributes);
    }


    /**
     * Collect the Body
     *
     * @return \SimpleSAML\WSSecurity\XML\sp_200702\Body|null
     */
    public function getBody(): ?Body
    {
        return $this->body;
    }


    /**
     * Collect the Header
     *
     * @return \SimpleSAML\WSSecurity\XML\sp_200702\Header[]
     */
    public function getHeader(): array
    {
        return $this->header;
    }


    /**
     * Collect the Attachments
     *
     * @return \SimpleSAML\WSSecurity\XML\sp_200702\Attachments|null
     */
    public function getAttachments(): ?Attachments
    {
        return $this->attachments;
    }


    /**
     * Test if an object, at the state it's in, would produce an empty XML-element
     *
     * @return bool
     */
    public function isEmptyElement(): bool
    {
        return empty($this->getElements())
            && empty($this->getBody())
            && empty($this->getHeader())
            && empty($this->getAttachments())
            && empty($this->getAttributesNS());
    }


    /**
     * Initialize an SePartsType.
     *
     * Note: this method cannot be used when extending this class, if the constructor has a different signature.
     *
     * @param \DOMElement $xml The XML element we should load.
     * @return static
     *
     * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
     *   if the qualified name of the supplied element is wrong
     */
    public static function fromXML(DOMElement $xml): static
    {
        $qualifiedName = static::getClassName(static::class);
        Assert::eq(
            $xml->localName,
            $qualifiedName,
            sprintf('Unexpected name for Empty: %s. Expected: %s.', $xml->localName, $qualifiedName),
            InvalidDOMElementException::class,
        );

        $body = Body::getChildrenOfClass($xml);

        $header = Header::getChildrenOfClass($xml);
        Assert::maxCount($header, 1, TooManyElementsException::class);

        $attachments = Attachments::getChildrenOfClass($xml);

        return new static(
            array_pop($body),
            $header,
            array_pop($attachments),
            self::getChildElementsFromXML($xml),
            self::getAttributesNSFromXML($xml),
        );
    }


    /**
     * Convert this element to XML.
     *
     * @param \DOMElement|null $parent The element we should append this element to.
     * @return \DOMElement
     */
    public function toXML(?DOMElement $parent = null): DOMElement
    {
        $e = $this->instantiateParentElement($parent);

        if ($this->getBody() !== null) {
            $this->getBody()->toXML($e);
        }

        foreach ($this->getHeader() as $header) {
            $header->toXML($e);
        }

        if ($this->getAttachments() !== null) {
            $this->getAttachments()->toXML($e);
        }

        foreach ($this->getElements() as $elt) {
            if (!$elt->isEmptyElement()) {
                $elt->toXML($e);
            }
        }

        foreach ($this->getAttributesNS() as $attr) {
            $attr->toXML($e);
        }

        return $e;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\WSSecurity\XML\sp_200702;
6
7			use DOMElement;
8			use SimpleSAML\WSSecurity\Assert\Assert;
9			use SimpleSAML\XML\ExtendableAttributesTrait;
10			use SimpleSAML\XML\ExtendableElementTrait;
11			use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
12			use SimpleSAML\XMLSchema\Exception\TooManyElementsException;
13			use SimpleSAML\XMLSchema\XML\Constants\NS;
14
15			use function array_pop;
16			use function sprintf;
17
18			/**
19			* Class representing WS security policy AbstractSePartsType.
20			*
21			* @package simplesamlphp/ws-security
22			*/
23			abstract class AbstractSePartsType extends AbstractSpElement
24			{
25			use ExtendableElementTrait;
			0 ignored issues – show introduced 2024-09-16 11:33 UTC by Report Bug Copy Issue Report The trait `SimpleSAML\XML\ExtendableElementTrait` requires some properties which are not provided by `SimpleSAML\WSSecurity\XM...702\AbstractSePartsType`: `$namespaceURI`, `$localName`, `$childNodes` Loading history...
26			use ExtendableAttributesTrait;
27
28
29			/** The namespace-attribute for the xs:any element */
30			public const XS_ANY_ELT_NAMESPACE = NS::OTHER;
31
32			/** The namespace-attribute for the xs:anyAttribute element */
33			public const XS_ANY_ATTR_NAMESPACE = NS::ANY;
34
35
36			/**
37			* AbstractSePartsType constructor.
38			*
39			* @param \SimpleSAML\WSSecurity\XML\sp_200702\Body\|null $body
40			* @param \SimpleSAML\WSSecurity\XML\sp_200702\Header[] $header
41			* @param \SimpleSAML\WSSecurity\XML\sp_200702\Attachments\|null $attachments
42			* @param \SimpleSAML\XML\SerializableElementInterface[] $details
43			* @param \SimpleSAML\XML\Attribute[] $namespacedAttributes
44			*/
45			final public function __construct(
46			protected ?Body $body = null,
47			protected array $header = [],
48			protected ?Attachments $attachments = null,
49			array $details = [],
50			array $namespacedAttributes = [],
51			) {
52			$this->setElements($details);
53			$this->setAttributesNS($namespacedAttributes);
54			}
55
56
57			/**
58			* Collect the Body
59			*
60			* @return \SimpleSAML\WSSecurity\XML\sp_200702\Body\|null
61			*/
62			public function getBody(): ?Body
63			{
64			return $this->body;
65			}
66
67
68			/**
69			* Collect the Header
70			*
71			* @return \SimpleSAML\WSSecurity\XML\sp_200702\Header[]
72			*/
73			public function getHeader(): array
74			{
75			return $this->header;
76			}
77
78
79			/**
80			* Collect the Attachments
81			*
82			* @return \SimpleSAML\WSSecurity\XML\sp_200702\Attachments\|null
83			*/
84			public function getAttachments(): ?Attachments
85			{
86			return $this->attachments;
87			}
88
89
90			/**
91			* Test if an object, at the state it's in, would produce an empty XML-element
92			*
93			* @return bool
94			*/
95			public function isEmptyElement(): bool
96			{
97			return empty($this->getElements())
98			&& empty($this->getBody())
99			&& empty($this->getHeader())
100			&& empty($this->getAttachments())
101			&& empty($this->getAttributesNS());
102			}
103
104
105			/**
106			* Initialize an SePartsType.
107			*
108			* Note: this method cannot be used when extending this class, if the constructor has a different signature.
109			*
110			* @param \DOMElement $xml The XML element we should load.
111			* @return static
112			*
113			* @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
114			* if the qualified name of the supplied element is wrong
115			*/
116			public static function fromXML(DOMElement $xml): static
117			{
118			$qualifiedName = static::getClassName(static::class);
119			Assert::eq(
120			$xml->localName,
121			$qualifiedName,
122			sprintf('Unexpected name for Empty: %s. Expected: %s.', $xml->localName, $qualifiedName),
123			InvalidDOMElementException::class,
124			);
125
126			$body = Body::getChildrenOfClass($xml);
127
128			$header = Header::getChildrenOfClass($xml);
129			Assert::maxCount($header, 1, TooManyElementsException::class);
130
131			$attachments = Attachments::getChildrenOfClass($xml);
132
133			return new static(
134			array_pop($body),
135			$header,
136			array_pop($attachments),
137			self::getChildElementsFromXML($xml),
138			self::getAttributesNSFromXML($xml),
139			);
140			}
141
142
143			/**
144			* Convert this element to XML.
145			*
146			* @param \DOMElement\|null $parent The element we should append this element to.
147			* @return \DOMElement
148			*/
149			public function toXML(?DOMElement $parent = null): DOMElement
150			{
151			$e = $this->instantiateParentElement($parent);
152
153			if ($this->getBody() !== null) {
154			$this->getBody()->toXML($e);
155			}
156
157			foreach ($this->getHeader() as $header) {
158			$header->toXML($e);
159			}
160
161			if ($this->getAttachments() !== null) {
162			$this->getAttachments()->toXML($e);
163			}
164
165			foreach ($this->getElements() as $elt) {
166			if (!$elt->isEmptyElement()) {
167			$elt->toXML($e);
168			}
169			}
170
171			foreach ($this->getAttributesNS() as $attr) {
172			$attr->toXML($e);
173			}
174
175			return $e;
176			}
177			}
178

simplesamlphp / ws-security

AbstractSePartsType::fromXML() A last analyzed 2025-12-14 17:24 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractSePartsType::fromXML() A
last analyzed 2025-12-14 17:24 UTC