Class containing the options for the authentication session.
Example of use:
Source for this file: /Authentication/src/options/session_options.php
ezcBaseOptions | --ezcAuthenticationSessionOptions
Version: | //autogen// |
string | read/write |
$idKey
The key to use in $_SESSION to hold the user ID of the user who is logged in. |
string | read/write |
$timestampKey
The key to use in $_SESSION to hold the authentication timestamp. |
int | read/write |
$validity
The amount of seconds the session can be idle. |
From ezcBaseOptions | |
---|---|
protected |
ezcBaseOptions::$properties
|
public ezcAuthenticationSessionOptions |
__construct(
[ $options
= array()] )
Constructs an object with the specified values. |
From ezcBaseOptions | |
---|---|
public ezcBaseOptions |
ezcBaseOptions::__construct()
Construct a new options object. |
public void |
ezcBaseOptions::merge()
Merge an array into the actual options object. |
public bool |
ezcBaseOptions::offsetExists()
Returns if an option exists. |
public mixed |
ezcBaseOptions::offsetGet()
Returns an option value. |
public void |
ezcBaseOptions::offsetSet()
Set an option. |
public void |
ezcBaseOptions::offsetUnset()
Unset an option. |
Constructs an object with the specified values.
Name | Type | Description |
---|---|---|
$options |
array(string=>mixed) | Options for this class |
Type | Description |
---|---|
ezcBaseValueException |
if $options contains a property with a value not allowed |
ezcBasePropertyNotFoundException |
if $options contains a property not defined |
Method | Description |
---|---|
ezcBaseOptions::__construct() |
Construct a new options object. |