Path

ez components / documentation / api reference / 2007.1.1 / authentication


eZ Components 2007.1.1

Authentication: ezcAuthenticationFilterOptions

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

Class: ezcAuthenticationFilterOptions

Class containing the basic options for authentication filters. [source]

Parents

ezcBaseOptions
   |
   --ezcAuthenticationFilterOptions

Descendents

Child Class Description
ezcAuthenticationLdapOptions Class containing the options for ldap authentication filter.
ezcAuthenticationGroupOptions Class containing the options for group authentication filter.
ezcAuthenticationTokenOptions Class containing the options for the token authentication filter.
ezcAuthenticationHtpasswdOptions Class containing the options for the htpasswd authentication filter.
ezcAuthenticationOpenidOptions Class containing the options for the OpenID authentication filter.
ezcAuthenticationTypekeyOptions Class containing the options for the TypeKey authentication filter.
ezcAuthenticationDatabaseOptions Class containing the options for the database authentication filter.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public ezcAuthenticationFilterOptions __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

ezcAuthenticationFilterOptions __construct( [ $options = array()] )
Constructs an object with the specified values.

Parameters

Name Type Description
$options array(string=>mixed) The options for this class

Throws

ClassDescription
ezcBasePropertyNotFoundException if $options contains a property not defined
ezcBaseValueException if $options contains a property with a value not allowed

Redefinition of

Method Description
ezcBaseOptions::__construct() Construct a new options object.

Redefined in descendants as

Method Description
ezcAuthenticationLdapOptions::__construct() Constructs an object with the specified values.
ezcAuthenticationGroupOptions::__construct() Constructs an object with the specified values.
ezcAuthenticationTokenOptions::__construct() Constructs an object with the specified values.
ezcAuthenticationHtpasswdOptions::__construct() Constructs an object with the specified values.
ezcAuthenticationOpenidOptions::__construct() Constructs an object with the specified values.
ezcAuthenticationTypekeyOptions::__construct() Constructs an object with the specified values.
ezcAuthenticationDatabaseOptions::__construct() Constructs an object with the specified values.

Last updated: Wed, 28 Nov 2007