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

Passed

Pull Request — master (#19)

by Tim

created 2021-12-30 20:44 UTC

DsObject::getId() A

↳ Parent: DsObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSecurity\XML\ds;

use DOMElement;
use SimpleSAML\Assert\Assert;
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\XMLElementInterface[] $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
    {
        $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
    {
        $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 self
     *
     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
     *   If the qualified name of the supplied element is wrong
     */
    public static function fromXML(DOMElement $xml): object
    {
        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);
filter:
    dependency_paths: ["lib/*"]
        }

        return new self($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);
        $e->setAttribute('Id', $this->Id);
        $e->setAttribute('MimeType', $this->MimeType);
        $e->setAttribute('Encoding', $this->Encoding);

        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\Constants;
10			use SimpleSAML\XML\Exception\InvalidDOMElementException;
11			use SimpleSAML\XML\ExtendableElementTrait;
12			use SimpleSAML\XMLSecurity\Exception\InvalidArgumentException;
13
14			/**
15			* Class representing a ds:Object element.
16			*
17			* @package simplesamlphp/xml-security
18			*/
19			final class DsObject extends AbstractDsElement
20			{
21			use ExtendableElementTrait;
22
23			/** @var string */
24			public const LOCALNAME = 'Object';
25
26			/** @var string */
27			public const NAMESPACE = Constants::XS_ANY_NS_ANY;
28
29			/**
30			* The Id.
31			*
32			* @var string\|null
33			*/
34			protected ?string $Id;
35
36			/**
37			* The MIME type.
38			*
39			* @var string\|null
40			*/
41			protected ?string $MimeType;
42
43			/**
44			* The encoding.
45			*
46			* @var string\|null
47			*/
48			protected ?string $Encoding;
49
50
51			/**
52			* Initialize a ds:Object element.
53			*
54			* @param string\|null $Id
55			* @param string\|null $MimeType
56			* @param string\|null $Encoding
57			* @param \SimpleSAML\XML\XMLElementInterface[] $elements
58			*/
59			public function __construct(
60			?string $Id = null,
61			?string $MimeType = null,
62			?string $Encoding = null,
63			array $elements = []
64			) {
65			$this->setId($Id);
66			$this->setMimeType($MimeType);
67			$this->setEncoding($Encoding);
68			$this->setElements($elements);
69			}
70
71
72			/**
73			* Collect the value of the Id-property
74			*
75			* @return string\|null
76			*/
77			public function getId(): ?string
78			{
79			return $this->Id;
80			}
81
82
83			/**
84			* Set the value of the Id-property
85			*
86			* @param string $Id
87			*/
88			private function setId(?string $Id): void
89			{
90			$this->Id = $Id;
91			}
92
93
94			/**
95			* Collect the value of the MimeType-property
96			*
97			* @return string\|null
98			*/
99			public function getMimeType(): ?string
100			{
101			return $this->MimeType;
102			}
103
104
105			/**
106			* Set the value of the MimeType-property
107			*
108			* @param string\|null $MimeType
109			*/
110			private function setMimeType(?string $MimeType): void
111			{
112			$this->MimeType = $MimeType;
113			}
114
115
116			/**
117			* Collect the value of the Encoding-property
118			*
119			* @return string\|null
120			*/
121			public function getEncoding(): ?string
122			{
123			return $this->Encoding;
124			}
125
126
127			/**
128			* Set the value of the Encoding-property
129			*
130			* @param string\|null $Encoding
131			*/
132			private function setEncoding(?string $Encoding): void
133			{
134			$this->Encoding = $Encoding;
135			}
136
137
138			/**
139			* Test if an object, at the state it's in, would produce an empty XML-element
140			*
141			* @return bool
142			*/
143			public function isEmptyElement(): bool
144			{
145			return (
146			empty($this->elements)
147			&& empty($this->Id)
148			&& empty($this->MimeType)
149			&& empty($this->Encoding)
150			);
151			}
152
153
154			/**
155			* Convert XML into a ds:Object
156			*
157			* @param \DOMElement $xml The XML element we should load
158			* @return self
159			*
160			* @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
161			* If the qualified name of the supplied element is wrong
162			*/
163			public static function fromXML(DOMElement $xml): object
164			{
165			Assert::same($xml->localName, 'Object', InvalidDOMElementException::class);
166			Assert::same($xml->namespaceURI, DSObject::NS, InvalidDOMElementException::class);
167
168			$Id = DsObject::getAttribute($xml, 'Id');
169			$MimeType = DsObject::getAttribute($xml, 'MimeType');
170			$Encoding = DsObject::getAttribute($xml, 'Encoding');
171
172			$elements = [];
173			foreach ($xml->childNodes as $elt) {
174			if (!($elt instanceof DOMElement)) {
175			continue;
176			}
177
178			$elements[] = new Chunk($elt);
			0 ignored issues – show Bug introduced 2021-04-18 19:54 UTC by Report Bug Copy Issue Report The type `SimpleSAML\XMLSecurity\XML\ds\Chunk` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
179			}
180
181			return new self($Id, $MimeType, $Encoding, $elements);
182			}
183
184
185			/**
186			* Convert this ds:Object element to XML.
187			*
188			* @param \DOMElement\|null $parent The element we should append this ds:Object element to.
189			* @return \DOMElement
190			*/
191			public function toXML(DOMElement $parent = null): DOMElement
192			{
193			$e = $this->instantiateParentElement($parent);
194			$e->setAttribute('Id', $this->Id);
195			$e->setAttribute('MimeType', $this->MimeType);
196			$e->setAttribute('Encoding', $this->Encoding);
197
198			foreach ($this->elements as $elt) {
199			$elt->toXML($e);
200			}
201
202			return $e;
203			}
204			}
205

simplesamlphp / xml-security

Pull Request — master (#19)

DsObject::getId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like