SAML2\XML\ecp\Response Class Reference

Class representing the ECP Response element. More...

Collaboration diagram for SAML2\XML\ecp\Response:

Public Member Functions
	__construct (DOMElement $xml=null)
	Create a ECP Response element. More...
	toXML (DOMElement $parent)
	Convert this ECP Response to XML. More...

Data Fields
	$AssertionConsumerServiceURL

Detailed Description

Class representing the ECP Response element.

Definition at line 13 of file Response.php.

Constructor & Destructor Documentation

__construct()

SAML2\XML\ecp\Response::__construct

(

DOMElement

$xml = null

)

Create a ECP Response element.

Parameters

DOMElement | null

$xml

The XML element we should load.

Definition at line 27 of file Response.php.

References $xml, and SAML2\Constants\NS_SOAP.

    {
        if ($xml === null) {
            return;
        }

        if (!$xml->hasAttributeNS(Constants::NS_SOAP, 'mustUnderstand')) {
            throw new Exception('Missing SOAP-ENV:mustUnderstand attribute in <ecp:Response>.');
        }
        if ($xml->getAttributeNS(Constants::NS_SOAP, 'mustUnderstand') !== '1') {
            throw new Exception('Invalid value of SOAP-ENV:mustUnderstand attribute in <ecp:Response>.');
        }

        if (!$xml->hasAttributeNS(Constants::NS_SOAP, 'actor')) {
            throw new Exception('Missing SOAP-ENV:actor attribute in <ecp:Response>.');
        }
        if ($xml->getAttributeNS(Constants::NS_SOAP, 'actor') !== 'http://schemas.xmlsoap.org/soap/actor/next') {
            throw new Exception('Invalid value of SOAP-ENV:actor attribute in <ecp:Response>.');
        }

        if (!$xml->hasAttribute('AssertionConsumerServiceURL')) {
            throw new Exception('Missing AssertionConsumerServiceURL attribute in <ecp:Response>.');
        }

        $this->AssertionConsumerServiceURL = $xml->getAttribute('AssertionConsumerServiceURL');
    }

Member Function Documentation

toXML()

SAML2\XML\ecp\Response::toXML

(

DOMElement

$parent

)

Convert this ECP Response to XML.

Parameters

DOMElement

$parent

The element we should append this element to.

Definition at line 58 of file Response.php.

References $response, SAML2\Constants\NS_ECP, and SAML2\Constants\NS_SOAP.

    {
        if (!is_string($this->AssertionConsumerServiceURL)) {
            throw new InvalidArgumentException("AssertionConsumerServiceURL must be a string");
        }

        $doc = $parent->ownerDocument;
        $response = $doc->createElementNS(Constants::NS_ECP, 'ecp:Response');

        $parent->appendChild($response);

        $response->setAttributeNS(Constants::NS_SOAP, 'SOAP-ENV:mustUnderstand', '1');
        $response->setAttributeNS(Constants::NS_SOAP, 'SOAP-ENV:actor', 'http://schemas.xmlsoap.org/soap/actor/next');
        $response->setAttribute('AssertionConsumerServiceURL', $this->AssertionConsumerServiceURL);

        return $response;
    }

Field Documentation

$AssertionConsumerServiceURL

SAML2\XML\ecp\Response::$AssertionConsumerServiceURL

Definition at line 20 of file Response.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/XML/ecp/Response.php