SimpleSAML\WSSecurity\XML\auth\AbstractEncryptedValueType

Complexity

Total Complexity

5

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescriptionCondition()	0	3	1
A	fromXML()	0	12	1
A	__construct()	0	5	1
A	getEncryptedData()	0	3	1
A	toXML()	0	8	1

<?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\SchemaViolationException;
use SimpleSAML\XML\Exception\TooManyElementsException;
use SimpleSAML\XMLSecurity\XML\xenc\EncryptedData;

use function array_pop;

/**
 * Class representing WS-authorization EncryptedValueType.
 *
 * @package simplesamlphp/ws-security
 */
abstract class AbstractEncryptedValueType extends AbstractAuthElement
{
    /**
     * AbstractEncryptedValueType constructor.
     *
     * @param \SimpleSAML\XMLSecurity\XML\xenc\EncryptedData $encryptedData
     * @param string|null $descriptionCondition
     */
    final public function __construct(
        protected EncryptedData $encryptedData,
        protected ?string $descriptionCondition = null,
    ) {
        Assert::nullOrValidURI($descriptionCondition, SchemaViolationException::class);
    }


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


    /**
     * Get the value of the $encryptedData property.
     *
     * @return \SimpleSAML\XMLSecurity\XML\xenc\EncryptedData
     */
    public function getEncryptedData(): EncryptedData
    {
        return $this->encryptedData;
    }


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

        $encryptedData = EncryptedData::getChildrenOfClass($xml);
        Assert::minCount($encryptedData, 1, MissingElementException::class);
        Assert::maxCount($encryptedData, 1, TooManyElementsException::class);

        return new static(
            array_pop($encryptedData),
            self::getOptionalAttribute($xml, 'DescriptionCondition', null),
        );
    }


    /**
     * 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);
        $e->setAttribute('DescriptionCondition', $this->getDescriptionCondition());

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

        return $e;
    }
}