Implements interfaces:

• INFA_CLI_PROFILE

class to handel CLI_PROFILES

• author: Peter Krebs <pitlinz@users.sourceforge.net>
• version: $Id:$
• todo: errorhandling like DBMS_FORM
• project: Open CSP-Management
• license: GNU Public License

Located in /client/CLI_PROFILE.phpclass (line 45)

OCSP_OBJ
   |
   --DBMS_TABLEOBJ
      |
      --CMS_TABLEOBJ
         |
         --CLI_PROFILE

static mixed $loadedProfiles = array() (line 66)

unit of work

• staticvar: array $loadedProfiles:
• access: protected

mixed $colPrefix = "CLP_" (line 140)

• staticvar: string $colPrefix: prefix of the table col names

int $FKValue (line 151)

• var: user/client/staff id
• since: pk-05-03-08

mixed $myClassName = "CLI_PROFILE" (line 145)

• staticvar: string $myClassName: name of the class to use in eval statements

string $myClassSrcFile = __FILE__ (line 157)

• var: source file of the class
• since: pk-05-08-08

mixed $myTable = "T_CLI_PROFILES" (line 135)

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

---

Redefinition of:

DBMS_TABLEOBJ::$myTable

NOT FINAL !!!!!

Inherited Variables

Inherited from CMS_TABLEOBJ

CMS_TABLEOBJ::$cms_conf_data
CMS_TABLEOBJ::$cms_menu_types
CMS_TABLEOBJ::$cms_pageTmpl_types
CMS_TABLEOBJ::$cms_page_types
CMS_TABLEOBJ::$currentMenu
CMS_TABLEOBJ::$currentPage
CMS_TABLEOBJ::$currentProj
CMS_TABLEOBJ::$myCmsCache
CMS_TABLEOBJ::$myMenuIdCol
CMS_TABLEOBJ::$myMenuIdGetName
CMS_TABLEOBJ::$myMenuNode
CMS_TABLEOBJ::$myPageIdCol
CMS_TABLEOBJ::$myPageIdGetName
CMS_TABLEOBJ::$myPageObj
CMS_TABLEOBJ::$myProjIdCol
CMS_TABLEOBJ::$myProjIdGetName
CMS_TABLEOBJ::$myProjObj

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 factory_entryObj (line 208)

• access: public

void factory_entryObj ( $aId,  $keyId, [ $clpIdx = 0], [ $debug = False])

• $aId
• $keyId
• $clpIdx
• $debug

static factory_fromId (line 203)

returns a profile object

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

CLI_PROFILE factory_fromId (int $aId, [boolean $debug = False])

• int $aId
• boolean $debug

static getInstance (line 77)

returns the unit of work instance

• access: public

CLI_PROFILE &getInstance (int $aId)

• int $aId

static isInstanced (line 101)

returns if we already have an instance of profile $aId

• since: pk-09-01-02
• access: public

boolean isInstanced (int $aId)

• int $aId

static setInstance (line 118)

sets an instance

• since: pk-09-01-02
• access: public

void setInstance ( &$aProfile, CLI_PROFILE $aProfile)

• CLI_PROFILE $aProfile
• &$aProfile

Constructor CLI_PROFILE (line 180)

creates and initialize the object

if $aId the object is populate and all other params are replaced with the database values

• return: is it populated ?
• version: pk-04-10-08

bool CLI_PROFILE ([int $projId = 0], [int $aId = 0], [int $grpId = 0], [ $debug = False], int $pagId)

• int $projId
• int $aId: if > 0 the object is populated
• int $grpId
• int $pagId
• $debug

checkEntryRowArr (line 979)

checks a array by including $GLOBALS['PROJECT']['PATH'].$this->CLP_ENTRYCHKIN

returns $retVal which can be set in the include (default: TRUE)

boolean checkEntryRowArr (array &$dbVal, [boolean $debug = False])

• array &$dbVal
• boolean $debug

checkProfileIdInEntryQuery (line 629)

returns if for not multiple profiles the CLP_ID should be checked in the table or not.

• since: pk-06-10-11

boolean checkProfileIdInEntryQuery ()

clearErrors (line 368)

resets profile errors

• since: pk-05-02-24

void clearErrors ()

---

Redefinition of:

DBMS_TABLEOBJ::clearErrors()

clears all errors

createEntryTbl (line 549)

creates a table for CLI_PROFILES entries

• version: pk-04-10-08
• todo: col types are hardcoded mySQL -> change

boolean createEntryTbl ([boolean $debug = False], string $gDBIDX)

• string $gDBIDX: Index of $GLOBALS to the db object
• boolean $debug: show debug info

dbGetProfileForm (line 772)

• deprecated: since ???

void &dbGetProfileForm ( $frmName,  $i_frmMode, [ $debug = False])

• $frmName
• $i_frmMode
• $debug

dbInsert (line 394)

inserts a new CLI_PROFILES to the database

• calls parent::dbInsert()
• creates profile table

void dbInsert ([boolean $debug = False])

• boolean $debug: show debug info

---

Redefinition of:

DBMS_TABLEOBJ::dbInsert()

inserts a new row to the table

dbReplace (line 423)

save the profile to db by replacing the row first check if CLP_TABLE is ok

• since: pk-04-10-08

void dbReplace ([boolean $debug = False], [boolean $ignorPopulated = False])

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

---

Redefinition of:

DBMS_TABLEOBJ::dbReplace()

replaces a row in the table

deleteEntryRow (line 1150)

deletes a row array

• version: pk-05-09-23
• since: pk-05-03-22

boolean deleteEntryRow (int $keyVal, [int $idx = 0], [boolean $debug = False])

• int $keyVal
• int $idx
• boolean $debug

getClassName (line 216)

void getClassName ()

getEmptyErrMsg (line 354)

returns the profile empty error msg

• since: pk-04-10-12

string getEmptyErrMsg ()

getEntryForm (line 790)

returns a ponter to a formObj to use with the entry

• version: pk-06-10-22
• version: pk-06-12-21

CLI_PROFILE_FORM &getEntryForm ([int $mode = FRM_MODE_READONLY], [string $frmName = ""], [boolean $debug = False])

• int $mode
• string $frmName
• boolean $debug

getEntryObj (line 711)

CLI_PROFILE_ENTRY getEntryObj ([ $key = NULL], [int $idx = 0], [boolean $debug = False], int $aKey)

• int $aKey
• int $idx
• boolean $debug
• $key

getEntryRow (line 675)

returns a (the first) entry row where keytable is $key and CLP_IDX is $idx if $key or $idx are 0 the are not included in the where useses $this->myDBObj->quickQuery()

• version: pk-06-02-23
• version: pk-05-11-23
• version: pk-06-10-11
• version: pk-06-10-24
• version: pk-07-01-12 redesign of $key $idx checks
• since: pk-05-03-15

array getEntryRow ([int $key = 0], [int $idx = 0], [boolean $debug = False])

• int $key
• int $idx
• boolean $debug

getEntryRowArray (line 1271)

returns an array of all entry rows where keytable key fit

• since: pk-05-09-23

void getEntryRowArray ([int $key = 0], [boolean $debug = False])

• int $key
• boolean $debug

getEntryTbl (line 597)

returns the entry table name

• since: pk-04-08-05

string getEntryTbl ()

getEntryTblColumns (line 643)

returns an array with the columns of the entry table in case of an error an empty array is returned

• since: pk-05-02-26

array getEntryTblColumns ([ $debug = False])

• $debug

getEntryTblDesc (line 610)

returns the table desc of entry table

• since: pk-04-08-31

array getEntryTblDesc ([ $debug = False])

• $debug

getEntryTblFormIdName (line 744)

• return: (the form id or the entry table name if form id is not set)

mixed getEntryTblFormIdName (int $mode, [boolean $debug = False])

• int $mode
• boolean $debug

getErrorMsg (line 381)

returns the profile error msg

• since: pk-05-02-24

string getErrorMsg ([string $sep = "<br />"])

• string $sep: is planed to

---

Redefinition of:

DBMS_TABLEOBJ::getErrorMsg()

getETblJoinSelStmt (line 1232)

returns the select statement for a join of Entrytable and Keytable

• since: pk-05-03-15

string getETblJoinSelStmt ([array $keyTblKeys = NULL], [array $entrTblKeys = NULL], [boolean $debug = False])

• array $keyTblKeys
• array $entrTblKeys
• boolean $debug

getForeignKey (line 318)

returns the foreign key to the foreign table

• version: pk-06-10-23 (intval)
• since: pk-05-03-08

int getForeignKey ()

getGrpId (line 237)

returns the grp id

• since: pk-05-02-24

int getGrpId ()

getId (line 225)

returns the id

int getId ()

getKeyColName (line 454)

returns the key column name

• since: pk-05-09-23

string getKeyColName ()

getKeyTable (line 328)

• since: pk-05-08-24

string getKeyTable ()

getNumberOfEntries (line 1306)

returns the number of entries for a key with state

• since: pk-06-12-29

int getNumberOfEntries ([int $key = 0], [int $state = -1], [boolean $debug = False])

• int $key
• int $state: use -1 to ignore it
• boolean $debug

getSortOrder (line 1412)

int getSortOrder ()

getTitle (line 246)

returns the Title

string getTitle ()

insertEntryRow (line 1013)

inserts an Row array into the entry table

• version: pk-04-11-17
• version: pk-05-11-04
• since: pk-04-10-13

boolean insertEntryRow (array $dbVal, [boolean $debug = False])

• array $dbVal
• boolean $debug

insertPOSTEntry (line 848)

inserts a posted form array into the content table

• version: pk-05-03-03
• version: pk-05-11-04
• version: pk-06-10-10

bool insertPOSTEntry ( &$frmObj, array $DBVAL, [string $arrName = "DBVAL"], [boolean $noEmptyCheck = False], [boolean $debug = False], CLI_PROFILE_FORM $frmObj)

• CLI_PROFILE_FORM $frmObj
• array $DBVAL
• string $arrName
• boolean $noEmptyCheck
• boolean $debug
• &$frmObj

isMultiple (line 258)

returns if a profile allows multiple entries

• since: pk-04-10-11

boolean isMultiple ()

maxEntries (line 283)

• version: pk-06-10-24
• since: pk-05-08-21

int maxEntries ()

postArrHasData (line 931)

returns if a profile post has data postVals are not null and not equal to form defaults

• version: pk-05-03-03
• version: pk-05-08-22 param no defaultchk added
• version: pk-05-11-08 debug info
• since: pk-05-02-26

boolen postArrHasData ( &$frmObj, array $postVals, [boolean $debug = False], [boolean $noDefaultChk = False], DBMS_FORM $frmObj)

• DBMS_FORM $frmObj
• array $postVals
• boolean $debug
• boolean $noDefaultChk
• &$frmObj

replaceAllEntries (line 1188)

replaces all entries of a client/user/staff

• return: number of rows inserted
• since: pk-05-03-08

int replaceAllEntries ( $fkVal, int $dataArray, [boolean $debug = False], int $fkval)

• int $fkval: foreign key
• int $dataArray: array of rows
• boolean $debug
• $fkVal

requiredNoR (line 272)

returns the number of entry rows required for the profile. This is used to create NULL Errormessages

• since: pk-04-10-12

int requiredNoR ()

setForeignKey (line 304)

sets the foreign key to the foreign table

• version: pk-06-10-23 (intval)
• since: pk-05-03-08

void setForeignKey (int $val)

• int $val

sort_MoveDown (line 1473)

moves the profile down (increase sortorder) note: autosaves sortorder

• since: pk-05-08-03

void sort_MoveDown ([boolean $debug = False])

• boolean $debug

sort_MoveToPos (line 1528)

moves the profile to a position note: autosaves sortorder

if $postion > last postion the object will be moved to the end

• since: pk-05-08-08

int sort_MoveToPos (int $position, [boolean $debug = False])

• int $position
• boolean $debug

sort_MoveUp (line 1427)

moves the profile up (decrease sortorder) note autosaves sortorder

• since: pk-05-08-08

void sort_MoveUp ([boolean $debug = False])

• boolean $debug

updateEntryRow (line 1073)

updates an Row array into the entry table

• version: pk-04-11-17
• version: pk-05-11-04
• since: pk-04-10-15

boolean updateEntryRow (array $dbVal, [boolean $addNew = TRUE], [boolean $debug = False])

• array $dbVal
• boolean $addNew
• boolean $debug

updatePOSTEntry (line 908)

updates a posted form array into the content table

• version: pk-05-03-03

bool updatePOSTEntry ( &$frmObj, array $DBVAL, [string $arrName = "DBVAL"], [boolean $noEmptyCheck = False], [boolean $debug = False], CLI_PROFILE_FORM $frmObj)

• CLI_PROFILE_FORM $frmObj
• array $DBVAL
• string $arrName
• boolean $noEmptyCheck
• boolean $debug
• &$frmObj

useInRegister (line 337)

• since: pk-07-01-11

boolean useInRegister ()

userCanEdit (line 1397)

void userCanEdit ([ $debug = False])

• $debug

userCanInsert (line 1368)

void userCanInsert ([ $debug = False])

• $debug

userCanShow (line 1341)

returns if the current user is allowed to show the profile

• since: pk-07-01-11

boolean userCanShow ([boolean $debug = False])

• boolean $debug

verifyEntryTbl (line 472)

checks if a $this->getDBField('CLP_TABLE') is a profile table Column CLP_ID must be AUTO_INCREMENT all other columns are added if not exists

• since: pk-04-10-08

boolean verifyEntryTbl ([boolean $debug = False])

• boolean $debug

Inherited Methods

Inherited From CMS_TABLEOBJ

CMS_TABLEOBJ::checkMenuNodeProject()
CMS_TABLEOBJ::cmsCacheIsUsable()
CMS_TABLEOBJ::factoryCurrentElements()
CMS_TABLEOBJ::getCMSConf()
CMS_TABLEOBJ::getCmsConfArr()
CMS_TABLEOBJ::getLangId()
CMS_TABLEOBJ::getMenId()
CMS_TABLEOBJ::getMenLinkUrl()
CMS_TABLEOBJ::getMenuIdColName()
CMS_TABLEOBJ::getMenuIdGetName()
CMS_TABLEOBJ::getMyMenuNode()
CMS_TABLEOBJ::getMyPageObj()
CMS_TABLEOBJ::getMyProject()
CMS_TABLEOBJ::getNextMenuId()
CMS_TABLEOBJ::getPageId()
CMS_TABLEOBJ::getPageIdColName()
CMS_TABLEOBJ::getPageIdGetName()
CMS_TABLEOBJ::getPageSortColName()
CMS_TABLEOBJ::getPageTable()
CMS_TABLEOBJ::getPrevMenuId()
CMS_TABLEOBJ::getProjId()
CMS_TABLEOBJ::getProjIdColName()
CMS_TABLEOBJ::getProjIdGetName()
CMS_TABLEOBJ::get_currentMenu()
CMS_TABLEOBJ::get_currentPage()
CMS_TABLEOBJ::get_currentProj()
CMS_TABLEOBJ::menuType_clearCache()
CMS_TABLEOBJ::menuType_getClassSrc()
CMS_TABLEOBJ::menuType_populate()
CMS_TABLEOBJ::menuType_requireClass()
CMS_TABLEOBJ::pageTmplType_getClassSrc()
CMS_TABLEOBJ::pageTmplType_populate()
CMS_TABLEOBJ::pageTmplType_requireClass()
CMS_TABLEOBJ::pageType_getClassSrc()
CMS_TABLEOBJ::pageType_getList()
CMS_TABLEOBJ::pageType_getTmplClassName()
CMS_TABLEOBJ::pageType_populate()
CMS_TABLEOBJ::pageType_requireClass()
CMS_TABLEOBJ::setCmsCacheArr()
CMS_TABLEOBJ::setDBVal()
CMS_TABLEOBJ::setLangId()
CMS_TABLEOBJ::setMenId()
CMS_TABLEOBJ::setMyMenuNode()
CMS_TABLEOBJ::setMyPageObj()
CMS_TABLEOBJ::setMyProject()
CMS_TABLEOBJ::setPageId()
CMS_TABLEOBJ::setProjId()
CMS_TABLEOBJ::set_currentMenu()
CMS_TABLEOBJ::set_currentPage()
CMS_TABLEOBJ::set_currentProj()

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 53)

Inherited Constants

Inherited from DBMS_TABLEOBJ

DBMS_TABLEOBJ::CLASS_SRC_FILE

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE