DsObject::getEncoding() - 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-07-18 19:01 UTC

DsObject::getEncoding() 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\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';

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

simplesamlphp / xml-security

Pull Request — master (#19)

DsObject::getEncoding() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like