SimpleSAML\WSSecurity\XML\auth\AbstractConstrainedValueType

Complexity

Total Complexity

9

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	fromXML()	0	27	1
A	getAssertConstraint()	0	3	1
A	getValue()	0	3	1
A	__construct()	0	6	1
A	toXML()	0	18	5

<?php

declare(strict_types=1);

namespace SimpleSAML\WSSecurity\XML\auth;

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

use function array_filter;
use function array_merge;
use function array_pop;

/**
 * Class defining the ConstrainedValueType element
 *
 * @package simplesamlphp/ws-security
 */
abstract class AbstractConstrainedValueType extends AbstractAuthElement
{
    use ExtendableElementTrait;

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

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


    /**
     * AbstractConstrainedValueType constructor
     *
     * @param (
     *   \SimpleSAML\WSSecurity\XML\auth\ValueLessThan|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueLessThanOrEqual|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueGreaterThan|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueGreaterThanOrEqual|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueInRangen|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueOneOf
     * ) $value
     * @param \SimpleSAML\XML\SerializableElementInterface[] $children
     * @param bool|null $assertConstraint
     */
    final public function __construct(
        protected ValueLessThan|ValueLessThanOrEqual|ValueGreaterThan|ValueGreaterThanOrEqual|ValueInRangen|ValueOneOf $value,
        array $children = [],
        protected ?bool $assertConstraint = null,
    ) {
        $this->setElements($children);
    }


    /**
     * Get the value of the $value property.
     *
     * @return (

The doc comment ( at position 1 could not be parsed: the token is null at position 1.

     *   \SimpleSAML\WSSecurity\XML\auth\ValueLessThan|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueLessThanOrEqual|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueGreaterThan|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueGreaterThanOrEqual|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueInRangen|
     *   \SimpleSAML\WSSecurity\XML\auth\ValueOneOf
     * )
     */
    public function getValue(): ValueLessThan|ValueLessThanOrEqual|ValueGreaterThan|ValueGreaterThanOrEqual|ValueInRangen|ValueOneOf
    {
        return $this->value;
    }


    /**
     * Get the value of the assertConstraint property.
     *
     * @return bool|null
     */
    public function getAssertConstraint(): ?bool
    {
        return $this->assertConstraint;
    }


    /**
     * Create an instance of this object from its XML representation.
     *
     * @param \DOMElement $xml
     * @return static
     *
     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
     *   if the qualified name of the supplied element is wrong
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, static::getLocalName(), InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, static::NS, InvalidDOMElementException::class);

        $valueLessThan = ValueLessThan::getChildrenOfClass($xml);
        $valueLessThanOrEqual = ValueLessThanOrEqual::getChildrenOfClass($xml);
        $valueGreaterThan = ValueGreaterThan::getChildrenOfClass($xml);
        $valueGreaterThanOrEqual = ValueGreaterThanOrEqual::getChildrenOfClass($xml);
        $valueInRangen = ValueInRangen::getChildrenOfClass($xml);
        $valueOneOf = ValueOneOf::getChildrenOfClass($xml);

        $value = array_filter(array_merge(
            $valueLessThan,
            $valueLessThanOrEqual,
            $valueGreaterThan,
            $valueGreaterThanOrEqual,
            $valueInRangen,
            $valueOneOf,
        ));
        Assert::minCount($value, 1, MissingElementException::class);
        Assert::maxCount($value, 1, TooManyElementsException::class);

        return new static(
            array_pop($value),
            self::getChildElementsFromXML($xml),
            self::getOptionalBooleanAttribute($xml, 'AssertConstraint', null),
        );
    }


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

        if ($this->getAssertConstraint() !== null) {
            $e->setAttribute('AssertConstraint', $this->getAssertConstraint() ? 'true' : 'false');
        }

        $this->getValue()->toXML($e);

        /** @psalm-var \SimpleSAML\XML\SerializableElementInterface $child */
        foreach ($this->getElements() as $child) {
            if (!$child->isEmptyElement()) {
                $child->toXML($e);
            }
        }

        return $e;
    }
}