Filter to authenticate against a server generated token.
Some uses for this filter:
Source for this file: /Authentication/src/filters/token/token_filter.php
ezcAuthenticationFilter | --ezcAuthenticationTokenFilter
Version: | //autogen// |
STATUS_TOKEN_INCORRECT
= 1
|
Token is not the same as the provided one. |
From ezcAuthenticationFilter: | |
---|---|
ezcAuthenticationFilter::STATUS_OK
|
Successful authentication. |
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. |
From ezcAuthenticationFilter | |
---|---|
protected |
ezcAuthenticationFilter::$options
|
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. |
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. |
Creates a new object of this class.
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 |
Runs the filter and returns a status code when finished.
Name | Type | Description |
---|---|---|
$credentials |
ezcAuthenticationCredentials | Authentication credentials |
Method | Description |
---|---|
ezcAuthenticationFilter::run() |
Runs the filter and returns a status code when finished. |