Class XoopsTokenHandler
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.
Methods summary
public
&
|
#
create( $name $name, $timeout $timeout = XOOPS_TOKEN_TIMEOUT )
Create XoopsToken instance, regist(keep to server), and returns it.
Create XoopsToken instance, regist(keep to server), and returns it.
Parameters
- $name
$name this token's name string.
- $timeout
$timeout effective time(if $timeout equal 0, this token will become unlimited)
|
public
XoopsToken
&
|
#
fetch( $name $name )
Fetches from server side, and returns it.
Fetches from server side, and returns it.
Parameters
- $name
$name token's name string.
Returns
|
public
|
#
register( & $token )
Register token to session.
Register token to session.
|
public
|
#
unregister( & $token )
Unregister token to session.
Unregister token to session.
|
public
boolean
|
#
isRegistered( $name $name )
If a token of the name that equal $name is registered on session, this method
will return true.
If a token of the name that equal $name is registered on session, this method
will return true.
Parameters
- $name
$name token's name string.
Returns
boolean
|
public
boolean
|
#
validate( $token & $token, $clearIfValid $clearIfValid )
This method takes out token's string from Request, and validate token with
it. if it passed validation, this method will return true.
This method takes out token's string from Request, and validate token with
it. if it passed validation, this method will return true.
Parameters
- $token
$token XoopsToken
- $clearIfValid
$clearIfValid If token passed validation, $token will be unregistered.
Returns
boolean
|
Properties summary
public
string
|
$_prefix
|
"" |
|