PHP Classes

File: sessMan.Functions.txt

Recommend this page to a friend!
  Classes of Albert van Dam   sessMan   sessMan.Functions.txt   Download  
File: sessMan.Functions.txt
Role: Documentation
Content type: text/plain
Description: Summary of functions
Class: sessMan
Session handler using PHP and MySQL
Author: By
Last change: Updated documentation to include additional class functionality
Date: 20 years ago
Size: 4,299 bytes
 

Contents

Class file image Download
*********************************************** *** *** *** sessMan *** *** Version 1.0 *** *** *** *** Albert van Dam *** *** Email: rhodevos@net4u.co.za *** *** *** *********************************************** *** *** *** SUMMARY OF FUNCTIONS *** *** *** *********************************************** function uid() ~~~~~~~~~~~~~~ Returns unencrypted user id function setExpireTime($newExpireTime) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Set a new session timeout time. $newExpireTime specified in minutes. The default timeout is after 10 minutes function set_logout_page($newLogoutPage) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Set a new logout page. The default is a blue screen with "You have been logged out" in white. You need to pass the exact URL (as in <a HREF...) This page will be called when you call the logout() function. function set_expire_page($newExpirePage) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Set a new timeout page. The default is a red screen with "Your session expired" in white. You need to pass the exact URL (as in <a HREF...) This page will be called whenever a session times out. function getUserID() ~~~~~~~~~~~~~~~~~~~~ Returns the encrypted user id function getGroupID() ~~~~~~~~~~~~~~~~~~~~~ Returns the group id the user belongs to function getSessionID() ~~~~~~~~~~~~~~~~~~~~~~~ Returns the session id function expireStamp() ~~~~~~~~~~~~~~~~~~~~~~ Returns a time stamp of when the session will expire function expireDate() ~~~~~~~~~~~~~~~~~~~~~ Returns the GMT time/date when the session will expire function validate($sessionID) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Validates the current session. Script dies if session expired. function logout($sessionID) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Terminates the session and destroy all variables saved. function create($userID) ~~~~~~~~~~~~~~~~~~~~~~~~ Creates a session. Returns the session id function login($userName, $userPass) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Verify user credentials. If valid user, creates session otherwise dies. Returns the session id if the login was successfull. function setVar1($value) ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar2($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar3($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar4($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar5($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar6($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar7($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar8($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar9($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function setVar10($value) { ~~~~~~~~~~~~~~~~~~~~~~~~ Set a variable. It is a 255 character field. function getVar1() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar2() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar3() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar4() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar5() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar6() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar7() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar8() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar9() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. function getVar10() { ~~~~~~~~~~~~~~~~~~~~ Returns a set variable. // !!!! SOUTH AFRICA ROCKS !!!! \\