boolean $debugInsert = FALSE (line 183)

• since: pk-05-03-23

boolean $debugUpdate = FALSE (line 188)

• since: pk-05-03-23

longstring $frmDesc = NULL (line 84)

• var: Beschreibungstext

array $frmFields = array() (line 100)

• var: array of field objects DBMS_FIELD or child classes

array $frmJoin = array() (line 110)

• var: array of identifing foreign key COLUMNS key is the DB column name value is an array of DB columns (TABLENAME.COLNAME)

string $FRMLST_THADD = "class=\"lstHeader\"" (line 177)

• var: list header th add tag
• since: pk-05-03-16

int $frmMode (line 219)

show mode of the form

• since: pk-05-11-04

string $frmRevision = 1 (line 80)

• var: fore future use

array $frmTables = array() (line 88)

• var: array with db tablenames used in the form

string $gDBIDX = "USRDB" (line 163)

• var: $GLOBALS[] index of db object
• deprecated: since pk-07-06-28
• since: pk-05-02-17

array $HTMLFORM_button_src = array() (line 156)

• var: definition
• todo: add to dbms admin to customize buttons per form
• since: pk-05-02-16

boolean $isTblDefault = FALSE (line 92)

• var: the form is the default form for the one and only table it uses

array $layoutFields = array() (line 199)

• since: pk-05-04-18

AJAX_FORM $myAjaxObj = NULL (line 277)

the ajax object for the form NOTE: the class source is not automaticaly implemented

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

string $myDBMS_TABLEOBJ_class = "" (line 149)

• var: table object class
• since: pk-05-01-11

OCSP_DB $myDBObj = NULL (line 170)

• since: pk-07-06-28
• access: protected

Constructor DBMS_FORM (line 286)

• int $aId: FRM_ID in the database if !0 the form is loaded from the database
• boolean $debug: since pk-05-01-12

addField (line 1560)

adds a new field and get the class out of type if the class could not derived from $GLOBALS['DBMS_FIELD_CLASSES'][$type] DBMS_FIELD is used

• version: pk-05-07-14

• string $key: column name
• string $type: column db type
• array $dbDesc
• string $label
• string $tbl
• boolean $debug

addNoDbClassField (line 1597)

• $class
• $key
• $label
• $tbl
• $debug

addNoDBFieldObj (line 1647)

adds a field object to the form

• return: pointer to the copy of the field inserted to the form
• version: pk-05-02-17

• DBMS_FIELD $field
• boolean $debug

addTable (line 1870)

adds a table to the form

• version: pk-05-02-22
• version: pk-06-01-11

• string $aTable: name of the tablename
• boolean $isDefaultFrm: the form is default for the table
• boolean $debug: since pk-05-02-22

ajax_getObj (line 5144)

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

checkForNVL (line 3432)

checks if all required (NOT NULL FIELDS) are set

• return: TRUE if all fields are set else FALSE
• version: pk-03-12-13 getValue instead of slashedValue
• version: pk-04-08-03 use $obj->allow NULL

• array $postArr: Array with values
• string $table: Name of the table if empty all tabels are checked
• string $arrName: Name of the global data array (${$arrName})
• boolean $debug: show debug information

clearCache (line 1038)

removes the cache files of the form

• version: pk-06-04-23

• boolean $clear_tblcache

countListCols (line 4075)

countListCols

returns the number of cols the list table has

• version: pk-05-03-17
• version: pk-05-07-05

• array $links
• array $fields

createDBColumn (line 1667)

creates a db column out of a field

• version: pk-06-04-23 clearCache added
• since: pk-06-01-11

• string $fldName
• bool $debug

disableField (line 2371)

disables a field in a FRM_MODE_NEW or FRM_MODE_EDIT if (mode == -1) FRM_MODE_NEW and FRM_MODE_EDIT are used

• version: pk-05-07-21
• since: pk-05-07-19

• string $fldName
• int $mode
• string $tbl
• boolean $debug

en_disAbleField (line 2308)

disables or enables a field in a FRM_MODE_NEW or FRM_MODE_EDIT if (mode == -1) FRM_MODE_NEW and FRM_MODE_EDIT are used

• since: pk-05-07-21

• boolean $enabled
• string $fldName
• int $mode
• string $tbl
• boolean $debug

fieldLst_FromTxt (line 634)

generates frmFields out of a string generated with DBMS_FORM::db_setFieldLst

• return: TRUE if succeed
• version: pk-05-07-14
• since: pk-04-10-05

• string $dbVal
• boolean $debug
• $serTxt

generateDBKey (line 1418)

transform a key to a dbusable column name (only letters, numbers and underscore)

• return: since pk-04-01-11

• string $key

getAutoIncFields (line 2269)

returns an array with all auto_inc fields

• since: pk-06-01-24

• boolean $debug

getCSVHeadLine (line 4815)

returns the csv header line (column names)

• array $row
• char $fldSep: field seperator
• char $txtSep: string seperator
• boolean $allFields: check exportCSV is set in the field
• boolean $debug

getDBObj (line 357)

returns the db ojbect of the form and ensures the db object is connected

• since: pk-07-06-28
• requires: __OCSP_PHPINCPATH__."db/OCSP_DB.phpclass"
• access: public

• boolean $debug

getDebugMode (line 476)

• version:

  pk-06-01-03

  *

• since: pk-04-07-23

• int $mode

getErrorArr (line 4013)

returns the error array

• since: pk-06-03-06

getField (line 2127)

returns a pointer to a field object

• version: pk-07-02-27
• since: pk-03-12-17

• string $name: (COLUMN) name of the field or the field key (table.name) where $table is empty
• string $table: table name the field belongs to if empty fields are checked for name fit
• boolean $debug: show debug info

getFrmMode (line 496)

• since: pk-05-11-04

getHTMLFormButtons (line 3186)

returns the html code for the form buttons row (colspan=2)

beside the method parameters the HTMLFORM object:

• HTMLFORM_URL_action
• HTMLFORM_URL_back
• HTMLFORM_URL_next
• HTMLFORM_URL_reload
• FRMADDBUTTONS html code to add in the button line

button images are derived from $this->HTMLFORM_button_src[] array

in read only mode if userCanEdit editbutton is added link is $this::FRMEDITURL or $this::HTMLFORM_URL_reload?FRMCMD=EDIT if userCanDelete delete button is added only if not emtpy $this::FRMDELETEURL

• version: pk-05-12-14
• version: pk-06-01-09
• version: pk-06-02-13 class=\"button\" added to img-tages
• version: pk-06-09-11 remove _DBMS_FIELDS from MD5DELVALKEY
• since: pk-05-03-22

• int $mode
• string $arrName
• boolean $debug

getHTMLFormHiddenFields (line 3072)

returns the html code for the hidden form fields

beside the method parameters the HTMLFORM object:

• HTMLFORM_mode
• HTMLFORM_URL_action
• HTMLFORM_URL_back
• HTMLFORM_URL_next
• HTMLFORM_URL_reload

• version: pk-05-09-13
• version: pk-06-09-11 FRMRELOADFLD added
• since: pk-05-03-22

• string $arrName
• boolean $debug

getHTMLFormStatement (line 3024)

returns the html form statement

• version: pk-07-01-18
• since: pk-06-02-06

getHTMLLstFromQuery (line 4778)

• &$nofRows
• $query
• $links
• $sortLnk
• $limit
• $offset
• $debug

getId (line 463)

returns the name of the form

• return: ID of the form
• version: pk-03-10-22

getInsertValues (line 3874)

generates a string with comma seperated slashed field values to use in an insert statement together with DMBS_FORM::getInsertCols()

example:

• array $postArr: array of fields posted by the form
• string &$cmd: the return string
• string $table: name of the table if set only oolumns of $table are added
• boolean $debug
• $arrName

getKeyArray (line 1985)

returns the key array

• boolean $nameToIndex: set the array index to the column name
• boolean $withoutTable: don't use table names in array index (see the TABLES field in value array)

getListColLabelArr (line 4671)

returns an array with key=column name and value = label of the form

• since: pk-05-07-06

• boolean $debug

getListRow (line 4395)

returns the htmlCode for a list row

layout class var used:

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

if $links['EDIT'] isset each data colum is link to the url if the link key == fldname the link is added to the field

• version: pk-05-07-08
• version: pk-05-07-05 $this->lstShowRowNr
• version: pk-05-04-13 anchor added
• version: pk-05-10-06 object values added
• version: pk-05-11-15 button cols width 20 added
• version: pk-06-10-20 linking of the column
• version: pk-06-09-08 $rowNr call by reference
• version: pk-06-03-02 [GROUPID] added
• todo: check edit link && check column links
• since: pk-04-12-30

• array $row
• int $rowNr
• array $links
• boolean $debug
• &$rowNr

• DBMS_FORMAJAX::getListRow()

getName (line 411)

returns the name of the form

• return: unique name of the form

getObjectVar (line 304)

returns the value of an object variable

• since: pk-06-07-27

• string $varName

getRowObjValue (line 4321)

returns an object value for a row

• global: $OCSP_OBJ $OCSP_OBJ:
• since: pk-05-10-06

• DBMS_FIELD $fldObj
• array $row
• boolean $debug
• &$fldObj

getSearchWhere (line 4909)

generates a where statement for search

• version: pk-05-08-11
• version: pk-06-01-25 $alwaysRetWhere added
• version: pk-07-01-09 skip filds with no db

• array $postArr
• boolean $debug
• boolean $alwaysRetWhere: if true return WHERE 1=1 if no values found

getTableList (line 1972)

returns the table list

• since: pk-04-07-28

getTabLinkArray (line 3400)

returns an array with links to use in a tab NOTE templates are not parsed

• since: pk-06-09-12

• int $mode
• boolean $debug

getUpdateValues (line 3487)

generates a sql update statement key = value pares NOTE $cmd call by reference!!

as this only APPENDS key=value pares to seperated with a "," to the command you have to take care for a valid sql statement

ATTANTION: the , is only set between key=value

example:

• return: TRUE

• array $postArr: array with key=>value
• string &$cmd: IN-OUT first part of the sql statement includeing key word SET
• string $table: use only this table if set
• string $arrName: name of the global key=>value (${$arrName})
• boolean $debug: show debug option

getWhereValues (line 3743)

appends the values set in postArr to $cmd to use in SQL Where

$cmd .= [AND] DBMS_FIELD::getAssignment()

• array $postArr
• string $cmd
• string $table
• string $arrName
• boolean $debug
• &$cmd

get_gDBIDX (line 341)

gets gDBIDX

• deprecated: since pk-07-06-28
• since: pk-05-02-17

hasSortFld (line 1433)

returns if the form has a sortcolumn (DBMS_FIELD_ORDERNR)

• since: pk-06-01-25

• boolean $withArrowOnly
• boolean $debug

hideField (line 2387)

set a field hidden

• since: pk-04-03-08

• string $fldName
• string $tbl
• boolean $debug

loadFromDb (line 995)

loads the form form the database

returns true if a row with $this->id is fetched from the db NOTE: table columns are hard coded changes to the database table can create errors

• return: succeed?
• version: pk-04-07-28
• version: pk-05-07-14

• $debug

mergeFormFields (line 1069)

merges the fields of an other form to $this if ($prepend) is true the fields will be prepended else appended to the fieldlist

• since: pk-06-01-24

• DBMS_FORM $frmMerge
• boolean $prepend
• boolean $debug
• &$frmMerge

p_getListRowLink (line 4110)

returns the link url for a row

$link is array with keys:

• URL template of the url
• CHECKFLDS array of rows => values which have to fit to link

• version: pk-06-01-09

• array $link
• array $row
• int $rowNr
• boolean $debug

reloadCheck (line 2592)

check if the form is relaoded and we have to use the posted values instead of $aktRow if $aktRow is not an array the form default values are used

• version: pk-05-11-23
• version: pk-05-11-17 debug infos
• version: pk-05-11-25 debug info
• version: pk-05-11-29 bugfix
• version: pk-07-02-28
• version: pk-06-10-25 bugfix regex http? -> https?
• since: pk-05-08-08

• array $aktRow
• boolean $debug
• boolean $pArrName

removeTableFields (line 1925)

removes all fields of a Table

• since: pk-04-07-30

• string $aTable
• boolean $debug

setDBRow (line 787)

sets the object values from a data array

• version: pk-05-03-23
• version: pk-05-08-25
• since: pk-04-10-07

• array $dbVal
• boolean $asPopulated: not used
• boolean $debug

setErrorArr (line 4026)

sets the error array

• since: pk-06-03-06

• array $errArr
• boolean $merge

setFldFrmObj (line 1777)

sets myForm in each field

• since: pk-05-09-14

• boolean $debug

setHTMLFORM_BtnSource (line 2919)

sets the button array

• version: pk-05-08-08 png -> gif
• since: pk-05-03-22

• $debug

setHTMLName (line 441)

sets the name of the form in the html form

<form name="....">

• since: pk-05-09-16

• string $aName

setObjectVar (line 318)

sets the value of an object variable

• since: pk-06-09-14

• string $varName
• mixed $value

showField (line 2445)

set a field not hidden

• since: pk-04-10-11

• string $fldName
• string $tbl
• boolean $debug

storeToDb (line 907)

stores a form object to database table T_DBMS_FORM

uses $GLOBALS['USRDB'] as database object calls

• version: pk-04-10-07
• version: pk-05-01-13 update fields after insert
• version: pk-05-07-11 T_DBMS_FORMFIELDS added
• version: pk-07-06-10 FRM_CLASS added
• version: pk-08-06-03

• boolean $debug

updateFields (line 1734)

checks if the table has changed

• version: pk-06-08-02 hide new fields by default

• boolean $debug

userCanEdit (line 1210)

checks if a user is allowed to edit (update) the data

• since: pk-05-02-15

• int $usrId: the user id if (!isset $GLOBALS['USER']->getId() is used)
• boolean $debug

userCanInsert (line 1226)

checks if a user is allowed to add (insert) new data

• since: pk-05-03-17

• int $usrId: the user id if (!isset $GLOBALS['USER']->getId() is used)
• boolean $debug

userCanShow (line 1259)

checks if a user is allowed to show the data

• since: pk-05-03-17

• int $usrId: the user id if (!isset $GLOBALS['USER']->getId() is used)
• boolean $debug

writeErros (line 3917)

echos the form errors

• boolean $withLabel

writeListRow (line 4192)

echos a html table row <tr> ... </tr> for a row

NOTE: sets the global $FORMS_LISTROW only use this global var in function called within this function it is used in field objects to access values of other fields with global ${$arrName}

link array creates a <a ></a> HTML code with the folowing attributes (if array links[attrib] ! empty)

• TARGET target=".."
• ACLASS class=".."
• ASTYLE style=".."
• ATAGADD additional tags added as is
• URL used in p_getListRowLink DBMS_FORM::p_getListRowLink
• CHECKFLDS used in p_getListRowLink DBMS_FORM::p_getListRowLink
• IMG a button img (tag or only source) both are handeled
  1.                  if (stristr($val['IMG'],"src=")) {
  2.                      echo "<img ".$val['IMG'].">";   // new style by gaisi
  3.                   } else {
  4.                       echo "<img src=\"".$val['IMG']."\" alt=\"".$val['TEXT']."\" border=\"0\">";
  5.                   }
• TEXT text to show if no IMG or alt of the image

if $links['EDIT'] isset each data colum is link to the url

• version: pk-03-12-12
• version: pk-05-07-05 $this->lstShowRowNr
• version: pk-05-07-08 $val->lstTDAdd added
• deprecated: since pk-07-01-10

• array $row: array of row falues wiht col names as index
• int $rowNr: Counter for the row (added to links)
• array $links: array of link arrays to add in the button
• array $fields: $this->getFieldArr(TRUE) to not call the function for every row
• string $trTag: HTML-Code to append in <tr ...> tag
• array $tdDesc: array with tag options in <td ...> tag
• boolean $debug: show debug info

writeTableFromArray (line 2779)

writes a form table from a query

• version: pk-04-09-08
• version: pk-05-11-04

• DB_xxx $DBOBJ
• string $query
• int $mode
• string $arrName
• boolean $debug
• $DBVAL

writeTableList (line 1956)

• $aSelectName
• $sep

xmlExport (line 4944)

exports the form to an xml file

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