UnknownRoleDescriptor::toUnsignedXML() - Code Metrics - Inspection of "Rewrite signed elements" - simplesamlphp/saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#280)

by Tim

created 2022-02-16 17:32 UTC

UnknownRoleDescriptor::toUnsignedXML() A

↳ Parent: UnknownRoleDescriptor

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\md;

use DOMElement;
use SimpleSAML\Assert\Assert;
use SimpleSAML\XML\AbstractXMLElement;
use SimpleSAML\XML\Chunk;
use SimpleSAML\XML\Exception\InvalidDOMElementException;
use SimpleSAML\XML\Exception\TooManyElementsException;
use SimpleSAML\XML\Utils as XMLUtils;

use function preg_split;

/**
 * Class representing unknown RoleDescriptors.
 *
 * @package simplesamlphp/saml2
 */
final class UnknownRoleDescriptor extends AbstractRoleDescriptor
{
    /**
     * This RoleDescriptor as XML
     *
     * @var \SimpleSAML\XML\Chunk
     * @psalm-suppress PropertyNotSetInConstructor
     */
    protected Chunk $elt;


    /**
     * Initialize an unknown RoleDescriptor.
     *
     * @param \DOMElement $xml The XML element we should load.
     * @return \SimpleSAML\SAML2\XML\md\UnknownRoleDescriptor
     *
     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException if the qualified name of the supplied element is wrong
     * @throws \SimpleSAML\XML\Exception\MissingAttributeException if the supplied element is missing one of the mandatory attributes
     * @throws \SimpleSAML\XML\Exception\TooManyElementsException if too many child-elements of a type are specified
     */
    public static function fromXML(DOMElement $xml): object
    {
        $protocols = self::getAttribute($xml, 'protocolSupportEnumeration');

        $validUntil = self::getAttribute($xml, 'validUntil', null);
        $orgs = Organization::getChildrenOfClass($xml);
        Assert::maxCount($orgs, 1, 'More than one Organization found in this descriptor', TooManyElementsException::class);

        $extensions = Extensions::getChildrenOfClass($xml);
        Assert::maxCount($extensions, 1, 'Only one md:Extensions element is allowed.', TooManyElementsException::class);

        $object = new self(
            preg_split('/[\s]+/', trim($protocols)),
            self::getAttribute($xml, 'ID', null),
            $validUntil !== null ? XMLUtils::xsDateTimeToTimestamp($validUntil) : null,
            self::getAttribute($xml, 'cacheDuration', null),
            !empty($extensions) ? $extensions[0] : null,
            self::getAttribute($xml, 'errorURL', null),
            KeyDescriptor::getChildrenOfClass($xml),
            !empty($orgs) ? $orgs[0] : null,
            ContactPerson::getChildrenOfClass($xml)
        );

        $object->elt = new Chunk($xml);
        $object->setXML($xml);

        return $object;
    }


    /**
     * Get the original XML of this descriptor as a Chunk object.
     *
     * @return \SimpleSAML\XML\Chunk
     */
    public function getXML(): Chunk
    {
        return $this->elt;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }


    /**
     * Convert this descriptor to an unsigned XML document.
     * This method does not sign the resulting XML document.
     *
     * @param \DOMElement|null $parent
     * @return \DOMElement The root element of the DOM tree
     */
    protected function toUnsignedXML(DOMElement $parent = null): DOMElement
    {
        return $this->elt->toXML($parent);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\SAML2\XML\md;
6
7			use DOMElement;
8			use SimpleSAML\Assert\Assert;
9			use SimpleSAML\XML\AbstractXMLElement;
10			use SimpleSAML\XML\Chunk;
11			use SimpleSAML\XML\Exception\InvalidDOMElementException;
12			use SimpleSAML\XML\Exception\TooManyElementsException;
13			use SimpleSAML\XML\Utils as XMLUtils;
14
15			use function preg_split;
16
17			/**
18			* Class representing unknown RoleDescriptors.
19			*
20			* @package simplesamlphp/saml2
21			*/
22			final class UnknownRoleDescriptor extends AbstractRoleDescriptor
23			{
24			/**
25			* This RoleDescriptor as XML
26			*
27			* @var \SimpleSAML\XML\Chunk
28			* @psalm-suppress PropertyNotSetInConstructor
29			*/
30			protected Chunk $elt;
31
32
33			/**
34			* Initialize an unknown RoleDescriptor.
35			*
36			* @param \DOMElement $xml The XML element we should load.
37			* @return \SimpleSAML\SAML2\XML\md\UnknownRoleDescriptor
38			*
39			* @throws \SimpleSAML\XML\Exception\InvalidDOMElementException if the qualified name of the supplied element is wrong
40			* @throws \SimpleSAML\XML\Exception\MissingAttributeException if the supplied element is missing one of the mandatory attributes
41			* @throws \SimpleSAML\XML\Exception\TooManyElementsException if too many child-elements of a type are specified
42			*/
43			public static function fromXML(DOMElement $xml): object
44			{
45			$protocols = self::getAttribute($xml, 'protocolSupportEnumeration');
46
47			$validUntil = self::getAttribute($xml, 'validUntil', null);
48			$orgs = Organization::getChildrenOfClass($xml);
49			Assert::maxCount($orgs, 1, 'More than one Organization found in this descriptor', TooManyElementsException::class);
50
51			$extensions = Extensions::getChildrenOfClass($xml);
52			Assert::maxCount($extensions, 1, 'Only one md:Extensions element is allowed.', TooManyElementsException::class);
53
54			$object = new self(
55			preg_split('/[\s]+/', trim($protocols)),
56			self::getAttribute($xml, 'ID', null),
57			$validUntil !== null ? XMLUtils::xsDateTimeToTimestamp($validUntil) : null,
58			self::getAttribute($xml, 'cacheDuration', null),
59			!empty($extensions) ? $extensions[0] : null,
60			self::getAttribute($xml, 'errorURL', null),
61			KeyDescriptor::getChildrenOfClass($xml),
62			!empty($orgs) ? $orgs[0] : null,
63			ContactPerson::getChildrenOfClass($xml)
64			);
65
66			$object->elt = new Chunk($xml);
67			$object->setXML($xml);
68
69			return $object;
70			}
71
72
73			/**
74			* Get the original XML of this descriptor as a Chunk object.
75			*
76			* @return \SimpleSAML\XML\Chunk
77			*/
78			public function getXML(): Chunk
79			{
80			return $this->elt;
			0 ignored issues – show Bug Best Practice introduced 2022-02-16 17:34 UTC by Report Bug Copy Issue Report The expression `return $this->elt` returns the type `SimpleSAML\XML\Chunk` which is incompatible with the return type mandated by `SimpleSAML\SAML2\XML\md\...adataDocument::getXML()` of `DOMElement`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
81			}
82
83
84			/**
85			* Convert this descriptor to an unsigned XML document.
86			* This method does not sign the resulting XML document.
87			*
88			* @param \DOMElement\|null $parent
89			* @return \DOMElement The root element of the DOM tree
90			*/
91			protected function toUnsignedXML(DOMElement $parent = null): DOMElement
92			{
93			return $this->elt->toXML($parent);
94			}
95			}
96

simplesamlphp / saml2

Pull Request — master (#280)

UnknownRoleDescriptor::toUnsignedXML() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like