Path

ez components / documentation / api reference / 2009.1rc1 / authentication


eZ Components 2009.1rc1

Authentication: ezcAuthenticationFilter

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

Class: ezcAuthenticationFilter

Base class for all authentication filters. [source]
The classes which extend this class must implement the run() method.
This class contains the STATUS_OK constant (with value 0) which is returned by the run() method in case of success. Subclasses must define their own constants to be returned in case of insuccess.
This class adds support for options for subclasses, by providing the protected property $options, and the public methods setOptions() and getOptions().

Descendents

Child Class Description
ezcAuthenticationLdapFilter Filter to authenticate against an LDAP directory.
ezcAuthenticationGroupFilter Group authentication filters together.
ezcAuthenticationTokenFilter Filter to authenticate against a server generated token.
ezcAuthenticationHtpasswdFilter Filter to authenticate against an Unix htpasswd file.
ezcAuthenticationOpenidFilter Filter to authenticate against OpenID. Currently supporting OpenID 1.0, 1.1 and 2.0.
ezcAuthenticationTypekeyFilter Filter to authenticate against TypeKey.
ezcAuthenticationDatabaseFilter Filter to authenticate against a database.

Constants

STATUS_OK = 0 Successful authentication.

Member Variables

protected ezcAuthenticationFilterOptions $options
Options for authentication filters.

Method Summary

public ezcAuthenticationFilterOptions getOptions( )
Returns the options of this class.
public abstract int run( $credentials )
Runs the filter and returns a status code when finished.
public void setOptions( $options )
Sets the options of this class to $options.

Methods

getOptions

Returns the options of this class.

run

int run( ezcAuthenticationCredentials $credentials )
Runs the filter and returns a status code when finished.

Parameters

Name Type Description
$credentials ezcAuthenticationCredentials Authentication credentials

Redefined in descendants as

Method Description
ezcAuthenticationLdapFilter::run() Runs the filter and returns a status code when finished.
ezcAuthenticationGroupFilter::run() Runs the filter and returns a status code when finished.
ezcAuthenticationTokenFilter::run() Runs the filter and returns a status code when finished.
ezcAuthenticationHtpasswdFilter::run() Runs the filter and returns a status code when finished.
ezcAuthenticationOpenidFilter::run() Runs the filter and returns a status code when finished.
ezcAuthenticationTypekeyFilter::run() Runs the filter and returns a status code when finished.
ezcAuthenticationDatabaseFilter::run() Runs the filter and returns a status code when finished.

setOptions

void setOptions( ezcAuthenticationFilterOptions $options )
Sets the options of this class to $options.

Parameters

Name Type Description
$options ezcAuthenticationFilterOptions Options for this class

Last updated: Mon, 22 Jun 2009