SignedInfo::getId() - Code Metrics - Inspection of "Add implementation for ds:SignedInfo (#16)" - simplesamlphp/xml-security - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b5ce29...17ebf5 )

by Tim

created 2021-04-18 15:15 UTC

SignedInfo::getId() A

↳ Parent: SignedInfo

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
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\Chunk;

/**
 * Class representing a ds:SignedInfo element.
 *
 * @package simplesamlphp/xml-security
 */
final class SignedInfo extends AbstractDsElement
{
    /** @var string */
    protected string $Id;

    /**
     * @var \SimpleSAML\XMLSecurity\XML\ds\CanonicalizationMethod
     */
    protected CanonicalizationMethod $canonicalizationMethod;

    /**
     * @var \SimpleSAML\XMLSecurity\XML\ds\SignatureMethod
     */
    protected SignatureMethod $signatureMethod;

    /**
     * @var \SimpleSAML\XMLSecurity\XML\ds\Reference[]
     */
    protected array $references;


    /**
     * Initialize a SignedIfno.
     *
     * @param \SimpleSAML\XMLSecurity\XML\ds\CanonicalizationMethod $canonicalizationMethod
     * @param \SimpleSAML\XMLSecurity\XML\ds\SignatureMethod $signatureMethod
     * @param \SimpleSAML\XMLSecurity\XML\ds\Reference[] $references
     * @param string|null $Id
     */
    public function __construct(
        CanonicalizationMethod $canonicalizationMethod,
        SignatureMethod $signatureMethod,
        array $references,
        ?string $Id = null
    ) {
        $this->setCanonicalizationMethod($canonicalizationMethod);
        $this->setSignatureMethod($signatureMethod);
        $this->setReferences($references);
        $this->setId($Id);
    }


    /**
     * Collect the value of the canonicalizationMethod-property
     *
     * @return \SimpleSAML\XMLSecurity\XML\ds\CanonicalizationMethod
     */
    public function getCanonicalizationMethod(): CanonicalizationMethod
    {
        return $this->canonicalizationMethod;
    }


    /**
     * Set the value of the canonicalizationMethod-property
     *
     * @param \SimpleSAML\XMLSecurity\XML\ds\CanonicalizationMethod $canonicalizationMethod
     */
    private function setCanonicalizationMethod(CanonicalizationMethod $canonicalizationMethod): void
    {
        $this->canonicalizationMethod = $canonicalizationMethod;
    }


    /**
     * Collect the value of the signatureMethod-property
     *
     * @return \SimpleSAML\XMLSecurity\XML\ds\SignatureMethod
     */
    public function getSignatureMethod(): SignatureMethod
    {
        return $this->signatureMethod;
    }


    /**
     * Set the value of the signatureMethod-property
     *
     * @param \SimpleSAML\XMLSecurity\XML\ds\SignatureMethod $signatureMethod
     */
    private function setSignatureMethod(SignatureMethod $signatureMethod): void
    {
        $this->signatureMethod = $signatureMethod;
    }


    /**
     * Collect the value of the references-property
     *
     * @return \SimpleSAML\XMLSecurity\XML\ds\Reference[]
     */
    public function getReferences(): array
    {
        return $this->references;
    }


    /**
     * Set the value of the references-property
     *
     * @param \SimpleSAML\XMLSecurity\XML\ds\Reference[] $references
     */
    private function setReferences(array $references): void
    {
        Assert::allIsInstanceOf($references, Reference::class);

        $this->references = $references;
    }


    /**
     * 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|null $Id
     */
    private function setId(?string $Id): void
    {
        $this->Id = $Id;
    }


    /**
     * Convert XML into a SignedInfo instance
     *
     * @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, 'SignedInfo', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, SignedInfo::NS, InvalidDOMElementException::class);

        $Id = self::getAttribute($xml, 'Id', null);

        $canonicalizationMethod = CanonicalizationMethod::getChildrenOfClass($xml);
        Assert::count($canonicalizationMethod, 1, 'A ds:SignedInfo element must contain exactly one ds:CanonicalizationMethod');

        $signatureMethod = SignatureMethod::getChildrenOfClass($xml);
        Assert::count($signatureMethod, 1, 'A ds:SignedInfo element must contain exactly one ds:SignatureMethod');

        $references = Reference::getChildrenOfClass($xml);
        Assert::minCount($references, 1, 'A ds:SignedInfo element must contain at least one ds:Reference');

        return new self(
            array_pop($canonicalizationMethod),
            array_pop($signatureMethod),
            $references,
            $Id
        );
    }


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

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

        $this->canonicalizationMethod->toXML($e);
        $this->signatureMethod->toXML($e);

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

simplesamlphp / xml-security

Push — master ( b5ce29...17ebf5 )

SignedInfo::getId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like