PHP 클래스 OneLogin_Saml2_LogoutResponse

파일 보기 프로젝트 열기: onelogin/php-saml 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$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)

메소드 상세

__construct() 공개 메소드

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.

build() 공개 메소드

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

getError() 공개 메소드

* After execute a validation process, if fails this method returns the cause.
public getError ( )

getIssuer() 공개 메소드

Gets the Issuer of the Logout Response.
public getIssuer ( ) : string | null
리턴 string | null $issuer The Issuer

getResponse() 공개 메소드

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

getStatus() 공개 메소드

Gets the Status of the Logout Response.
public getStatus ( ) : string
리턴 string The Status

isValid() 공개 메소드

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

프로퍼티 상세

$_logoutResponse 보호되어 있는 프로퍼티

The decoded, unprocessed XML response provided to the constructor.
protected string $_logoutResponse
리턴 string

$_settings 보호되어 있는 프로퍼티

Object that represents the setting info
protected OneLogin_Saml2_Settings $_settings
리턴 OneLogin_Saml2_Settings

$document 공개적으로 프로퍼티

A DOMDocument class loaded from the SAML LogoutResponse.
public DomDocument $document
리턴 DomDocument