Inheritance diagram for SAML2\ArtifactResolve:

Collaboration diagram for SAML2\ArtifactResolve:

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

	getArtifact ()
	Retrieve the Artifact in this response. More...

	setArtifact ($artifact)
	Set the artifact that should be included in this response. More...

	toUnsignedXML ()
	Convert the 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
	$artifact

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\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 13 of file ArtifactResolve.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 17 of file ArtifactResolve.php.

References $results, and $xml.

     {
         parent::__construct('ArtifactResolve', $xml);
 
         if (!is_null($xml)) {
             $results = Utils::xpQuery($xml, './saml_protocol:Artifact');
             $this->artifact = $results[0]->textContent;
         }
     }

Member Function Documentation

◆ getArtifact()

SAML2\ArtifactResolve::getArtifact ( )

Retrieve the Artifact in this response.

Returns: string artifact.

Definition at line 32 of file ArtifactResolve.php.

References $artifact.

     {
         return $this->artifact;
     }

◆ setArtifact()

SAML2\ArtifactResolve::setArtifact ( $artifact )

Set the artifact that should be included in this response.

Parameters

string $artifact

Definition at line 42 of file ArtifactResolve.php.

References $artifact.

     {
         assert(is_string($artifact));
         $this->artifact = $artifact;
     }

◆ toUnsignedXML()

SAML2\ArtifactResolve::toUnsignedXML ( )

Convert the response message to an XML element.

Returns: This response.

Definition at line 53 of file ArtifactResolve.php.

References $root.

     {
         $root = parent::toUnsignedXML();
         $artifactelement = $this->document->createElementNS(Constants::NS_SAMLP, 'Artifact', $this->artifact);
         $root->appendChild($artifactelement);
 
         return $root;
     }

Field Documentation

◆ $artifact

SAML2\ArtifactResolve::$artifact

private

Definition at line 15 of file ArtifactResolve.php.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members