DsObject::setId() - Code Metrics - Inspection of "Add & implement ds:Object element" - simplesamlphp/xml-security - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#19)

by Tim

created 2022-09-17 09:22 UTC

DsObject::setId() A

↳ Parent: DsObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
cc	1
eloc	2
c	2
b	0
f	1
nc	1
nop	1
dl	0
loc	4
rs	10

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSecurity\XML\ds;

use DOMElement;
use SimpleSAML\Assert\Assert;
use SimpleSAML\XML\Chunk;
use SimpleSAML\XML\Constants;
use SimpleSAML\XML\Exception\InvalidDOMElementException;
use SimpleSAML\XML\ExtendableElementTrait;
use SimpleSAML\XMLSecurity\Exception\InvalidArgumentException;

/**
 * Class representing a ds:Object element.
 *
 * @package simplesamlphp/xml-security
 */
final class DsObject extends AbstractDsElement
{
    use ExtendableElementTrait;

    /** @var string */
    public const LOCALNAME = 'Object';

    /** @var string */
    public const NAMESPACE = Constants::XS_ANY_NS_ANY;

    /**
     * The Id.
     *
     * @var string|null
     */
    protected ?string $Id;

    /**
     * The MIME type.
     *
     * @var string|null
     */
    protected ?string $MimeType;

    /**
     * The encoding.
     *
     * @var string|null
     */
    protected ?string $Encoding;


    /**
     * Initialize a ds:Object element.
     *
     * @param string|null $Id
     * @param string|null $MimeType
     * @param string|null $Encoding
     * @param \SimpleSAML\XML\ElementInterface[] $elements
     */
    public function __construct(
        ?string $Id = null,
        ?string $MimeType = null,
        ?string $Encoding = null,
        array $elements = []
    ) {
        $this->setId($Id);
        $this->setMimeType($MimeType);
        $this->setEncoding($Encoding);
        $this->setElements($elements);
    }


    /**
     * Collect the value of the Id-property
     *
     * @return string|null
     */
    public function getId(): ?string
    {
        return $this->Id;
    }


    /**
     * Set the value of the Id-property
     *
     * @param string $Id
     */
    private function setId(?string $Id): void
    {
        Assert::nullOrValidNCName($Id);
        $this->Id = $Id;
    }


    /**
     * Collect the value of the MimeType-property
     *
     * @return string|null
     */
    public function getMimeType(): ?string
    {
        return $this->MimeType;
    }


    /**
     * Set the value of the MimeType-property
     *
     * @param string|null $MimeType
     */
    private function setMimeType(?string $MimeType): void
    {
        $this->MimeType = $MimeType;
    }


    /**
     * Collect the value of the Encoding-property
     *
     * @return string|null
     */
    public function getEncoding(): ?string
    {
        return $this->Encoding;
    }


    /**
     * Set the value of the Encoding-property
     *
     * @param string|null $Encoding
     */
    private function setEncoding(?string $Encoding): void
    {
        Assert::nullOrValidURI($Encoding);
        $this->Encoding = $Encoding;
    }


    /**
     * 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->elements)
            && empty($this->Id)
            && empty($this->MimeType)
            && empty($this->Encoding)
        );
    }


    /**
     * Convert XML into a ds:Object
     *
     * @param \DOMElement $xml The XML element we should load
     * @return static
     *
     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
     *   If the qualified name of the supplied element is wrong
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, 'Object', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, DsObject::NS, InvalidDOMElementException::class);

        $Id = DsObject::getAttribute($xml, 'Id');
        $MimeType = DsObject::getAttribute($xml, 'MimeType');
        $Encoding = DsObject::getAttribute($xml, 'Encoding');

        $elements = [];
        foreach ($xml->childNodes as $elt) {
            if (!($elt instanceof DOMElement)) {
                continue;
            }

            $elements[] = new Chunk($elt);
        }

        return new static($Id, $MimeType, $Encoding, $elements);
    }


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

        if ($this->Id !== null) {
            $e->setAttribute('Id', $this->Id);
        }

        if ($this->MimeType !== null) {
            $e->setAttribute('MimeType', $this->MimeType);
        }

        if ($this->Encoding !== null) {
            $e->setAttribute('Encoding', $this->Encoding);
        }

        /** @psalm-var \SimpleSAML\XML\SerializableElementInterface[] $this->elements */
        foreach ($this->elements as $elt) {
            $elt->toXML($e);
        }

        return $e;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\XMLSecurity\XML\ds;
6
7			use DOMElement;
8			use SimpleSAML\Assert\Assert;
9			use SimpleSAML\XML\Chunk;
10			use SimpleSAML\XML\Constants;
11			use SimpleSAML\XML\Exception\InvalidDOMElementException;
12			use SimpleSAML\XML\ExtendableElementTrait;
13			use SimpleSAML\XMLSecurity\Exception\InvalidArgumentException;
14
15			/**
16			* Class representing a ds:Object element.
17			*
18			* @package simplesamlphp/xml-security
19			*/
20			final class DsObject extends AbstractDsElement
21			{
22			use ExtendableElementTrait;
23
24			/** @var string */
25			public const LOCALNAME = 'Object';
26
27			/** @var string */
28			public const NAMESPACE = Constants::XS_ANY_NS_ANY;
29
30			/**
31			* The Id.
32			*
33			* @var string\|null
34			*/
35			protected ?string $Id;
36
37			/**
38			* The MIME type.
39			*
40			* @var string\|null
41			*/
42			protected ?string $MimeType;
43
44			/**
45			* The encoding.
46			*
47			* @var string\|null
48			*/
49			protected ?string $Encoding;
50
51
52			/**
53			* Initialize a ds:Object element.
54			*
55			* @param string\|null $Id
56			* @param string\|null $MimeType
57			* @param string\|null $Encoding
58			* @param \SimpleSAML\XML\ElementInterface[] $elements
59			*/
60			public function __construct(
61			?string $Id = null,
62			?string $MimeType = null,
63			?string $Encoding = null,
64			array $elements = []
65			) {
66			$this->setId($Id);
67			$this->setMimeType($MimeType);
68			$this->setEncoding($Encoding);
69			$this->setElements($elements);
70			}
71
72
73			/**
74			* Collect the value of the Id-property
75			*
76			* @return string\|null
77			*/
78			public function getId(): ?string
79			{
80			return $this->Id;
81			}
82
83
84			/**
85			* Set the value of the Id-property
86			*
87			* @param string $Id
88			*/
89			private function setId(?string $Id): void
90			{
91			Assert::nullOrValidNCName($Id);
92			$this->Id = $Id;
93			}
94
95
96			/**
97			* Collect the value of the MimeType-property
98			*
99			* @return string\|null
100			*/
101			public function getMimeType(): ?string
102			{
103			return $this->MimeType;
104			}
105
106
107			/**
108			* Set the value of the MimeType-property
109			*
110			* @param string\|null $MimeType
111			*/
112			private function setMimeType(?string $MimeType): void
113			{
114			$this->MimeType = $MimeType;
115			}
116
117
118			/**
119			* Collect the value of the Encoding-property
120			*
121			* @return string\|null
122			*/
123			public function getEncoding(): ?string
124			{
125			return $this->Encoding;
126			}
127
128
129			/**
130			* Set the value of the Encoding-property
131			*
132			* @param string\|null $Encoding
133			*/
134			private function setEncoding(?string $Encoding): void
135			{
136			Assert::nullOrValidURI($Encoding);
137			$this->Encoding = $Encoding;
138			}
139
140
141			/**
142			* Test if an object, at the state it's in, would produce an empty XML-element
143			*
144			* @return bool
145			*/
146			public function isEmptyElement(): bool
147			{
148			return (
149			empty($this->elements)
150			&& empty($this->Id)
151			&& empty($this->MimeType)
152			&& empty($this->Encoding)
153			);
154			}
155
156
157			/**
158			* Convert XML into a ds:Object
159			*
160			* @param \DOMElement $xml The XML element we should load
161			* @return static
162			*
163			* @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
164			* If the qualified name of the supplied element is wrong
165			*/
166			public static function fromXML(DOMElement $xml): static
167			{
168			Assert::same($xml->localName, 'Object', InvalidDOMElementException::class);
169			Assert::same($xml->namespaceURI, DsObject::NS, InvalidDOMElementException::class);
170
171			$Id = DsObject::getAttribute($xml, 'Id');
172			$MimeType = DsObject::getAttribute($xml, 'MimeType');
173			$Encoding = DsObject::getAttribute($xml, 'Encoding');
174
175			$elements = [];
176			foreach ($xml->childNodes as $elt) {
177			if (!($elt instanceof DOMElement)) {
178			continue;
179			}
180
181			$elements[] = new Chunk($elt);
182			}
183
184			return new static($Id, $MimeType, $Encoding, $elements);
185			}
186
187
188			/**
189			* Convert this ds:Object element to XML.
190			*
191			* @param \DOMElement\|null $parent The element we should append this ds:Object element to.
192			* @return \DOMElement
193			*/
194			public function toXML(DOMElement $parent = null): DOMElement
195			{
196			$e = $this->instantiateParentElement($parent);
197
198			if ($this->Id !== null) {
199			$e->setAttribute('Id', $this->Id);
200			}
201
202			if ($this->MimeType !== null) {
203			$e->setAttribute('MimeType', $this->MimeType);
204			}
205
206			if ($this->Encoding !== null) {
207			$e->setAttribute('Encoding', $this->Encoding);
208			}
209
210			/** @psalm-var \SimpleSAML\XML\SerializableElementInterface[] $this->elements */
211			foreach ($this->elements as $elt) {
212			$elt->toXML($e);
213			}
214
215			return $e;
216			}
217			}
218

simplesamlphp / xml-security

Pull Request — master (#19)

DsObject::setId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like