eZ Components latest

Getting Started

Archive (1.4)
Authentication (1.3.1)
AuthenticationDatabaseTiein (1.1)
Base (1.8)
Cache (1.5)
Configuration (1.3.5)
ConsoleTools (1.6)
Database (1.4.6)
DatabaseSchema (1.4.3)
Debug (1.2.1)
Document (1.3)
EventLog (1.4)
EventLogDatabaseTiein (1.0.2)
Execution (1.1.1)
Feed (1.3)
File (1.2)
Graph (1.5)
GraphDatabaseTiein (1.0.1)
ImageAnalysis (1.1.3)
ImageConversion (1.3.7)
Mail (1.7)
MvcTools (1.1.2)
MvcAuthenticationTiein (1.0)
MvcFeedTiein (1.0)
MvcMailTiein (1.0.1)
MvcTemplateTiein (1.0)
PersistentObject (1.7)
PersistentObjectDatabaseSchemaTiein (1.3)
PhpGenerator (1.0.5)
Search (1.0.8)
SignalSlot (1.1.1)
SystemInformation (1.0.8)
Template (1.4.2)
TemplateTranslationTiein (1.1)
Translation (1.3.2)
TranslationCacheTiein (1.1.2)
Tree (1.1.3)
TreeDatabaseTiein (1.1.1)
TreePersistentObjectTiein (1.0)
Url (1.2.2)
UserInput (1.4)
Webdav (1.1.3)
Workflow (1.4)
WorkflowDatabaseTiein (1.4)
WorkflowEventLogTiein (1.1)
WorkflowSignalSlotTiein (1.0)

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

Class containing authentication filter options [source]

ezcBaseOptions
   |
   --ezcMvcAuthenticationFilterOptions

ezcDbInstance	read/write	`$database` The database that is used for the user database.
string	read/write	`$loginRequiredUri` The URI that the filter will be redirected to when authentication is required.
string	read/write	`$logoutUri` The URI that the filter will be redirected to when he runs the logout action.
string	read/write	`$passwordField` The field that contains the user's password.
string	read/write	`$sessionTimestampKey` The name of the session variable that contains the last-accessed timestamp.
string	read/write	`$sessionUserIdKey` The name of the session variable that contains the user ID.
string	read/write	`$tableName` The table that stores the user information.
string	read/write	`$userIdField` The field that contains the unique user ID.
string	read/write	`$userNameField` The field that contains the user's full name.
string	read/write	`$varNameFilter` The name of the variable under which the auth filter is available in the controller's actions.
string	read/write	`$varNameUserId` The name of the variable under which the user ID will be provided in the controller's actions.
string	read/write	`$varNameUserName` The name of the variable under which the user name will be provided in the controller's actions.

protected ezcBaseOptions::$properties

public ezcMvcAuthenticationFilterOptions

__construct(
[$options = array()] )

Constructs an object with the specified values.

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.

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

Constructs an object with the specified values.

Name	Type	Description
`$options`	array(string=>mixed)

Class	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.

Last updated: Mon, 21 Dec 2009