SimpleSAML\WSSecurity\XML\sp_200702\AbstractRequestSecurityTokenTemplateType

Complexity

Total Complexity

10

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	isEmptyElement()	0	3	3
A	fromXML()	0	18	1
A	getTrustVersion()	0	3	1
A	toXML()	0	17	4
A	__construct()	0	9	1

<?php

declare(strict_types=1);

namespace SimpleSAML\WSSecurity\XML\sp_200702;

use DOMElement;
use SimpleSAML\WSSecurity\Assert\Assert;
use SimpleSAML\XML\Exception\InvalidDOMElementException;
use SimpleSAML\XML\ExtendableAttributesTrait;
use SimpleSAML\XML\ExtendableElementTrait;
use SimpleSAML\XML\XsNamespace as NS;

use function sprintf;

/**
 * Class representing WS security policy RequestSecurityTokenTemplateType.
 *
 * @package simplesamlphp/ws-security
 */
abstract class AbstractRequestSecurityTokenTemplateType extends AbstractSpElement
{
    use ExtendableAttributesTrait;
    use ExtendableElementTrait;

The trait SimpleSAML\XML\ExtendableElementTrait requires some properties which are not provided by SimpleSAML\WSSecurity\XML\sp_200702\AbstractRequestSecurityTokenTemplateType: $namespaceURI, $localName, $childNodes

    /** The namespace-attribute for the xs:any element */
    public const XS_ANY_ELT_NAMESPACE = NS::OTHER;

    /** The namespace-attribute for the xs:anyAttribute element */
    public const XS_ANY_ATTR_NAMESPACE = NS::ANY;

    /** The exclusions for the xs:anyAttribute element */
    public const XS_ANY_ATTR_EXCLUSIONS = [
        [null, 'TrustVersion'],
    ];


    /**
     * AbstractRequestSecurityTokenTemplateType constructor.
     *
     * @param string|null $trustVersion
     * @param array<\SimpleSAML\XML\SerializableElementInterface> $elts
     * @param array<\SimpleSAML\XML\Attribute> $namespacedAttributes
     */
    final public function __construct(
        protected ?string $trustVersion = null,
        array $elts = [],
        array $namespacedAttributes = [],
    ) {
        Assert::nullOrValidURI($trustVersion);

The method nullOrValidURI() does not exist on SimpleSAML\WSSecurity\Assert\Assert. Since you implemented __callStatic, consider adding a @method annotation.

        $this->setElements($elts);
        $this->setAttributesNS($namespacedAttributes);
    }


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


    /**
     * 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->trustVersion) && empty($this->elements) && empty($this->namespacedAttributes);
    }


    /**
     * Initialize an RequestSecurityTokenTemplateType.
     *
     * Note: this method cannot be used when extending this class, if the constructor has a different signature.
     *
     * @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
    {
        $qualifiedName = static::getClassName(static::class);
        Assert::eq(

The method eq() does not exist on SimpleSAML\WSSecurity\Assert\Assert. Since you implemented __callStatic, consider adding a @method annotation.

            $xml->localName,
            $qualifiedName,
            sprintf(
                'Unexpected name for RequestSecurityTokenTemplateType: %s. Expected: %s.',
                $xml->localName,
                $qualifiedName,
            ),
            InvalidDOMElementException::class,
        );

        return new static(
            self::getOptionalAttribute($xml, 'TrustVersion', null),
            self::getChildElementsFromXML($xml),
            self::getAttributesNSFromXML($xml),
        );
    }


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

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

        foreach ($this->getElements() as $elt) {
            $elt->toXML($e);
        }

        foreach ($this->getAttributesNS() as $attr) {
            $attr->toXML($e);
        }

        return $e;
    }
}