Base class DBMS_TABLEOBJ to handel table data in an object

• author: Peter Krebs (pk) <pitlinz@users.sourceforge.net>
• version: pk-04-01-02
• version: pk-05-11-17
• version: pk-08-01-31
• version: $Id: DBMS_TABLEOBJ.phpclass,v 1.60 2008/12/17 16:28:52 peterkrebs Exp $

Located in /user/OCSP_USER.phpclass (line 47)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --OCSP_USER

static mixed $usrList = array() (line 68)

list of already loaded users (unit of work) used in foactory classes

• staticvar: array $usrList:

array $curSecReq = array() (line 206)

array holding security requirements for the current function

• access: protected

string $dbConffile = "" (line 220)

• access: protected

int $dbConfSeekLoop = 0 (line 225)

• var: count loops in self::getDBConfFile()
• access: private

CLIENT $myClient = NULL (line 239)

• var: the client object
• deprecated: since pk-08-03-27 (CLIENT -> unit of work)
• since: pk-06-07-21
• access: protected

array $myClientLst = array() (line 247)

array of client id's the user is assigned

• since: pk-08-03-27
• access: protected

int $myCliId (line 232)

• var: the client id the user belongs to
• since: pk-06-04-19
• access: protected

int $myCtyId (line 254)

• var: the client type of the users client
• since: pk-06-07-21
• access: protected

array $myGroups = array() (line 195)

array of groups the user belongs to directly (stored in T_SYS_GROUPMEMBERS);

• access: protected

mixed $myTable = "T_SYS_USER" (line 214)

• staticvar: string $myTable: name of the db table

---

Redefinition of:

DBMS_TABLEOBJ::$myTable

NOT FINAL !!!!!

Inherited Variables

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::$autoIncFld
DBMS_TABLEOBJ::$dbTableDefinitions
DBMS_TABLEOBJ::$frmPostSubOjects
DBMS_TABLEOBJ::$hasObjVals
DBMS_TABLEOBJ::$initTS
DBMS_TABLEOBJ::$myCacheTS
DBMS_TABLEOBJ::$myFields
DBMS_TABLEOBJ::$myKeys
DBMS_TABLEOBJ::$myLinkedTableRows
DBMS_TABLEOBJ::$myMode
DBMS_TABLEOBJ::$myObjVals
DBMS_TABLEOBJ::$myObjValsPopulateTS
DBMS_TABLEOBJ::$objError
DBMS_TABLEOBJ::$objErrorMsg
DBMS_TABLEOBJ::$populateTS
DBMS_TABLEOBJ::$staticClassVars
DBMS_TABLEOBJ::$valChangeTS

Inherited from OCSP_OBJ

OCSP_OBJ::$global_currentUser
OCSP_OBJ::$global_defaultDBObj_read
OCSP_OBJ::$global_defaultDBObj_write
OCSP_OBJ::$myDBObj

static echoLoginForm (line 100)

outputs the propper login form

tries to get the proper method to output a login form

• $_FILES if on or more file uploads are found getHttpLoginForm is used

• SEC_REQ[CONTENTTYPE]

if isset an ajax call is supposed and the propper auth form method is chosen by the content type

• $_GET['SecReq'] if isset and $_GET['inToDiv'] an jOCSP.load(...) is supposed else jOCSP.getScript is supposed

NOTE to avoid missinterpretion always set SEC_REQ['CONTENTTYPE'] in ajax answers

NOTE do not set SEC_REQ['CONTENTTYPE'] if you have a normal non ajax call

boolean echoLoginForm (array $secReq)

• array $secReq

static factoryCurrentFromLoginPasswd (line 389)

factory a user object from login + password

unknown factoryCurrentFromLoginPasswd (string $login, string $passwd, [string $className = NULL], [boolean $debug = False])

• string $login
• string $passwd
• string $className
• boolean $debug

static factoryCurrentFromSession (line 346)

factory a user object from the session

OCSP_USER &factoryCurrentFromSession ([boolean $debug = False])

• boolean $debug

static factoryFromId (line 278)

factory a userObject

OCSP_USER &factoryFromId (int $aId, [boolean $debug = False])

• int $aId
• boolean $debug

static factoryFromLoginName (line 312)

factory a userObject

OCSP_USER factoryFromLoginName (string $lName, [boolean $debug = False])

• string $lName
• boolean $debug

static getHttpLoginForm (line 159)

sets the headers for a http authentication

NOTE: if you use this method logout is currently not available

boolean getHttpLoginForm ()

static getJavaScriptLoginForm (line 169)

void getJavaScriptLoginForm ()

Constructor __construct (line 265)

constructor

OCSP_USER __construct ([boolean $debug = False])

• boolean $debug

---

Redefined in descendants as:

• OCSP_SHELLUSER::__construct() : * attributes --------------------------------------------------

dbConnect (line 660)

void &dbConnect ([ $asAdmin = False], [ $debug = False])

• $asAdmin
• $debug

---

Redefinition of:

OCSP_OBJ::dbConnect()

connects to the default database

disable (line 491)

disable a user

• since: pk-05-06-27

void disable ([boolean $debug = False])

• boolean $debug

enable (line 517)

enables a user

• since: pk-05-06-27

void enable ([boolean $debug = False])

• boolean $debug

getDBConfFile (line 556)

returns the db-Conffile for the user

• version: pk-07-06-15
• version: pk-08-06-06
• since: pk-07-06-14
• access: public

string getDBConfFile ([boolean $useEnv = False], [boolean $debug = False])

• boolean $useEnv: (if True it is tried to find one from the environment)
• boolean $debug

getId (line 445)

returns the user id

• access: public

int getId ()

getLang (line 479)

returns the language id for the user

• since: pk-08-06-02
• access: public

string getLang ()

getName (line 455)

returns the user naem

• access: public

string getName ()

isConnected (line 617)

returns if the dbObj is connected

• since: pk-07-05-31

boolean isConnected ([boolean $autoConnect = False], [boolean $debug = False])

• boolean $autoConnect: try to connect
• boolean $debug

---

Redefinition of:

OCSP_OBJ::isConnected()

returns if the dbObj is connected

setDBConfFile (line 602)

sets the database config file

• since: pk-07-09-06
• access: public

void setDBConfFile (string $confFile)

• string $confFile

Inherited Methods

Inherited From DBMS_TABLEOBJ

DBMS_TABLEOBJ::DBMS_TABLEOBJ()
DBMS_TABLEOBJ::cacheRestore()
DBMS_TABLEOBJ::cacheWriteTo()
DBMS_TABLEOBJ::clearErrors()
DBMS_TABLEOBJ::dbDelete()
DBMS_TABLEOBJ::dbGetDataArray()
DBMS_TABLEOBJ::dbGetForm()
DBMS_TABLEOBJ::dbInsert()
DBMS_TABLEOBJ::dbPopulate()
DBMS_TABLEOBJ::dbReplace()
DBMS_TABLEOBJ::dbSave()
DBMS_TABLEOBJ::db_SetKey()
DBMS_TABLEOBJ::db_SetKeyArray()
DBMS_TABLEOBJ::getClassInclude()
DBMS_TABLEOBJ::getDbDesc()
DBMS_TABLEOBJ::getDBField()
DBMS_TABLEOBJ::getDBRow()
DBMS_TABLEOBJ::getDBVal()
DBMS_TABLEOBJ::getDefaults()
DBMS_TABLEOBJ::getErrorMsg()
DBMS_TABLEOBJ::getFieldDBDefault()
DBMS_TABLEOBJ::getForm()
DBMS_TABLEOBJ::getFormClassName()
DBMS_TABLEOBJ::getFormName()
DBMS_TABLEOBJ::getJSON()
DBMS_TABLEOBJ::getKeyArr()
DBMS_TABLEOBJ::getMyTable()
DBMS_TABLEOBJ::getObjValArray()
DBMS_TABLEOBJ::getObjValValue()
DBMS_TABLEOBJ::getPopulateTs()
DBMS_TABLEOBJ::getWhere()
DBMS_TABLEOBJ::hasChanged()
DBMS_TABLEOBJ::hasColumn()
DBMS_TABLEOBJ::hasErrors()
DBMS_TABLEOBJ::hasObjVals()
DBMS_TABLEOBJ::init()
DBMS_TABLEOBJ::isInit()
DBMS_TABLEOBJ::isPopulated()
DBMS_TABLEOBJ::keysAreSet()
DBMS_TABLEOBJ::populateFromKeys()
DBMS_TABLEOBJ::populateFromValues()
DBMS_TABLEOBJ::populateObjVals()
DBMS_TABLEOBJ::p_cacheIsExpired()
DBMS_TABLEOBJ::saveLinkedRow()
DBMS_TABLEOBJ::saveLinkedTableRows()
DBMS_TABLEOBJ::saveObjVals()
DBMS_TABLEOBJ::setChanged()
DBMS_TABLEOBJ::setDBField()
DBMS_TABLEOBJ::setDBFieldIfDiff()
DBMS_TABLEOBJ::setDBFieldIfEmpty()
DBMS_TABLEOBJ::setDBRow()
DBMS_TABLEOBJ::setDBVal()
DBMS_TABLEOBJ::setDefaults()
DBMS_TABLEOBJ::setError()
DBMS_TABLEOBJ::setLinkedTableRow()
DBMS_TABLEOBJ::setMyTable()
DBMS_TABLEOBJ::setObjValArray()
DBMS_TABLEOBJ::setObjValValue()
DBMS_TABLEOBJ::setObjVarIfEmpty()
DBMS_TABLEOBJ::setUnChanged()
DBMS_TABLEOBJ::userIsAllowed()
DBMS_TABLEOBJ::writeDebugInfo()
DBMS_TABLEOBJ::xmladdDOMElement()
DBMS_TABLEOBJ::xmlExport()
DBMS_TABLEOBJ::_getCacheFileName()
DBMS_TABLEOBJ::_getDBFields()

Inherited From OCSP_OBJ

OCSP_OBJ::castObj()
OCSP_OBJ::cloneMe()
OCSP_OBJ::currentUser()
OCSP_OBJ::dbConnect()
OCSP_OBJ::defaultDBObj()
OCSP_OBJ::defaultReadDBObj()
OCSP_OBJ::defaultWriteDBObj()
OCSP_OBJ::getConf()
OCSP_OBJ::getDBObj()
OCSP_OBJ::get_myClassConstant()
OCSP_OBJ::get_myObject_vars()
OCSP_OBJ::get_mySourceFile()
OCSP_OBJ::isConnected()
OCSP_OBJ::isMultiByteStr()
OCSP_OBJ::isUTF8()
OCSP_OBJ::setConf()
OCSP_OBJ::setDBObj()
OCSP_OBJ::set_myObject_vars()
OCSP_OBJ::set_myVarsFrom()

CLASS_SRC_FILE = __FILE__ (line 58)

• abstract:

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE