Apache Zeta Components Manual :: Docs For Class ezcAuthenticationTokenFilter

Authentication::ezcAuthenticationTokenFilter

Class ezcAuthenticationTokenFilter

Filter to authenticate against a server generated token.

Some uses for this filter:

The following example shows how to create a CAPTCHA test. The example is divided into 2 parts: the initial request (where the user sees the CAPTCHA image and enters the characters he sees in a form) and the follow-up request (after the user submits the form).

Source for this file: /Authentication/src/filters/token/token_filter.php

ezcAuthenticationFilter
   |
   --ezcAuthenticationTokenFilter
Version:   //autogen//

Constants

STATUS_TOKEN_INCORRECT = 1 Token is not the same as the provided one.

Inherited Constants

From ezcAuthenticationFilter:
ezcAuthenticationFilter::STATUS_OK    Successful authentication.

Properties

callback read/write $function
The encryption function to use on the user credentials in order to compare it with the stored token.
string read/write $token
The token to check against.

Inherited Member Variables

From ezcAuthenticationFilter
protected ezcAuthenticationFilter::$options

Method Summary

public ezcAuthenticationTokenFilter __construct( $token , $function , [ $options = null] )
Creates a new object of this class.
public int run( $credentials )
Runs the filter and returns a status code when finished.

Inherited Methods

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

Methods

__construct

ezcAuthenticationTokenFilter __construct( string $token , callback $function , [ezcAuthenticationTokenOptions $options = null] )

Creates a new object of this class.

Parameters:
Name Type Description
$token string A string value generated by the server
$function callback The encryption function to use when comparing tokens
$options ezcAuthenticationTokenOptions Options for 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
Redefinition of:
Method Description
ezcAuthenticationFilter::run() Runs the filter and returns a status code when finished.
Documentation generated by phpDocumentor 1.4.3