Inheritance diagram for XoopsTokenHandler:
Public Member Functions | |
& | create ($name, $timeout=XOOPS_TOKEN_TIMEOUT) |
& | fetch ($name) |
register (&$token) | |
unregister (&$token) | |
isRegistered ($name) | |
validate (&$token, $clearIfValid) | |
Public Attributes | |
$_prefix = "" |
You can create various agents by extending the derivative class. see default(sample) classes.
& XoopsTokenHandler::create | ( | $ | name, | |
$ | timeout = XOOPS_TOKEN_TIMEOUT | |||
) |
Create XoopsToken instance, regist(keep to server), and returns it.
public
$name | this token's name string. | |
$timeout | effective time(if $timeout equal 0, this token will become unlimited) |
Reimplemented in XoopsMultiTokenHandler.
& XoopsTokenHandler::fetch | ( | $ | name | ) |
Fetches from server side, and returns it.
public
$name | token's name string. |
XoopsTokenHandler::register | ( | &$ | token | ) |
Register token to session.
Reimplemented in XoopsMultiTokenHandler.
XoopsTokenHandler::unregister | ( | &$ | token | ) |
Unregister token to session.
Reimplemented in XoopsMultiTokenHandler.
XoopsTokenHandler::isRegistered | ( | $ | name | ) |
If a token of the name that equal $name is registered on session, this method will return true.
public
$name | token's name string. |
XoopsTokenHandler::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.
public
$token | XoopsToken | |
$clearIfValid | If token passed validation, $token will be unregistered. |
XoopsTokenHandler::$_prefix = "" |
private