PHP Класс OneLogin_Saml2_LogoutResponse

Открытые свойства

Свойство	Тип	Описание
$document	DomDocument	A DOMDocument class loaded from the SAML LogoutResponse.

Свойство	Тип	Описание
$_logoutResponse	string	The decoded, unprocessed XML response provided to the constructor.
$_settings	OneLogin_Saml2_Settings	Object that represents the setting info

Метод	Описание
__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.
build ( string $inResponseTo )	Generates a Logout Response object.
getError ( )	* After execute a validation process, if fails this method returns the cause.
getIssuer ( ) : string \| null	Gets the Issuer of the Logout Response.
getResponse ( boolean \| null $deflate = null ) : string	Returns a Logout Response object.
getStatus ( ) : string	Gets the Status of the Logout Response.
isValid ( string \| null $requestId = null, boolean $retrieveParametersFromServer = false ) : boolean	Determines if the SAML LogoutResponse is valid

Метод	Описание
_query ( string $query ) : DOMNodeList	Extracts a node from the DOMDocument (Logout Response Menssage)

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

public __construct ( OneLogin_Saml2_Settings $settings, string \| null $response = null )
$settings	OneLogin_Saml2_Settings	Settings.
$response	string \| null	An UUEncoded SAML Logout response from the IdP.

Generates a Logout Response object.

public build ( string $inResponseTo )
$inResponseTo	string	InResponseTo value for the Logout Response.

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

public getError ( )

Gets the Issuer of the Logout Response.

public getIssuer ( ) : string \| null
Результат	string \| null	$issuer The Issuer

Returns a Logout Response object.

public getResponse ( boolean \| null $deflate = null ) : string
$deflate	boolean \| null	Whether or not we should 'gzdeflate' the response body before we return it.
Результат	string	Logout Response deflated and base64 encoded

Gets the Status of the Logout Response.

public getStatus ( ) : string
Результат	string	The Status

Determines if the SAML LogoutResponse is valid

public isValid ( string \| null $requestId = null, boolean $retrieveParametersFromServer = false ) : boolean
$requestId	string \| null	The ID of the LogoutRequest sent by this SP to the IdP
$retrieveParametersFromServer	boolean
Результат	boolean	Returns if the SAML LogoutResponse is or not valid

The decoded, unprocessed XML response provided to the constructor.

protected string $_logoutResponse
Результат	string

Object that represents the setting info

protected OneLogin_Saml2_Settings $_settings
Результат	OneLogin_Saml2_Settings

A DOMDocument class loaded from the SAML LogoutResponse.

public DomDocument $document
Результат	DomDocument