Skip to content
Snippets Groups Projects
Commit 521c1d73 authored by Jaime Perez Crespo's avatar Jaime Perez Crespo
Browse files

Reformat the SimpleSAML_IdP_LogoutHandler abstract class.

parent 31773aa6
No related branches found
No related tags found
No related merge requests found
<?php
/**
* Base class for logout handlers.
*
* @package SimpleSAMLphp
*/
abstract class SimpleSAML_IdP_LogoutHandler {
/**
* The IdP we are logging out from.
*
* @var SimpleSAML_IdP
*/
protected $idp;
/**
* Initialize this logout handler.
*
* @param SimpleSAML_IdP $idp The IdP we are logging out from.
*/
public function __construct(SimpleSAML_IdP $idp) {
$this->idp = $idp;
}
/**
* Start a logout operation.
*
* This function must never return.
*
* @param array &$state The logout state.
* @param string|null $assocId The association that started the logout.
*/
abstract public function startLogout(array &$state, $assocId);
/**
* Handles responses to our logout requests.
*
* This function will never return.
*
* @param string $assocId The association that is terminated.
* @param string|null $relayState The RelayState from the start of the logout.
* @param SimpleSAML_Error_Exception|null $error The error that occurred during session termination (if any).
*/
public function onResponse($assocId, $relayState, SimpleSAML_Error_Exception $error = NULL) {
assert('is_string($assocId)');
assert('is_string($relayState) || is_null($relayState)');
// don't do anything by default
}
abstract class SimpleSAML_IdP_LogoutHandler
{
/**
* The IdP we are logging out from.
*
* @var SimpleSAML_IdP
*/
protected $idp;
/**
* Initialize this logout handler.
*
* @param SimpleSAML_IdP $idp The IdP we are logging out from.
*/
public function __construct(SimpleSAML_IdP $idp)
{
$this->idp = $idp;
}
/**
* Start a logout operation.
*
* This function must never return.
*
* @param array &$state The logout state.
* @param string|null $assocId The association that started the logout.
*/
abstract public function startLogout(array &$state, $assocId);
/**
* Handles responses to our logout requests.
*
* This function will never return.
*
* @param string $assocId The association that is terminated.
* @param string|null $relayState The RelayState from the start of the logout.
* @param SimpleSAML_Error_Exception|null $error The error that occurred during session termination (if any).
*/
public function onResponse($assocId, $relayState, SimpleSAML_Error_Exception $error = null)
{
assert('is_string($assocId)');
assert('is_string($relayState) || is_null($relayState)');
// don't do anything by default
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment