ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
SAML2\Response Class Reference
+ Inheritance diagram for SAML2\Response:
+ Collaboration diagram for SAML2\Response:

Public Member Functions

 __construct (\DOMElement $xml=null)
 Constructor for SAML 2 response messages. More...
 
 getAssertions ()
 Retrieve the assertions in this response. More...
 
 setAssertions (array $assertions)
 Set the assertions that should be included in this response. 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

 $assertions
 The assertions in this response. More...
 

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 10 of file Response.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor for SAML 2 response messages.

Parameters
\DOMElement | null$xmlThe input message.

Definition at line 22 of file Response.php.

References $xml.

23  {
24  parent::__construct('Response', $xml);
25 
26  $this->assertions = array();
27 
28  if ($xml === null) {
29  return;
30  }
31 
32  for ($node = $xml->firstChild; $node !== null; $node = $node->nextSibling) {
33  if ($node->namespaceURI !== Constants::NS_SAML) {
34  continue;
35  }
36 
37  if ($node->localName === 'Assertion') {
38  $this->assertions[] = new Assertion($node);
39  } elseif ($node->localName === 'EncryptedAssertion') {
40  $this->assertions[] = new EncryptedAssertion($node);
41  }
42  }
43  }
const NS_SAML
The namespace for the SAML 2 assertions.
Definition: Constants.php:225

Member Function Documentation

◆ getAssertions()

SAML2\Response::getAssertions ( )

Retrieve the assertions in this response.

Returns
[]|[]

Definition at line 50 of file Response.php.

Referenced by SAML2\Response\Processor\processAssertions().

51  {
52  return $this->assertions;
53  }
$assertions
The assertions in this response.
Definition: Response.php:15
+ Here is the caller graph for this function:

◆ setAssertions()

SAML2\Response::setAssertions ( array  $assertions)

Set the assertions that should be included in this response.

Parameters

Definition at line 60 of file Response.php.

References $root.

61  {
62  $this->assertions = $assertions;
63  }
$assertions
The assertions in this response.
Definition: Response.php:15

Field Documentation

◆ $assertions

SAML2\Response::$assertions
private

The assertions in this response.

Definition at line 15 of file Response.php.

Referenced by SAML2\Response\Processor\processAssertions().


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