\OneLogin_Saml2_LogoutResponse

SAML 2 Logout Response

Summary

Methods
Properties
Constants
__construct()
getIssuer()
getStatus()
isValid()
build()
getResponse()
getError()
getId()
getXML()
$id
$document
No constants found
No protected methods found
$_settings
$_logoutResponse
N/A
_query()
$_error
N/A

Properties

$id

$id : string

Contains the ID of the Logout Response

Type

string

$document

$document : \DomDocument

A DOMDocument class loaded from the SAML LogoutResponse.

Type

\DomDocument

$_settings

$_settings : \OneLogin_Saml2_Settings

Object that represents the setting info

Type

\OneLogin_Saml2_Settings

$_logoutResponse

$_logoutResponse : string

The decoded, unprocessed XML response provided to the constructor.

Type

string

$_error

$_error : string|null

After execute a validation process, if it fails, this var contains the cause

Type

string|null

Methods

__construct()

__construct(\OneLogin_Saml2_Settings  $settings, string|null  $response = null) 

Constructs a Logout Response object (Initialize params from settings and if provided load the Logout Response.

Parameters

\OneLogin_Saml2_Settings $settings

Settings.

string|null $response

An UUEncoded SAML Logout response from the IdP.

Throws

\OneLogin_Saml2_Error

getIssuer()

getIssuer() : string|null

Gets the Issuer of the Logout Response.

Returns

string|null —

$issuer The Issuer

getStatus()

getStatus() : string|null

Gets the Status of the Logout Response.

Returns

string|null —

The Status

isValid()

isValid(string|null  $requestId = null, boolean  $retrieveParametersFromServer = false) : boolean

Determines if the SAML LogoutResponse is valid

Parameters

string|null $requestId

The ID of the LogoutRequest sent by this SP to the IdP

boolean $retrieveParametersFromServer

Returns

boolean —

Returns if the SAML LogoutResponse is or not valid

build()

build(string  $inResponseTo) 

Generates a Logout Response object.

Parameters

string $inResponseTo

InResponseTo value for the Logout Response.

getResponse()

getResponse(boolean|null  $deflate = null) : string

Returns a Logout Response object.

Parameters

boolean|null $deflate

Whether or not we should 'gzdeflate' the response body before we return it.

Returns

string —

Logout Response deflated and base64 encoded

getError()

getError() : string

After execute a validation process, if fails this method returns the cause.

Returns

string —

Cause

getId()

getId() : string

Returns

string —

the ID of the Response

getXML()

getXML() : string

Returns the XML that will be sent as part of the response or that was received at the SP

Returns

string

_query()

_query(string  $query) : \DOMNodeList

Extracts a node from the DOMDocument (Logout Response Menssage)

Parameters

string $query

Xpath Expresion

Returns

\DOMNodeList —

The queried node