|
XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
|
Public Member Functions | |
| & | create ($name, $timeout=XOOPS_TOKEN_TIMEOUT) |
| & | fetch ($name) |
| register (&$token) | |
| unregister (&$token) | |
| isRegistered ($name) | |
| validate (&$token, $clearIfValid) | |
Data Fields | |
| $_prefix = '' | |
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.
| & create | ( | $name, | |
| $timeout = XOOPS_TOKEN_TIMEOUT ) |
Create XoopsToken instance, register (keep to server), and returns it.
@access public
| this | $name | token's name string. |
| int | $timeout | time(if $timeout equal 0, this token will become unlimited) |
Reimplemented in XoopsMultiTokenHandler.
| & fetch | ( | $name | ) |
Fetches from server side, and returns it.
@access public
| $name | token's name string. |
| isRegistered | ( | $name | ) |
| register | ( | & | $token | ) |
| unregister | ( | & | $token | ) |
| 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
| XoopsToken | $token | |
| If | $clearIfValid | token passed validation, $token will be unregistered. |