static mixed $dbmsFieldTypeClasses = array() (line 98)

• staticvar: array $dbmsFieldTypeClasses:
• access: protected

static mixed $staticClassVars = array('form_instances') (line 88)

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

OCSP_OBJ::$staticClassVars

int $FRM_DEBUG = 0 (line 425)

• access: protected

boolean $FRM_DISABLEAJAXCHANGEFORM = 0 (line 445)

disable to check the form on ajax relaod

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

boolean $FRM_ISDEFLT = False (line 410)

• access: protected

string $FRM_LAYOUT = "" (line 420)

• access: protected

string $FRM_NAME = "" (line 390)

• access: protected

string $FRM_TABLES = "" (line 395)

• access: protected

array $layoutFields = array() (line 480)

• access: protected

array $loadedUserRights = array() (line 552)

alread loaded userrights from the db

• access: protected

OCSP_FORM_BLOCK $myBlocks = array() (line 315)

• access: protected

OCSP_FORM_DBCONTROLL $myDBControll = NULL (line 333)

• access: protected

array $myDBValues = array() (line 451)

• var: database representation of the form
• access: protected

array $myFormDBCols = array('FRM_ID','FRM_NAME','FRM_TITLE','FRM_CLASS',
'FRM_TABLES','FRM_ISDEFLT','FRM_QUERY','FRM_JOIN',
'FRM_REVISION','FRM_SRCVERSION','FRM_LAYOUT','FRM_DEBUG','FRM_DESC','FRM_LSTGROUPS',
'FRM_DISABLEAJAXCHANGEFORM') (line 457)

• var: (columns of T_DBMS_FORM to use in the object)
• access: protected

int $myInstanceId (line 358)

index in self::instances_byId

• access: protected

array $myTables = array() (line 378)

array with all tables the form uses note Index 0 is considered as master table the first table to load.

if the tables are joined the order of adding to the join depends on the index

the array is populated by exploding $this->FRM_TABLES (,-seperated)

• access: protected

OCSP_FRMVIEW_LIST $myView = NULL (line 321)

• access: protected

mixed $rightsSet = 0 (line 545)

• access: protected

string $tblObj_class = NULL (line 473)

class file of the table object

• access: protected

static clearFieldClassDescCache (line 292)

clears the FieldClassDesc cache

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

• boolean $debug

static factory_from_cacheArr (line 635)

• since: pk-07-10-13
• requires: pcf_templates.phpinc
• access: public

• array $cacheArr
• string $className: (if set overwrite 'FRM_CLASS' in cacheArr )
• boolean $debug

static factory_from_name (line 765)

returns the form object with FRM_NAME= $aName

• access: public

• int $aId
• float $className
• boolean $debug
• boolean $forceNew: (do not check self::instances_byId)
• $aName

static findForm_getHTMLOptionList (line 934)

gets an html option list with all possible forms for $aTable

• return: (html)
• since: pk-08-02-21
• access: public

• string $aTable
• int $selectedForm
• boolean $debug

static getCacheFileName (line 568)

• return: (cache file path)
• version: pk-08-11-03
• since: pk-07-10-13
• access: public

• mixed $frmIdName
• global $debug: array $OCSP_CONF

static getFieldClassDescArr (line 127)

returns all field class descriptions

• access: public

static loadFieldClassDesc (line 214)

loads the field Desc from File cache and sets self::$dbmsFieldClassDesc

• version: pk-08-06-13
• access: public

• boolean $debug

static writeFieldClassDescToCache (line 239)

loads field definition from the db and caches to a file

• access: public

• boolean $debug

addNewBlock (line 2331)

adds a new block to the form and returns the block

• array $blockData
• array $colNames
• boolean $debug

addPassThroughField (line 3258)

adds a pass-through field

• access: public

• string $colName
• mixed $mixValue

ajax_canChangeForm (line 3716)

return if the form can be changed on an relaod

• since: pk-08-11-01

• CMS_PAGE_FORM::ajax_canChangeForm() : return true to check the form on reload

ajax_getObj (line 3693)

• since: pk-07-02-27
• access: public

• boolean $force

castFieldTo (line 2775)

changes the class of a field object

• string $fldKey
• string $className
• boolean $debug

clearErrors (line 3732)

clears all errors

• todo: clear field errors if $fieldsToo

• boolean $fieldsToo
• boolean $debug
• $fieldsTo

createDBColumn (line 2845)

creates the field column in the database

• mixed $filed: (name or object)
• boolean $debug
• &$field

curUserCanDelete (line 3965)

returns if the current user is allowed to open the form readonly

NOTE rights are only checked if a row is found in T_DBMS_FORMRIGHTS

• access: public

• $debug

curUserCanExport (line 3979)

returns if the current user is allowed to open the form readonly

NOTE rights are only checked if a row is found in T_DBMS_FORMRIGHTS

• access: public

• $debug

curUserCanSave (line 3992)

returns if the current user can save the form in the current mode

• boolean $debug

• CMS_CHAPTER_FORM::curUserCanSave() : returns if the current user can save the form in the current mode
• CMS_PAGE_FORM::curUserCanSave() : returns if the current user can save the form in the current mode

delCacheFiles (line 1812)

deletes the form cache files

deleteField (line 2826)

deletes a field NOTE: does not delete the database column of this field NOTE: does not store the form this has to be done outside

• string $fldKey
• int $blockId
• boolean $debug
• return 3: boolean

factory_field (line 2880)

foctory a new field object

• version: pk-08-06-13
• version: pk-08-06-17

• string $fldName
• string $fldClass
• array $dbDesc
• array $fieldValues
• boolean $debug

getAutoIncField (line 2197)

returns the autoincrement field of $tbl

• since: pk-08-01-15

• string $tbl
• boolan $debug

getBlockByName (line 2276)

returns the first block with $blockName as Name

• since: pk-08-01-15

• string $blockName
• boolean $debug

getClassName (line 1137)

overwrite in child classes if get_class does not fit

getControll (line 3073)

alias for $this->getControl()

• deprecated: since pk-08-11-20

getControlObj (line 3110)

instantiates a new class if $this->myControl not type of $contrClass

NOTE the class must exists or have it's code in __FILE__

• string $contrClass
• boolean $debug

getDBObj (line 1027)

if $this->myDBObj is NULL a new connection to either the users db or the global database will be establisched

• global: array $OCSP_OBJ: OCSP_OBJ
• requires: OCSP_DB.phpclass"

• boolean $debug

OCSP_OBJ::getDBObj()

allowed modes are:

getErrors (line 3798)

returns the form errors

• todo: OCSP_FORM::getErrors() only FRM_DATATYPE_STRING implemented now

• boolean $withFields: if True the field errors are also included
• int $returnType
• boolean $debug

getField (line 2721)

returns a field object

• version: pk-08-07-12 (OBJVALS_)

• string $aFldName
• string $aTable: (empty to search in all tables)
• int $aBlockId: (-1 to search in all blocks)
• boolean $debug

• CMS_CHAPTER_FORM::getField() : returns a field object
• CMS_PAGE_FORM::getField() : returns a field object

getFormCmdFields (line 3288)

returns form command fields

commands needed in subclasses to validate submitdata this is used in OCSP_FRMCONTR_FORM::getFormCmdFields()

NOTE: only added if form class != OCSP_FORM

• version: pk-08-06-26
• since: pk-07-12-05

• boolean $debug

• CLI_PROFILE_FORM::getFormCmdFields() : add some values to the forms (hidden) command fields

getHTMLLstFromQuery (line 4050)

returns the html code for list from a query

if $query is empty it is generated with:

NOTE: use getList_SQLFieldLst() in the select statement if you have a LEFT JOIN to get the right fields and values

layout class var used:

• FRMLST_TABLEADD (<table $this->FRMLST_TABLEADD>)
• FRMLST_TRADD (<tr $this->FRMLST_TRADD[($rowNr % 2)] >)
• FRMLST_TDADD (<td $this->FRMLST_TDADD >)

• version: pk-06-01-24
• since: pk-04-12-31

• int $nofRows: return the number of rows processed
• string $query: if empty the query is generated
• array $links
• string $sortLnk
• int $limit
• int $offset
• boolean $debug
• &$nofRows

getKeyFields (line 2168)

returns an array of all primary key's found in the form

the return array has the following structure: array [table][] => &fieldobj

• since: pk-07-09-30

• boolean $debug

getLayoutField (line 2990)

returns a layout field (added into the tag)

list keys:

• FRMLST_TABLEADD
• FRMLST_THEADADD
• FRMLST_THADD
• FRMLST_TRADD_odd
• FRMLST_TRADD_even
• FRMLST_TDADD
• FRMLST_ADDBEFORELINKS
• FRMLST_ROWADD
• FRMLST_LIMIT

• FRMFRM_FORMADD
• FRMFRM_FIELDSETADD
• FRMFRM_TABLEADD

• string $key

getListView (line 3055)

• string $viewClass
• boolean $debug

getMyDBControll (line 1092)

• $debug

getMyJsId (line 1191)

if empty($this->my_jsId) it is set

• return: (the js id of the form)
• version: pk-08-09-23

getNofFields (line 2665)

returns the number of fields in the form

• int $mode
• boolean $debug

getPassThroughFields (line 3268)

returns the pass-through fields array

• access: public

getReloadUri (line 3217)

returns the relaod url

• since: pk-07-08-21

• boolean $debug

getTables (line 2065)

• access: public

getTblObjInc (line 1339)

returns the include file for the table object class

• boolean $debug

get_listGroups (line 3654)

• since: pk-07-10-16

hideField (line 2915)

set a field hidden

• since: pk-04-03-08

• string $aFldName
• string $aTable
• string $scope: @see DBMS_FIELD::setHidden()
• int $aBlockId
• boolean $debug

initCheckSubmitData (line 3308)

• abstract: for child objects to init on checkSubmitData

• array $frmSettings
• string $dataArrName
• array $frmValues
• boolean $debug

• CLI_PROFILE_FORM::initCheckSubmitData()

loadBlocksFromDb (line 2585)

loads the form blocks from the database into $this::myBlocks

• todo: OCSP_FORM::loadBlocksFromDb() only Class OCSP_FORM_BLOCK is implemented
• access: protected

• boolean $debug

loadFromDb (line 1603)

returns a new form form the database

• global: $OCSP_OBJ $OCSP_OBJ:
• todo: load revision
• access: public

• int $aId
• string $aName
• boolean $debug
• float $revision

prepareList (line 3522)

settings:

• (OCSP_FRMVIEW_LIST) VIEWOBJ
• (string) VIEWCLASS

• (OCSP_FRMCONTR_LIST) CONTROBJ
• (string) CONTRCLASS
• (string) LISTQUERY
• (array) FILTER
• (int) OFFSET
• (int) LIMIT

• (array) LSTGROUPS
• (string) ORDERBY

• (array) CONTRROWCMD
• (array) CONTRBUTTONS (['C'] => command ['I'] => icon tag)
• (array) FOOTERCMDS (['name'] => html)

• return: (number of rows to show)
• version: pk-08-01-22
• version: pk-08-01-28 (CONTRROWCMD,CONTRBUTTONS added)

• array $settings: (array of settings to list view and controll)
• boolean $debug

removeTable (line 2133)

removes a table an all table columns from the form

• string $aTable
• boolean $debug

setAjaxDisableChangeForm (line 1419)

• access: public

• $to

setControll (line 3201)

alias for setControl

• deprecated: since pk-08-12-03
• access: public

• OCSP_FRMCONTR $aControl
• boolean $sync
• boolean $debug
• &$aControl

setError (line 3759)

adds an error to this::errors

• mixed $aError: either an array with LABEL and MSG values or only the message if empty only $this->errors['ERROR'] is set to True
• string $fld
• boolean $debug

setId (line 1155)

• since: pk-08-01-30

• int $aId

setMasterTable (line 2045)

• $aTbl

setMyDBRow (line 1483)

• array $aRow
• boolean $debug

setMyTblObj (line 1248)

links a table object with the form

• DBMS_TABLE_OBJ $tblObj
• boolean $debug
• &$tblObj

• CLI_PROFILE_FORM::setMyTblObj()

setSubmitAction (line 1413)

sets a main cmmonad of the form

used keywords:

• js: execute a java script
• default: open url

• access: public

• int $mode
• string $uri
• string $type: ([ACTION|NEXT|RELOAD])

setTblObjFromSubmitData (line 3328)

sets the tableobject class and include from $dataArr and tries to instantiate by calling $this->getMyTblObj

if class is set in $dataArr and it could not be instantiated False is returned else True is returned

• since: pk-07-12-05

• array $dataArr: (normaly $_POST)
• boolean $debug
• &$dataArr

• CLI_PROFILE_FORM::setTblObjFromSubmitData() : sets the tableobject class and include from $dataArr and tries to instantiate by calling $this->getMyTblObj
• CMS_CHAPTER_FORM::setTblObjFromSubmitData()
• CMS_MENU_FORM::setTblObjFromSubmitData() : sets the tableobject class and include from $dataArr and tries to instantiate by calling $this->getMyTblObj
• CMS_PAGE_FORM::setTblObjFromSubmitData() : sets the tableobject class and include from $dataArr and tries to instantiate by calling $this->getMyTblObj

storeToDb (line 1676)

stores a form object and all depending objects (blocks and fields) to the database

• access: public

• boolean $debug

writeToFileCache (line 1928)

writes the object to the file cache

• global: $OCSP_CONF $OCSP_CONF:
• requires: pcf_directory.phpinc
• access: protected

• boolean $debug