Method | Description | |
---|---|---|
cloneState ( array $state ) : array | Clone the state. | |
deleteState ( &$state ) | Delete state. | |
getPersistentAuthData ( array $state ) : array | Get the persistent authentication state from the state array. | |
getStateId ( &$state, boolean $rawId = false ) : string | Retrieve the ID of a state array. | |
loadExceptionState ( string | null $id = null ) : array | null | Retrieve an exception state. | |
loadState ( string $id, string $stage, boolean $allowMissing = false ) : array | null | Retrieve saved state. | |
parseStateID ( string $stateId ) : array | Get the ID and (optionally) a URL embedded in a StateID, in the form 'id:url'. | |
saveState ( &$state, string $stage, boolean $rawId = false ) : string | Save the state. | |
throwException ( array $state, SimpleSAML_Error_Exception $exception ) | Throw exception to the state exception handler. |
Method | Description | |
---|---|---|
getStateTimeout ( ) : integer | Retrieve state timeout. |
public static cloneState ( array $state ) : array | ||
$state | array | The original request state. |
return | array | Cloned state data. |
public static deleteState ( &$state ) |
public static getPersistentAuthData ( array $state ) : array | ||
$state | array | The state array to analyze. |
return | array | The persistent authentication state. |
public static getStateId ( &$state, boolean $rawId = false ) : string | ||
$rawId | boolean | Return a raw ID, without a restart URL. Defaults to FALSE. |
return | string | Identifier which can be used to retrieve the state later. |
public static loadState ( string $id, string $stage, boolean $allowMissing = false ) : array | null | ||
$id | string | State identifier (with embedded restart information). |
$stage | string | The stage the state should have been saved in. |
$allowMissing | boolean | Whether to allow the state to be missing. |
return | array | null | State information, or null if the state is missing and $allowMissing is true. |
public static parseStateID ( string $stateId ) : array | ||
$stateId | string | The state ID to use. |
return | array | A hashed array with the ID and the URL (if any), in the 'id' and 'url' keys, respectively. If there's no URL in the input parameter, NULL will be returned as the value for the 'url' key. |
public static throwException ( array $state, SimpleSAML_Error_Exception $exception ) | ||
$state | array | The state array. |
$exception | SimpleSAML_Error_Exception | The exception. |