XoopsTokenHandler Class Reference

Inherited by XoopsMultiTokenHandler, and XoopsSingleTokenHandler.

Inheritance diagram for XoopsTokenHandler:

[legend]
List of all members.

Public Member Functions

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

Public Attributes

 $_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.


Member Function Documentation

& XoopsTokenHandler::create ( name,
timeout = XOOPS_TOKEN_TIMEOUT 
)

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

public

Parameters:
$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

Parameters:
$name token's name string.
Returns:
XoopsToken

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

Parameters:
$name token's name string.
Returns:
bool

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

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


Member Data Documentation

XoopsTokenHandler::$_prefix = ""

private


The documentation for this class was generated from the following file:
Generated on Thu Nov 2 00:27:26 2006 for XOOPS Cube Legacy by  doxygen 1.5.1