static mixed $staticClassVars = array('myClassSrcFile') (line 61)

• staticvar: array $staticClassVars: vars which must not be copied
• access: protected

OCSP_OBJ::$staticClassVars

array $frmPostSubOjects = NULL (line 166)

• var: stru
• since: pk-08-03-07

double $initTS = 0 (line 122)

• var: linux timestamp when DB_TBLOBJ::init() was called
• access: protected

mixed $myFields = NULL (line 78)

• staticvar: array $myFields: array of db column description
• access: protected

array $myLinkedTableRows = array() (line 157)

array of linked (joined) table rows

this is used if a form has subtables or joins which are not directly implemented in the table object class to change this values on insert,update or delete

structure of the array:

• [tableName][]
• - [ROW] => array COL => VALUE
• - [OBJ] => DBMS_TABLEOBJ
• - [CMD] => one of _OCSP_DBCMD_* cmd

• access: protected

array $myObjVals = array() (line 134)

• since: pk-05-07-13
• access: protected

mixed $myTable = "" (line 87)

NOT FINAL !!!!!

• staticvar: string $myTable: NEED TO BE OVERRITTEN !!!!
• access: protected

• AUDIENCE::$myTable
• ADDRESS::$myTable
• CLIENT::$myTable
• CLI_STAFF::$myTable
• CLI_STAFF_TYPE::$myTable
• CLI_STATE::$myTable
• CLI_TYPE::$myTable
• TMPL_CHAPTER::$myTable : the database table
• CLI_PROFILE::$myTable
• CMS_CHAPTER::$myTable
• CMS_PROJECT::$myTable
• CMS_CSSCLASS::$myTable
• CMS_CSSSTYLE::$myTable
• CMS_PAGE::$myTable
• TMPL_CHAPTER::$myTable
• CMS_PAGE_TEMPLATE::$myTable
• CLIENT_DEP_TREE_NODE::$myTable
• CMS_MENU_NODE::$myTable
• MED_CATEGORY_NODE::$myTable
• PRO_GROUP_NODE::$myTable
• CLIENT_DEP_TREE::$myTable
• CMS_MENU_V2::$myTable
• MED_CATEGORY::$myTable
• PRO_GROUP_TREE::$myTable
• MED_MIMETYPE::$myTable : name of the db table
• MED_FILE::$myTable : name of the db table
• MED_OBJECT::$myTable : name of the db table
• OCSP_MODULE::$myTable : table name
• OCSP_MOD_CONF::$myTable : table name
• PRO_PART::$myTable
• PRO_PARTTYPE::$myTable
• PRO_PRODTYPE::$myTable
• PRO_PRODUCT::$myTable
• PRO_GROUP::$myTable
• PRO_GROUP_TYPE::$myTable
• PRO_PROD_TYPE::$myTable
• PRO_PART_TYPE::$myTable
• SHOP_ORDER::$myTable : the database table
• SHOP_ORDERITEM::$myTable : the database table
• OCSP_USER::$myTable
• OCSP_GROUP::$myTable

string $objErrorMsg = "" (line 112)

• var: obj error message
• access: protected

double $valChangeTS = 1 (line 103)

• var: timestamp values changed
• since: pk-03-10-25
• access: protected

cacheRestore (line 2282)

• access: protected

• $debug

clearErrors (line 2051)

clears all errors

• CLI_PROFILE::clearErrors() : resets profile errors

dbGetDataArray (line 1883)

returns the the data array of a joins to the current row

requirements:

• $this->myTable must have an autoIncFld
• the foreign table must have a column called like $this->autoIncFld
• getDBField($this->autoIncFld) must return a value

• todo: DBMS_TABLEOBJ::dbGetDataArray() check the filter if the columns exists in foreign table
• since: pk-07-08-27

• array $tables
• array $filter: (array(COLUMN => VALUE))
• boolean $withObjVars
• boolean $debug

• CLIENT::dbGetDataArray() : returns the the data array of a join
• CLI_STAFF::dbGetDataArray() : returns the the data array of a join

dbInsert (line 813)

inserts a new row to the table

• return: returns the autoIncFld ID if exists or 1 on success
• version: pk-03-10-25
• version: pk-03-10-22
• version: pk-04-12-21
• version: pk-06-01-24
• version: pk-07-08-17
• version: pk-08-03-07 linkedTables

• boolean $debug: show debug info

INFA_DBMS_TABLEOBJ::dbInsert()

inserts a new row to the table

• ADDRESS::dbInsert()
• CLIENT::dbInsert() : inserts a new row to the table
• CLI_PROFILE_ENTRY::dbInsert()
• CLI_STAFF::dbInsert()
• TMPL_CHAPTER::dbInsert() : inserts a new row to the table
• CLI_PROFILE::dbInsert() : inserts a new CLI_PROFILES to the database
• CMS_CHAPTER::dbInsert() : inserts a new row to the table
• CMS_CHAPTER_V2::dbInsert() : inserts a new row to the table and checks SORTORDER
• CMS_PROJECT::dbInsert() : gets the sortnumber from the database and calls the parent method
• CMS_CSSCLASS::dbInsert() : inserts a new row to the table
• TMPL_CHAPTER::dbInsert() : inserts a new row to the table
• CLIENT_DEP_TREE_NODE::dbInsert() : inserts a new row to the table if a manager is set the mangers CDEP_ID is set to the new value
• CMS_MENU_NODE::dbInsert() : ensures that LANG_ID is set and sets $this->mySortFld to IFNULL(MAX(".$this->mySortFld."),1)
• MED_CATEGORY_NODE::dbInsert() : inserts a new category and creates the category directory
• PRO_GROUP_NODE::dbInsert() : inserts a new row to the table
• MED_FILE::dbInsert() : inserts a new file
• OCSP_MOD_CONF::dbInsert() : inserts the module with settings and hooks
• PRO_PART::dbInsert() : inserts a new row to the table
• PRO_GROUP::dbInsert() : inserts a new row to the table
• SHOP_ORDER::dbInsert() : inserts a new row to the table
• OCSP_GROUP::dbInsert() : inserts a new row to the table

dbReplace (line 890)

replaces a row in the table

if the object has not been populated (!$this->populateTS) False is returned

• version: pk-03-10-22
• version: pk-07-08-17
• version: pk-07-12-06 $ignorPopulated added

• boolean $debug: show debug info
• boolean $ignorPopulated: (if False the table MUST have been populated)

INFA_DBMS_TABLEOBJ::dbReplace()

replaces a row in the table

• CLIENT::dbReplace() : replaces a row in the table
• CLI_PROFILE_ENTRY::dbReplace() : replaces a row in the table
• CLI_STAFF::dbReplace() : updates change fields an call parent::dbReplace
• TMPL_CHAPTER::dbReplace() : replaces a row in the table
• CLI_PROFILE::dbReplace() : save the profile to db by replacing the row first check if CLP_TABLE is ok
• CMS_CHAPTER::dbReplace() : replaces a row in the table
• CMS_CHAPTER_V2::dbReplace() : replaces a row in the table
• CMS_PROJECT::dbReplace() : replaces the db values and clears cache
• CMS_CSSCLASS::dbReplace() : updates a row
• CMS_CSSSTYLE::dbReplace() : updates the database and clears the cache
• TMPL_CHAPTER::dbReplace() : replaces a row in the table
• CMS_MENU_NODE::dbReplace() : ensures that LANG_ID is set
• PRO_GROUP_NODE::dbReplace() : replaces a row in the table
• OCSP_MOD_CONF::dbReplace() : replaces (update) a module configuration
• OCSP_GROUP::dbReplace() : replaces a row in the table

db_SetKey (line 353)

• string $kName
• mixed $kValue
• boolean $debug: since pk-06-05-28

getClassInclude (line 310)

returns the class source file if $this->classSrcFile is set

add the following code to your class:

• version: pk-08-03-02
• since: pk-07-09-17
• access: public

• boolean $debug

getDBField (line 1264)

returns the value of a db column

NOTE no check of the value is accurate

• version: pk-05-07-14
• version: pk-08-10-14
• version: pk-07-08-22 check if the object is populated
• version: pk-07-10-21 $autoPopulate to avoid enless loops
• access: public

• string $aColumn: (name of the db column and the obj var holding the value of the column)
• boolean $debug
• boolean $autoPopulate: (populate the row if keysAreSet)

getDBVal (line 1759)

returns a field => value array for dbms

use this in cms and dbms elements to get $DBVAL array

overwrite this and add some special values for objects if needed

• version: pk-04-08-10 debug info changed
• version: pk-05-07-14
• version: pk-06-05-21 debugging
• version: pk-07-06-19
• see: dbms

• boolean $setFIELDS: if True $ret['_DBMS_FIELDS'] is filled
• boolean $debug: show debug info?
• boolean $withObjVars: add object var values to the returned array

• : returns a field => value array for dbms

getErrorMsg (line 2072)

• since: pk-05-07-29

• CLI_PROFILE::getErrorMsg() : returns the profile error msg

getForm (line 1629)

replaces dbGetForm and returns a OCSP_FORM

• return: __OCSP_PHPINCPATH__
• version: pk-08-06-26
• version: pk-08-11-01 getFormName() & getFormClassName added
• since: pk-07-08-16
• requires: db/forms/OCSP_FORM.phpclass

• int $mode
• mixed $form: (string) form name (int) form id
• boolean $debug
• $frmClass

• CLIENT::getForm() : replaces dbGetForm and returns a OCSP_FORM
• CLI_PROFILE_ENTRY::getForm() : returns the form
• CMS_CHAPTER::getForm() : replaces dbGetForm and returns a OCSP_FORM
• CMS_PAGE::getForm() : returns the form for the page
• TMPL_CHAPTER_V3::getForm() : replaces dbGetForm and returns a OCSP_FORM
• CMS_MENU_NODE::getForm() : returns the form used for manipulating the node

getFormName (line 1593)

returns the required form name

normaly this function return Null to let $this->getForm decide which form ($this->getMyTable()) to use. In some subclasses it can be useful to overwrite this methode to get a special form

This is also a way to tell ajax reloads to change form. in jOCSP/formRPC.php is checked wether the currently loaded form (from the environment) fits to the forms tableobject if this function returns a value.

• since: pk-08-11-01
• access: public

• : returns the page form name
• CMS_MENU_NODE::getFormName() : returns the required form name

getKeyArr (line 375)

returns the key array an array of all key fields

• since: pk-05-06-23
• access: public

• bolean $debug

• CLI_PROFILE_ENTRY::getKeyArr() : returns the key array an array of all key fields

getObjValArray (line 1480)

returns the object value array

• version: pk-08-06-19
• since: pk-07-08-13

• boolean $debug

getPopulateTs (line 461)

returns the populate timestamp if it returns 0 the object has not been populated which means not that it is empty

• since: pk-03-12-18

hasChanged (line 485)

returns if valChangeTS > populateTS

• since: pk-06-05-28

hasErrors (line 2062)

• since: pk-05-07-29

init (line 250)

initalize the object

• tries to get the object from cache
• if fails load it from db and write it to chache
• set initTS to now

• version: pk-03-10-24
• version: pk-05-07-13
• version: pk-06-05-27

• boolean $debug: version pk-03-10-24
• boolean $noCache: version pk-06-05-27

• CLI_STAFF::init() : set client table to config setting if set
• DBMS_JOINOBJ::init() : initalize the object
• DBMS_SIMPLETREE::init() : sets the table name for DBMS_TABLEOBJ

isPopulated (line 473)

returns if populateTS > 0

• since: pk-04-01-05

populateFromKeys (line 527)

populates the object from a key array NOTE if more columns fit $keys only the first is set

• since: pk-07-08-14

• array $keys
• boolean $debug

populateObjVals (line 680)

populates the Object values

• return: sizeof myObjVals
• version: pk-07-04-16
• since: pk-05-07-13

• boolean $debug

• CMS_CHAPTER_V2::populateObjVals() : merges {$this->colPrevix."FIELDS"} with Object values

saveLinkedRow (line 1187)

saves a linked row due to $cmd

• since: pk-08-03-07
• access: public

• string $table
• array $row
• string $cmd: (_OCSP_DBCMD_*)
• boolean $debug

• CLIENT::saveLinkedRow() : saves a linked row due to $cmd

saveObjVals (line 759)

saves the object values

• version: pk-07-08-18
• since: pk-05-07-14

• string $gDBIDX
• boolean $clearFirst
• boolean $debug

setDBField (line 1321)

sets the value of a object var (DB COLUMN)

NOTE: does not save youe have to call DBMS_TBLOBJ::dbsave() to save the value permanently in the database

• version: pk-05-07-14
• version: pk-07-10-01
• version: pk-05-07-28
• version: pk-06-10-11
• access: public

• string $aField: DB Column Name or Obj Field
• mixed $aValue: the value to set
• boolean $debug: since pk-05-07-28
• boolean $strict: do not use objVals

• ADDRESS::setDBField() : sets column value

setDBFieldIfEmpty (line 1376)

sets the value of an column if it is empty or not set

if you use this method you can check with $this::hasChanged() method if the object values differs from the database value.

• since: pk-06-12-20
• access: public

• string $aField: DB Column Name or Obj Field
• mixed $aValue: the value to set
• boolean $debug: since pk-05-07-28

setDBVal (line 1924)

sets all fields of an array to the objcet

• version: pk-05-10-04
• since: pk-05-08-30

• array $valArr
• boolean $debug

• CMS_TABLEOBJ::setDBVal() : sets all fields of an array to the objcet if $valArr['PEARCACHE_TS'] isset this will become the populateTS
• : sets all fields of an array to the objcet
• CMS_MENU_NODE::setDBVal() : sets all fields of an array to the objcet if $valArr['PEARCACHE_TS'] isset this will become the populateTS

setError (line 2084)

sets an error cmd

• since: pk-05-07-29

• string $errMsg

setMyTable (line 212)

sets the table name an recals init if $this->myTable != $aTablName

• version: pk-06-05-27
• version: pk-07-07-11 removed $gDBIDX param
• since: pk-06-02-09

• string $aTblName
• boolean $debug

setObjValValue (line 1453)

sets an object value value

• version: pk-05-08-26
• todo: type check
• since: pk-05-07-14

• string $key
• string $val
• boolean $debug

setUnChanged (line 510)

clears the changed flag

• since: pk-06-10-24

• boolean $debug

writeDebugInfo (line 2026)

echos the object

• since: pk-04-07-30

• boolean $fullMode

xmlExport (line 2322)

xmlExport of a Table Object

• since:

  sw-05-03-08

  NEED TO BE OVERWRITTEN!!!

• string $xmlfile
• boolean $base64
• boolean $debug

_getDBFields (line 2117)

class method sets $this->myFields

• version: pk-04-12-21
• version: pk-05-07-13
• version: pk-07-04-14
• version: pk-08-03-11
• version: pk-07-06-15
• access: protected

• boolean $debug

• DBMS_JOINOBJ::_getDBFields()