SimpleSAML\IdP\LogoutHandlerInterface Interface Reference

Inheritance diagram for SimpleSAML\IdP\LogoutHandlerInterface:

Collaboration diagram for SimpleSAML\IdP\LogoutHandlerInterface:

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

Detailed Description

Definition at line 10 of file LogoutHandlerInterface.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\IdP\LogoutHandlerInterface::__construct

(

\SimpleSAML_IdP

$idp

)

Initialize this logout handler.

Parameters

\SimpleSAML_IdP

$idp

The IdP we are logging out from.

Implemented in SimpleSAML\IdP\IFrameLogoutHandler, and SimpleSAML\IdP\TraditionalLogoutHandler.

Member Function Documentation

onResponse()

SimpleSAML\IdP\LogoutHandlerInterface::onResponse	(		$assocId,
			$relayState,
		\SimpleSAML_Error_Exception	$error = null
	)

Handles responses to our logout requests.

This function will never return.

Parameters

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

Implemented in SimpleSAML\IdP\TraditionalLogoutHandler, and SimpleSAML\IdP\IFrameLogoutHandler.

startLogout()

SimpleSAML\IdP\LogoutHandlerInterface::startLogout	(	array &	$state,
			$assocId
	)

Start a logout operation.

This function must never return.

Parameters

array	&$state	The logout state.
string | null	$assocId	The association that started the logout.

Implemented in SimpleSAML\IdP\TraditionalLogoutHandler, and SimpleSAML\IdP\IFrameLogoutHandler.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/IdP/LogoutHandlerInterface.php