eZ Components 2008.1

Getting Started

Components

Archive (1.3)
Authentication (1.2)
AuthenticationDatabaseTiein (1.1)
Base (1.5)
Cache (1.4)
Configuration (1.3)
ConsoleTools (1.4)
Database (1.4)
DatabaseSchema (1.4)
Debug (1.2)
Document (1.0)
EventLog (1.3)
EventLogDatabaseTiein (1.0.2)
Execution (1.1.1)
Feed (1.1)
File (1.2)
Graph (1.3)
GraphDatabaseTiein (1.0)
ImageAnalysis (1.1.3)
ImageConversion (1.3.5)
Mail (1.5)
PersistentObject (1.4)
PersistentObjectDatabaseSchemaTiein (1.2.1)
PhpGenerator (1.0.4)
Search (1.0)
SignalSlot (1.1.1)
SystemInformation (1.0.6)
Template (1.3)
TemplateTranslationTiein (1.0)
Translation (1.2)
TranslationCacheTiein (1.1.2)
Tree (1.1)
TreeDatabaseTiein (1.1)
TreePersistentObjectTiein (1.0)
Url (1.2.1)
UserInput (1.3)
Webdav (1.0)
Workflow (1.2)
WorkflowDatabaseTiein (1.2)
WorkflowEventLogTiein (1.1)
WorkflowSignalSlotTiein (1.0)

Authentication: ezcAuthenticationSessionOptions

[ Tutorial ] [ Rfcs ] [ Security ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcAuthenticationSessionOptions

Class containing the options for the authentication session. [source]

Example of use:

 1.  // create an options object
 2.   $options = new ezcAuthenticationSessionOptions();
 3.  $options->validity = 60;
 4.  $options->idKey = 'xxx';
 5.  $options->timestampKey = 'yyy';
 6.  
 7.  // use the options object when creating a new Session object
 8.   $filter = new ezcAuthenticationSession( $options );
 9.  
10.  // alternatively, you can set the options to an existing object
11.   $filter = new ezcAuthenticationSession();
12.  $filter->setOptions( $options );

Parents

ezcBaseOptions
   |
   --ezcAuthenticationSessionOptions

Properties

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.

Inherited Member Variables

From ezcBaseOptions:

protected ezcBaseOptions::$properties

Method Summary

public ezcAuthenticationSessionOptions

__construct(
[$options = array()] )

Constructs an object with the specified values.

Inherited Methods

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.

Methods

__construct

ezcAuthenticationSessionOptions __construct( [ $options = array()] )