SimpleSAML\SAML2\XML\saml\Advice

Complexity

Total Complexity

17

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getEncryptedAssertion()	0	3	1
A	isEmptyElement()	0	7	5
A	getAssertionIDRef()	0	3	1
A	toXML()	0	26	6
A	__construct()	0	17	1
A	fromXML()	0	21	1
A	getAssertion()	0	3	1
A	getAssertionURIRef()	0	3	1

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\saml;

use DOMElement;
use SimpleSAML\SAML2\Assert\Assert;
use SimpleSAML\SAML2\Constants as C;
use SimpleSAML\XML\ExtendableElementTrait;
use SimpleSAML\XML\SchemaValidatableElementInterface;
use SimpleSAML\XML\SchemaValidatableElementTrait;
use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
use SimpleSAML\XMLSchema\XML\Constants\NS;

/**
 * Class representing a saml:Advice element.
 *
 * @package simplesaml/saml2
 */
final class Advice extends AbstractSamlElement implements SchemaValidatableElementInterface
{
    use ExtendableElementTrait;
    use SchemaValidatableElementTrait;


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


    /**
     * @param \SimpleSAML\SAML2\XML\saml\AssertionIDRef[] $assertionIDRef
     * @param \SimpleSAML\SAML2\XML\saml\AssertionURIRef[] $assertionURIRef
     * @param \SimpleSAML\SAML2\XML\saml\Assertion[] $assertion
     * @param \SimpleSAML\SAML2\XML\saml\EncryptedAssertion[] $encryptedAssertion
     * @param \SimpleSAML\XML\Chunk[] $elements
     */
    public function __construct(
        protected array $assertionIDRef = [],
        protected array $assertionURIRef = [],
        protected array $assertion = [],
        protected array $encryptedAssertion = [],
        array $elements = [],
    ) {
        Assert::maxCount($assertionIDRef, C::UNBOUNDED_LIMIT);
        Assert::maxCount($assertionURIRef, C::UNBOUNDED_LIMIT);
        Assert::maxCount($assertion, C::UNBOUNDED_LIMIT);
        Assert::maxCount($encryptedAssertion, C::UNBOUNDED_LIMIT);
        Assert::allIsInstanceOf($assertionIDRef, AssertionIDRef::class, SchemaViolationException::class);
        Assert::allIsInstanceOf($assertionURIRef, AssertionURIRef::class, SchemaViolationException::class);
        Assert::allIsInstanceOf($assertion, Assertion::class, SchemaViolationException::class);
        Assert::allIsInstanceOf($encryptedAssertion, EncryptedAssertion::class, SchemaViolationException::class);

        $this->setElements($elements);
    }


    /**
     * 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->assertionIDRef)
            && empty($this->assertionURIRef)
            && empty($this->assertion)
            && empty($this->encryptedAssertion)
            && empty($this->getElements());
    }


    /**
     * @return \SimpleSAML\SAML2\XML\saml\AssertionIDRef[]
     */
    public function getAssertionIDRef(): array
    {
        return $this->assertionIDRef;
    }


    /**
     * @return \SimpleSAML\SAML2\XML\saml\AssertionURIRef[]
     */
    public function getAssertionURIRef(): array
    {
        return $this->assertionURIRef;
    }


    /**
     * @return \SimpleSAML\SAML2\XML\saml\Assertion[]
     */
    public function getAssertion(): array
    {
        return $this->assertion;
    }


    /**
     * @return \SimpleSAML\SAML2\XML\saml\EncryptedAssertion[]
     */
    public function getEncryptedAssertion(): array
    {
        return $this->encryptedAssertion;
    }


    /**
     * Convert XML into an Advice
     *
     * @param \DOMElement $xml The XML element we should load
     * @return static
     *
     * @throws \SimpleSAML\XMLSchema\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(
            $xml->localName,
            $qualifiedName,
            'Unexpected name for endpoint: ' . $xml->localName . '. Expected: ' . $qualifiedName . '.',
            InvalidDOMElementException::class,
        );

        $assertionIDRef = AssertionIDRef::getChildrenOfClass($xml);
        $assertionURIRef = AssertionURIRef::getChildrenOfClass($xml);
        $assertion = Assertion::getChildrenOfClass($xml);
        $encryptedAssertion = EncryptedAssertion::getChildrenOfClass($xml);

        return new static(
            $assertionIDRef,
            $assertionURIRef,
            $assertion,
            $encryptedAssertion,
            self::getChildElementsFromXML($xml),
        );
    }


    /**
     * Convert this Advince to XML.
     *
     * @param \DOMElement $parent The element we are converting to XML.
     * @return \DOMElement The XML element after adding the data corresponding to this Condition.
     */
    public function toXML(?DOMElement $parent = null): DOMElement
    {
        $e = $this->instantiateParentElement($parent);

        foreach ($this->getAssertionIDRef() as $assertionIDRef) {
            $assertionIDRef->toXML($e);
        }

        foreach ($this->getAssertionURIRef() as $assertionURIRef) {
            $assertionURIRef->toXML($e);
        }

        foreach ($this->getAssertion() as $assertion) {
            $assertion->toXML($e);
        }

        foreach ($this->getEncryptedAssertion() as $encryptedAssertion) {
            $encryptedAssertion->toXML($e);
        }

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

        return $e;
    }
}