XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
XoopsTokenHandler Class Reference
Inheritance diagram for XoopsTokenHandler:
XoopsMultiTokenHandler XoopsSingleTokenHandler

Public Member Functions

create ($name, $timeout=XOOPS_TOKEN_TIMEOUT)
 
fetch ($name)
 
 register (&$token)
 
 unregister (&$token)
 
 isRegistered ($name)
 
 validate (&$token, $clearIfValid)
 

Data Fields

 $_prefix = ''
 

Detailed Description

This class express ticket agent and ticket collector. this publishes token, keeps a token to server to check it later(next request).

You can create various agents by extending the derivative class. see default(sample) classes.

Definition at line 186 of file token.php.

Member Function Documentation

◆ create()

& create ( $name,
$timeout = XOOPS_TOKEN_TIMEOUT )

Create XoopsToken instance, register (keep to server), and returns it.

@access public

Parameters
this$nametoken's name string.
int$timeouttime(if $timeout equal 0, this token will become unlimited)
Returns
\XoopsToken

Reimplemented in XoopsMultiTokenHandler.

Definition at line 201 of file token.php.

◆ fetch()

& fetch ( $name)

Fetches from server side, and returns it.

@access public

Parameters
$nametoken's name string.
Returns
XoopsToken

Definition at line 215 of file token.php.

◆ isRegistered()

isRegistered ( $name)

If a token of the name that equal $name is registered on session, this method will return true.

@access public

Parameters
$nametoken's name string.
Returns
bool

Definition at line 250 of file token.php.

◆ register()

register ( & $token)

Register token to session.

Parameters
$token

Reimplemented in XoopsMultiTokenHandler.

Definition at line 228 of file token.php.

◆ unregister()

unregister ( & $token)

Unregister token to session.

Parameters
$token

Reimplemented in XoopsMultiTokenHandler.

Definition at line 237 of file token.php.

◆ validate()

validate ( & $token,
$clearIfValid )

This method takes out token's string from Request, and validate token with it. if it passed validation, this method will return true.

@access public

Parameters
XoopsToken$token
If$clearIfValidtoken passed validation, $token will be unregistered.
Returns
bool

Definition at line 264 of file token.php.

Field Documentation

◆ $_prefix

$_prefix = ''

@access private

Definition at line 191 of file token.php.


The documentation for this class was generated from the following file: