Inheritance diagram for SAML2\ArtifactResponse:

Collaboration diagram for SAML2\ArtifactResponse:

Public Member Functions
	__construct (\DOMElement $xml=null)

	setAny (\DOMElement $any=null)

	getAny ()

	toUnsignedXML ()
	Convert the response message to an XML element. More...

Public Member Functions inherited from SAML2\StatusResponse
	isSuccess ()
	Determine whether this is a successful response. More...

	getInResponseTo ()
	Retrieve the ID of the request this is a response to. More...

	setInResponseTo ($inResponseTo)
	Set the ID of the request this is a response to. More...

	getStatus ()
	Retrieve the status code. More...

	setStatus (array $status)
	Set the status code. More...

	toUnsignedXML ()
	Convert status response message to an XML element. More...

Public Member Functions inherited from SAML2\Message
	addValidator ($function, $data)
	Add a method for validating this message. More...

	validate (XMLSecurityKey $key)
	Validate this message against a public key. More...

	getId ()
	Retrieve the identifier of this message. More...

	setId ($id)
	Set the identifier of this message. More...

	getIssueInstant ()
	Retrieve the issue timestamp of this message. More...

	setIssueInstant ($issueInstant)
	Set the issue timestamp of this message. More...

	getDestination ()
	Retrieve the destination of this message. More...

	setDestination ($destination)
	Set the destination of this message. More...

	setConsent ($consent)
	Set the given consent for this message. More...

	getConsent ()
	Set the given consent for this message. More...

	getIssuer ()
	Retrieve the issuer if this message. More...

	setIssuer ($issuer)
	Set the issuer of this message. More...

	isMessageConstructedWithSignature ()
	Query whether or not the message contained a signature at the root level when the object was constructed. More...

	getRelayState ()
	Retrieve the RelayState associated with this message. More...

	setRelayState ($relayState)
	Set the RelayState associated with this message. More...

	toUnsignedXML ()
	Convert this message to an unsigned XML document. More...

	toSignedXML ()
	Convert this message to a signed XML document. More...

	getSignatureKey ()
	Retrieve the private key we should use to sign the message. More...

	setSignatureKey (XMLSecurityKey $signatureKey=null)
	Set the private key we should use to sign the message. More...

	setCertificates (array $certificates)
	Set the certificates that should be included in the message. More...

	getCertificates ()
	Retrieve the certificates that are included in the message. More...

	getExtensions ()
	Retrieve the Extensions. More...

	setExtensions ($extensions)
	Set the Extensions. More...

	getSignatureMethod ()

Private Attributes
	$any

Additional Inherited Members
Static Public Member Functions inherited from SAML2\Message
static	fromXML (\DOMElement $xml)
	Convert an XML element into a message. More...

Protected Member Functions inherited from SAML2\StatusResponse
	__construct ($tagName, \DOMElement $xml=null)
	Constructor for SAML 2 response messages. More...

Protected Member Functions inherited from SAML2\Message
	__construct ($tagName, \DOMElement $xml=null)
	Initialize a message. More...

Protected Attributes inherited from SAML2\Message
	$extensions

	$document

	$messageContainedSignatureUponConstruction = false

Detailed Description

Definition at line 11 of file ArtifactResponse.php.

Constructor & Destructor Documentation

◆ __construct()

SAML2\ArtifactResponse::__construct ( \DOMElement $xml = null )

Definition at line 22 of file ArtifactResponse.php.

References $xml.

     {
         parent::__construct('ArtifactResponse', $xml);
 
         if (!is_null($xml)) {
             $status = Utils::xpQuery($xml, './saml_protocol:Status');
             assert(!empty($status)); /* Will have failed during StatusResponse parsing. */
 
             $status = $status[0];
 
             for ($any = $status->nextSibling; $any !== null; $any = $any->nextSibling) {
                 if ($any instanceof \DOMElement) {
                     $this->any = $any;
                     break;
                 }
                 /* Ignore comments and text nodes. */
             }
         }
     }

Member Function Documentation

◆ getAny()

SAML2\ArtifactResponse::getAny ( )

Definition at line 47 of file ArtifactResponse.php.

     {
         return $this->any;
     }

◆ setAny()

SAML2\ArtifactResponse::setAny ( \DOMElement $any = null )

Definition at line 42 of file ArtifactResponse.php.

     {
         $this->any = $any;
     }

◆ toUnsignedXML()

SAML2\ArtifactResponse::toUnsignedXML ( )

Convert the response message to an XML element.

Returns: This response.

Definition at line 57 of file ArtifactResponse.php.

     {
         $root = parent::toUnsignedXML();
         if (isset($this->any)) {
             $node = $root->ownerDocument->importNode($this->any, true);
             $root->appendChild($node);
         }
 
         return $root;
     }

Field Documentation

◆ $any

SAML2\ArtifactResponse::$any

private

Definition at line 19 of file ArtifactResponse.php.

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

libs/composer/vendor/simplesamlphp/saml2/src/SAML2/ArtifactResponse.php

Public Member Functions

Private Attributes

Additional Inherited Members