simplesamlphp / xml-soap

src/SOAP11/XML/Fault.php

<?php

declare(strict_types=1);

namespace SimpleSAML\SOAP11\XML;

use DOMElement;
use SimpleSAML\SOAP11\Assert\Assert;
use SimpleSAML\XML\SchemaValidatableElementInterface;
use SimpleSAML\XML\SchemaValidatableElementTrait;
use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
use SimpleSAML\XMLSchema\Exception\MissingElementException;
use SimpleSAML\XMLSchema\Exception\TooManyElementsException;

/**
 * Class representing a SOAP-ENV:Fault element.
 *
 * @package simplesaml/xml-soap
 */
final class Fault extends AbstractSoapElement implements SchemaValidatableElementInterface

The type SimpleSAML\SOAP11\XML\AbstractSoapElement was not found. Maybe you did not declare it correctly or list all dependencies?

{
    use SchemaValidatableElementTrait;


    /**
     * Initialize a SOAP-ENV:Fault
     *
     * @param \SimpleSAML\SOAP11\XML\FaultCode $faultCode
     * @param \SimpleSAML\SOAP11\XML\FaultString $faultString
     * @param \SimpleSAML\SOAP11\XML\FaultActor|null $faultActor
     * @param \SimpleSAML\SOAP11\XML\Detail|null $detail
     */
    public function __construct(
        protected FaultCode $faultCode,

The type SimpleSAML\SOAP11\XML\FaultCode was not found. Maybe you did not declare it correctly or list all dependencies?

        protected FaultString $faultString,

The type SimpleSAML\SOAP11\XML\FaultString was not found. Maybe you did not declare it correctly or list all dependencies?

        protected ?FaultActor $faultActor = null,

The type SimpleSAML\SOAP11\XML\FaultActor was not found. Maybe you did not declare it correctly or list all dependencies?

        protected ?Detail $detail = null,

The type SimpleSAML\SOAP11\XML\Detail was not found. Maybe you did not declare it correctly or list all dependencies?

    ) {
    }


    /**
     * @return \SimpleSAML\SOAP11\XML\FaultCode
     */
    public function getFaultCode(): FaultCode
    {
        return $this->faultCode;
    }


    /**
     * @return \SimpleSAML\SOAP11\XML\FaultString
     */
    public function getFaultString(): FaultString
    {
        return $this->faultString;
    }


    /**
     * @return \SimpleSAML\SOAP11\XML\FaultActor|null
     */
    public function getFaultActor(): ?FaultActor
    {
        return $this->faultActor;
    }


    /**
     * @return \SimpleSAML\SOAP11\XML\Detail|null
     */
    public function getDetail(): ?Detail
    {
        return $this->detail;
    }


    /**
     * Convert XML into an Fault element
     *
     * @param \DOMElement $xml The XML element we should load
     *
     * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
     *   If the qualified name of the supplied element is wrong
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, 'Fault', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, Fault::NS, InvalidDOMElementException::class);

        $faultCode = FaultCode::getChildrenOfClass($xml);
        Assert::count($faultCode, 1, 'Must contain exactly one faultcode', MissingElementException::class);

        $faultString = FaultString::getChildrenOfClass($xml);
        Assert::count($faultString, 1, 'Must contain exactly one faultstring', MissingElementException::class);

        $faultActor = FaultActor::getChildrenOfClass($xml);
        Assert::maxCount(
            $faultActor,
            1,
            'Cannot process more than one faultactor element.',
            TooManyElementsException::class,
        );

        $detail = Detail::getChildrenOfClass($xml);
        Assert::maxCount($detail, 1, 'Cannot process more than one detail element.', TooManyElementsException::class);

        return new self(
            array_pop($faultCode),
            array_pop($faultString),
            array_pop($faultActor),
            array_pop($detail),
        );
    }


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

        $this->getFaultCode()->toXML($e);
        $this->getFaultString()->toXML($e);
        $this->getFaultActor()?->toXML($e);

        if ($this->getDetail() !== null && !$this->getDetail()->isEmptyElement()) {
            $this->getDetail()->toXML($e);
        }

        return $e;
    }
}