PHP Interface SimpleSAML\IdP\LogoutHandlerInterface

Show file Open project: simplesamlphp/simplesamlphp

Public Methods

Method	Description
__construct ( SimpleSAML_IdP $idp )	Initialize this logout handler.
onResponse ( string $assocId, string \| null $relayState, SimpleSAML_Error_Exception $error = null )	Handles responses to our logout requests.
startLogout ( array &$state, string \| null $assocId )	Start a logout operation.

Method Details

__construct() public method

Initialize this logout handler.

public __construct ( SimpleSAML_IdP $idp )
$idp	SimpleSAML_IdP	The IdP we are logging out from.

onResponse() public method

This function will never return.

public onResponse ( string $assocId, string \| null $relayState, SimpleSAML_Error_Exception $error = null )
$assocId	string	The association that is terminated.
$relayState	string \| null	The RelayState from the start of the logout.
$error	SimpleSAML_Error_Exception	The error that occurred during session termination (if any).

startLogout() public method

This function must never return.

public startLogout ( array &$state, string \| null $assocId )
$state	array
$assocId	string \| null	The association that started the logout.