simplesamlphp / saml2

src/XML/saml/Action.php

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\saml;

use DOMElement;
use SimpleSAML\Assert\Assert;
use SimpleSAML\SAML2\Assert\Assert as SAMLAssert;
use SimpleSAML\SAML2\XML\StringElementTrait;
use SimpleSAML\XML\Exception\InvalidDOMElementException;

/**
 * Class representing SAML2 Action
 *
 * @package simplesamlphp/saml2
 */
final class Action extends AbstractSamlElement
{
    use StringElementTrait;

The trait SimpleSAML\SAML2\XML\StringElementTrait requires some properties which are not provided by SimpleSAML\SAML2\XML\saml\Action: $localName, $namespaceURI

    /**
     * Initialize an Action.
     *
     * @param string $namespace  This attribute was marked REQUIRED in the 2012 SAML errata (E36)
     * @param string $content
     */
    public function __construct(
        protected string $namespace,
        string $content,
    ) {
        SAMLAssert::validURI($namespace);

        $this->setContent($content);
    }


    /**
     * Collect the value of the namespace-property
     *
     * @return string
     */
    public function getNamespace(): string
    {
        return $this->namespace;
    }


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

        return new self(
            self::getAttribute($xml, 'Namespace'),
            $xml->textContent,
        );
    }


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

        $e->setAttribute('Namespace', $this->getNamespace());
        $e->textContent = $this->getContent();

        return $e;
    }
}