XoopsToken Class Reference

List of all members.

Public Member Functions

 XoopsToken ($name, $timeout=XOOPS_TOKEN_TIMEOUT)
 _generateToken ()
 getTokenName ()
 getTokenValue ()
 setSerialNumber ($serial_number)
 getSerialNumber ()
 getHtml ()
 getUrl ()
 validate ($token=null)

Public Attributes

 $_name_
 $_token_
 $_lifetime_
 $_unlimited_
 $_number_ = 0

Detailed Description

This class express token. this has name, token's string for inquiry, lifetime, serial number. this does not have direct validation method, therefore this does not depend on $_Session and $_Request.

You can refer to a handler class for this token. this token class means ticket, and handler class means ticket agent. there is a strict ticket agent type(XoopsSingleTokenHandler), and flexible ticket agent for the tab browser(XoopsMultiTokenHandler).


Member Function Documentation

XoopsToken::XoopsToken ( name,
timeout = XOOPS_TOKEN_TIMEOUT 
)

Parameters:
$name this token's name string.
$timeout effective time(if $timeout equal 0, this token will become unlimited)

XoopsToken::_generateToken (  ) 

Returns random string for token's string.

protected

Returns:
string

XoopsToken::getTokenName (  ) 

Returns this token's name.

public

Returns:
string

XoopsToken::getTokenValue (  ) 

Returns this token's string.

public

Returns:
string

XoopsToken::setSerialNumber ( serial_number  ) 

Set this token's serial number.

public

Parameters:
$serial_number serial number

XoopsToken::getSerialNumber (  ) 

Returns this token's serial number.

public

Returns:
int

XoopsToken::getHtml (  ) 

Returns hidden tag string that includes this token. you can use it for <form> tag's member.

public

Returns:
string

XoopsToken::getUrl (  ) 

Returns url string that includes this token. you can use it for hyper link.

Returns:
string

XoopsToken::validate ( token = null  ) 

If $token equals this token's string, true is returened.

Returns:
bool


Member Data Documentation

XoopsToken::$_name_

token's name. this is used for identification. protected

XoopsToken::$_token_

token's string for inquiry. this should be a random code for security. private

XoopsToken::$_lifetime_

the unixtime when this token is effective.

protected

XoopsToken::$_unlimited_

unlimited flag. if this is true, this token is not limited in lifetime.

XoopsToken::$_number_ = 0

serial number. this used for identification of tokens of same name tokens.

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