File: LogoutHandler.php

package info (click to toggle)
simplesamlphp 1.13.1-2%2Bdeb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 11,304 kB
  • sloc: php: 65,124; xml: 629; python: 376; sh: 193; perl: 185; makefile: 43
file content (55 lines) | stat: -rw-r--r-- 1,273 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<?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. */
	}

}