SYSTEM - PHP Framework
Back to top  

token

Token Class provided by System to provide unique security tokens.

package

SYSTEM\TOKEN

Methods

Check if given class is a valid token handler

check_handler(string $handler) : boolean
static

Arguments

$handler

string

Token_handler Class

Response

boolean

Returns true or false.

Confirm a token

confirm(string $token) : boolean
static

Arguments

$token

string

Token string

Response

boolean

Returns true or false or throws an error depending on success.

Get a existing token from db

get(string $token) : array
static

Arguments

$token

string

Token string

Response

array

Returns database entry for the given Token if it exists.

Register given class as token_handler

register(string $class) : null
static

Arguments

$class

string

Token_handler Class

Response

null

Returns null.

Request a token

request(string $class, array $data = array(), string $post_script = null) : string
static

Arguments

$class

string

Token_handler Class

$data

array

Data sved to Database for the token_handler on confirm

$post_script

string

Function to be called after successfull token confirm

Response

string

Returns token string.

Call token text_fail on fail

text_fail(string $token) : string
static

Arguments

$token

string

token_handler Classname

Response

string

Returns token fail string.

Call token text_success on success

text_success(string $token) : string
static

Arguments

$token

string

token_handler Classname

Response

string

Returns token success string.

Properties

array Variable to store all registred token handlers

type_handlers :
static

Type(s)