tgcSession is a wrapper-class for PHP's session-functions
tgcSession is a wrapper-class for PHP's session-functions depending on the used version of PHP it uses a certain way of registering and unregistering session variables and so on
Located in /tgcSession.php (line 25)
Constructor
Constructor the constructor has to be called before any headers are sent, it starts a new session or continues an existing one the param $settings indicates what has to be done before starting the session, it may contain the following items, each with a value to set:
"setSavePath" - set the path of the directory used to save session data "setSessionName" - set the session-name "setSessionId" - set the session-id "setCacheExpire" - set the cache-expire time (since PHP 4.2.0) "setCacheLimiter" - set the name of the current cache limiter
decodes session data from a string
decodes session data from a string decodes the session data in $data and sets the variables stored in the session
deletes the session and its data
deletes the session and its data deletes the session and its data if the optional parameter is set to true, all global variables that belong to the session are deleted, too
displays the variables currently stored in the session
displays the variables currently stored in the session displays the variables currently stored in the session and some information about the object
encodes the current session data as a string
encodes the current session data as a string returns a string with the contents of the current session encoded within
returns the cache-expire time
returns the cache-expire time returns the current cache-expire time on success, else the return-value is -1 (since PHP >= 4.2.0) as this method does nothing else than using PHP's session_cache_expire() please see http://www.php.net/manual/en/function.session-cache-expire.php for more information
returns the current cache limiter
returns the current cache limiter returns the name of the current cache limiter (since PHP >= 4.0.3) as this method does nothing else than using PHP's session_cache_limiter() please see http://www.php.net/manual/en/function.session-cache-limiter.php for more information
returns the sessions cookie parameters
returns the sessions cookie parameters returns an array with the current session cookie information, the array contains the following items: "lifetime" - the lifetime of the cookie "path" - the path where information is stored "domain" - the domain of the cookie "secure" - the cookie should only be sent over secure connections. (This item was added in PHP 4.0.4.) as this method does nothing else than using PHP's session_get_cookie_params() please see http://www.php.net/manual/en/function.session-get-cookie-params.php for more information
returns the session module
returns the session module returns the name of the current session module
returns the current session save path
returns the current session save path returns the path of the current directory used to save session data
returns the session-id
returns the session-id returns the current session-id
returns the session-name
returns the session-name returns the name of the current session
returns a string to append on URLs
returns a string to append on URLs this method returns a string like PHPSESSID=f57168af293ea522be176cc13abd5aa3 that can be appended to an URL if necessary
returns a session variable
returns a session variable this method returns the value stored in the current session under the given name
checks whether a variable with $varName is registered in the current session
checks whether a variable with $varName is registered in the current session returns true if there is a variable with the name $varName registered in the current session
updates the current session id with a newly generated one
updates the current session id with a newly generated one replaces the current session id with a new one, and keeps the current session information - available since PHP 4.3.2 or higher as this method does nothing else than using PHP's session_regenerate_id() please see http://www.php.net/manual/en/function.session-regenerate-id.php for more information
sets the sessions cookie parameters
sets the sessions cookie parameters sets cookie parameters defined in the php.ini file , the effect of this method only lasts for the duration of the script as this method does nothing else than using PHP's session_set_cookie_params() please see http://www.php.net/manual/en/function.session-set-cookie-params.php for more information
sets the session module
sets the session module sets the name of the session module that has to be used
sets user-level session storage functions
sets user-level session storage functions sets the user-level session storage functions which are used for storing and retrieving data associated with a session this is most useful when a storage method other than those supplied by PHP sessions is preferred. i.e. Storing the session data in a local database as this method does nothing else than using PHP's session_set_save_handler() please see http://www.php.net/manual/en/function.session-set-save-handler.php for more information
add a variable/object to the session
add a variable/object to the session use this method to add a new variable or object to the current session
unsets all session variables
unsets all session variables use this method to unset every variable you stored in the session
unsets a session variable
unsets a session variable use this method to remove a certain variable from the session
write session data and end session
write session data and end session ends the current session and stores session data (since PHP >= 4.0.4) as this method does nothing else than using PHP's session_write_close() please see http://www.php.net/manual/en/function.session-write-close.php for more information
Documentation generated on Fri, 19 Nov 2004 23:40:46 +0100 by phpDocumentor 1.2.3