SimpleSAML\CAS\XML\ProxySuccess

Complexity

Total Complexity

4

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	toXML()	0	7	1
A	getProxyTicket()	0	3	1
A	__construct()	0	3	1
A	fromXML()	0	14	1

<?php

declare(strict_types=1);

namespace SimpleSAML\CAS\XML;

use DOMElement;
use SimpleSAML\CAS\Assert\Assert;
use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
use SimpleSAML\XMLSchema\Exception\MissingElementException;

/**
 * Class for CAS proxySuccess
 *
 * @package simplesamlphp/cas
 */
final class ProxySuccess extends AbstractResponse
{
    /** @var string */
    final public const LOCALNAME = 'proxySuccess';


    /**
     * Initialize a cas:proxySuccess element
     *
     * @param \SimpleSAML\CAS\XML\ProxyTicket $proxyTicket
     */
    final public function __construct(
        protected ProxyTicket $proxyTicket,
    ) {
    }


    /**
     * @return \SimpleSAML\CAS\XML\ProxyTicket
     */
    public function getProxyTicket(): ProxyTicket
    {
        return $this->proxyTicket;
    }


    /**
     * Initialize an ProxySuccess element.
     *
     * @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
     * @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException
     *   if the supplied element is missing any of the mandatory attributes
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, static::getLocalName(), InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, static::getNamespaceURI(), InvalidDOMElementException::class);

        $proxyTicket = ProxyTicket::getChildrenOfClass($xml);
        Assert::count(
            $proxyTicket,
            1,
            'Exactly one <cas:proxyTicket> must be specified.',
            MissingElementException::class,
        );

        return new static($proxyTicket[0]);
    }


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

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

        return $e;
    }
}