Class DBMS_FIELD

Description

Implements interfaces:

Located in /db/frmClasses/DBMS_FIELD.phpclass (line 59)


	
			
Direct descendents
Class Description
 class DBMS_FIELD_CHECKBOX Class DBMS_FIELD_CHECKBOX
 class DBMS_FIELD_DATE Class DBMS_FIELD_DATE
 class DBMS_FIELD_DBMS_FORMFIELDOBJECT Class file DBMS_FIELD_DBMS_FORMFIELDOBJECT.phpclass
 class DBMS_FIELD_EMAILADDR Class DBMS_FIELD_EMAILADDR
 class DBMS_FIELD_EXTOBJ Class DBMS_FIELD_EXTOBJ
 class DBMS_FIELD_FLOAT Class DBMS_FIELD_FLOAT
 class DBMS_FIELD_INPUTFIELDS Class DBMS_FIELD_INPUTFIELDS
 class DBMS_FIELD_INPUTFORM Class DBMS_FIELD_INPUTFORM
 class DBMS_FIELD_INT Class DBMS_FIELD_INT
 class DBMS_FIELD_LAYOUT Class DBMS_FIELD_LAYOUT_LINKBTTN
 class DBMS_FIELD_LAYOUT_LINKBTTN Class DBMS_FIELD_LAYOUT_LINKBTTN
 class DBMS_FIELD_LINK Class DBMS_FIELD_LINK
 class DBMS_FIELD_PASSWORD Class DBMS_FIELD_PASSWORD
 class DBMS_FIELD_SELECTLIST Class DBMS_FIELD_SELECTLIST
 class DBMS_FIELD_SER_OBJ handle show readonly serilaized data in a table field
 class DBMS_FIELD_STRINGIDENTIFIER Class DBMS_FIELD_STRINGIDENTIFIER
 class DBMS_FIELD_SUBFRM Abstract Class DBMS_FIELD_SUBFRM_LIST
 class DBMS_FIELD_TEMPLATE Class DBMS_FIELD_TEMPLATE
 class DBMS_FIELD_TEXTAREA handels long string (blob) fields
 class DBMS_FIELD_TIME Class DBMS_FIELD_TIME
 class DBMS_FIELD_SHOWTMPL Class DBMS_FIELD_SHOWTMPL
Variable Summary
Method Summary
 DBMS_FIELD DBMS_FIELD ([string $aTable = NULL], [string $aName = NULL], [array $aDesc = NULL], [int $sOrder = 99999], [string $aLabel = ""], [string $aAlias = NULL], [ $aFormId = 0])
 bool allowNull ()
 bool check (array $aDesc)
 string editLst_getClassSelectOptions ([boolean $debug = False])
 void editTblForm ([bool $showSize = True], [bool $showNull = True])
 void editTbl_echoForm ([array $fldEditArr = NULL], [boolen $debug = False])
 string editTbl_getForm ([array $fldEditArr = NULL], [boolen $debug = False])
 boolean fldTypeIsUseable (string $fldType, [boolean $debug = False])
 string getAddTag ([string $arrName = "DBVAL"])
 int getBlockId ()
 string getDataArrName ()
 string getDBColName ([boolean $withAlias = True])
 string getDBColType ()
 mixed getDbDefault ()
 array getdbDesc ()
 string getDebugMode ()
 mixed getDefaultValue ([ $debug = False])
 string getFieldRow (int $mode, [mixed $aValue = NULL], [boolean $debug = False])
 string getFieldRowCols (int $mode, [mixed $aValue = NULL], [boolean $debug = False])
 string getFieldTag (int $mode, [mixed $aValue = NULL], [boolean $debug = False])
 int getFrmId ()
 string getInputTag (mixed $aValue, [string $arrName = "DBVAL"], [string $nameAdd = ""], [boolean $debug = False])
 string getKey ()
 string getLabel ()
 void getLabelColTag ([ $useTh = False], [ $style = ""], [ $debug = False])
 void getListLink ( $aValue, [ $arrName = ""], [ $debug = False])
 array getListLinkArr ()
 mixed getListValue ([mixed $aValue = NULL], [string $arrName = "DBVAL"], [bool $debug = False])
 int getLstColSpan ()
 string getLstLabel ()
 int getLstWidth ()
 string getModuleKey ()
 OCSP_FORM &getMyForm ([bool $debug = False])
 string getMyFormName ()
 string getName ()
 array getObjectData ([boolean $debug = False])
 array getObjectVars ([boolean $debug = False])
 int getOrderNr ()
 mixed getScreenValue ([mixed $aValue = NULL], [string $arrName = "DBVAL"], [bool $debug = False])
 mixed getSetting (string $name)
 int getShowGroup ()
 int getSize ()
 string getSourceFile ([boolean $debug = False])
 int getTabIndex ()
 string getTable ()
 string getTblAlias ()
 string getToolTip ()
 string getType ()
 string getValId ()
 string get_lstTDAdd ()
 void incOrderNr ([int $by = 1])
 boolean isAutoInc ()
 boolean isEnabled (int $mode, [boolean $debug = False])
 boolean isHidden ([string $scope = 'setting'])
 boolean isLayoutFld ()
 boolen isMarkedDeleted ()
 boolean isPrimaryKey ([boolean $debug = False])
 boolean isReadOnlyShown (int $mode, [boolean $debug = False])
 boolean isSearchable ()
 boolean isToShow (int $mode, array $dataArr, [boolean $debug = False], [boolean $inFieldGroup = False])
 boolean labelIsHidden ()
 boolean lstLinksDisabled ()
 void markDeleted ()
 void markUnDeleted ()
 bool save ([bool $debug = False])
 void setDataArrName (string $arrName)
 void setdbDesc (array $dbDesc)
 void setFieldVar (string $varName, mixed $value, [boolean $debug = False])
 void setFrmId ( $aId)
 void setHidden ([string $scope = 'form'])
 void setLabel (string $aLabel)
 void setModuleKey (string $modKey)
 void setMyBlock (OCSP_FORM_BLOCK &$aBlock, [boolean $debug = False])
 void setMyForm ( &$frmObj, [boolean $force = False], DBMS_FORM $frmObj)
 void setName (string $aName)
 boolean setObjectVars (array $varArr, [boolean $debug = False])
 void setObjVarsFrom (DBMS_FIELD $fld, [boolean $debug = False])
 void setOrderNr ( $aNr, int $anr)
 void setShown ([string $scope = 'form'])
 bool setTable (string $aTable, [string $colPreFix = ""], [bool $getDesc = True], [bool $debug = False])
 void setTblAlias (string $alias)
 boolean showInList ()
Variables
string $addTag = "" (line 253)
  • var: htmlcode to add in fields input col
  • access: protected
boolean $ajaxDebug = False (line 490)
  • since: pk-07-09-24
  • access: protected
array $ajaxNotifyLst = array() (line 483)
  • var: a list of fields and commands to notify onChange
  • since: pk-07-03-05
  • access: protected
bool $allowNull = True (line 278)
  • var: is only used if db desc allows null
  • access: protected
mixed $classSrcFile = __FILE__ (line 74)

source file of the class

  • staticvar: string $classSrcFile:
  • since: pk-05-01-11
  • access: protected

Redefined in descendants as:
array $dbDesc = array() (line 172)
  • access: protected
string $defaultValue = "" (line 188)
  • access: protected

Redefined in descendants as:
bool $enableCopy = True (line 209)
  • access: protected
bool $enableEdit = True (line 196)
  • access: protected
bool $enableEditIfEmpty = True (line 201)
  • var: can the field be edited if the field is empty and not $enableEdit ?
  • since: pk-06-08-08
  • access: protected
bool $enableNew = True (line 205)
  • access: protected
string $errMsg = "" (line 288)
  • var: current ErrorMsg of the field if empty the field does not have an error
  • since: pk-07-07-11
  • access: protected
boolean $exportCSV = True (line 476)
  • since: pk-06-09-27
  • access: protected
string $extConfOptions = "" (line 504)

extJS configuration options

  • access: protected
string $extJSxType = 'field' (line 497)

xtype to use in the extJS framework for the field

  • access: protected

Redefined in descendants as:
$fieldtd_add $fieldtd_add = "" (line 274)
  • var: htmlcode to add in the <td > tag of the field
  • since: pk-04-02-03
  • access: protected
bool $fldDbgGetValue = False (line 341)
  • var: debug getValue Method
  • since: pk-05-02-11
  • access: protected
bool $fldDebug = False (line 335)

debug

  • since: pk-04-06-02
  • access: protected
bool $hideAddTag_ro = False (line 258)
  • var: hide addTag in readonly view
  • since: pk-05-02-25
  • access: protected
bool $hideCopy = False (line 221)
  • access: protected
bool $hideEdit = False (line 213)
  • access: protected
bool $hideNew = False (line 217)
  • access: protected
boolean $hideReadOnly = False (line 382)

hide the file in read only mode hide is used to not have to update all forms

  • since: pk-04-10-13
  • access: protected
string $inputAdd = "" (line 470)
  • since: pk-05-11-15
  • access: protected

Redefined in descendants as:
bool $isHidden = False (line 192)
  • access: protected
bool $js_check = False (line 350)

add javascript check

  • since: pk-04-07-23
  • access: protected
string $label = "" (line 177)
  • access: protected
$labelcol_hide $labelcol_hide = False (line 268)
  • var: hide labelcolumn and set fieldcol rowspan=2
  • since: pk-04-02-05
  • access: protected
$labeltd_add $labeltd_add = "" (line 263)
  • var: htmlcode to add in the <td > tag of the label
  • since: pk-04-02-03
  • access: protected
int $lstColSpan = 1 (line 400)
  • since: pk-05-03-17
  • access: protected
boolean $lstDisableLinks = False (line 421)
  • var: do not link list cell
  • since: pk-05-03-17
  • access: protected

Redefined in descendants as:
string $lstLabel = "" (line 183)
  • since: pk-06-01-19
  • access: protected
array $lstLink = array() (line 427)
  • var: link col ('A' => <a ....>, 'TEXT' => Button)
  • since: pk-05-04-15
  • access: protected
string $lstTDAdd = "" (line 415)
  • since: pk-05-07-08
  • access: protected
int $lstWidth = 0 (line 409)

col width in lists

  • since: pk-08-06-03
  • access: protected
int $maxlength = 65000 (line 248)
  • var: maxlength default value of maxlength
  • access: protected

Redefined in descendants as:
AJAX $myAjaxObj = NULL (line 83)
  • since: pk-07-03-01
  • access: protected
OCSP_FORM_BLOCK $myBlock = NULL (line 95)
  • access: protected
int $myBlockId = 0 (line 124)
  • var: id of the form block the field belongs to
  • since: pk-07-08.06
  • access: protected
OCSP_FRMCONTR $myControll = NULL (line 107)
  • access: protected
int $myCurrentMode = FRM_MODE_READONLY (line 394)
  • since: pk-05-02-25
  • access: protected
string $myDataArrName = "DBVAL" (line 297)

as we need the $arrName nearly everywhere it is defined as object var

  • version: pk-03-10-19
  • access: protected
boolean $myDeleteFlag = False (line 139)
  • since: pk-07-08-08
  • access: protected
string $myDesc = "" (line 168)
  • access: protected
string $myDOMId = "" (line 146)

DOM Id of the field (this MUST NOT be stored)

  • access: protected
OCSP_FORM $myForm = NULL (line 89)
  • access: protected
int $myFrmId = 0 (line 117)
  • var: id of the form the field belongs to
  • since: pk-04-02-23
  • access: protected
string $myGrpKey = "" (line 326)

fieldkey of the show group

  • since: pk-04-02-23
  • access: protected
string $myHelpUrl = "" (line 317)

url to open for field help window if not empty a ? icon is added to the label and linked with the url as popup

  • since: pk-03-12-17
  • access: protected
string $myModuleKey = "DBMS" (line 131)
  • since: pk-07-08-07
  • access: protected
string $myName = "" (line 164)
  • var: myName column name in the table
  • access: protected
string $myTable = "" (line 154)
  • var: myTable name of the db table of the field
  • access: protected
string $myTableAlias = "" (line 160)

alias of the table in a join

  • var: myTableAlias
  • access: protected
OCSP_FRMVIEW $myView = NULL (line 101)
  • access: protected
string $nullErrMsg = "" (line 283)
  • var: error message to set if value is null
  • access: protected
string $ps_defaultDataArrName = "DBVAL" (line 306)

the default value for $myDataArrName

  • version: pk-03-10-19
  • access: protected
string $regexcheck_pattern = "" (line 359)

regex check

  • version: pk-05-08-09
  • since: pk-04-07-23
  • access: protected
string $regexErrMsg = "" (line 365)
  • since: pk-05-08-09
  • access: protected
boolean $searchGroup_allowAll = True (line 445)
  • var: add NULL in getTableValSelect()?
  • since: pk-05-10-23
  • access: protected
int $showGroup = "0" (line 464)
  • var: the user must be member of this group (id) to see the field
  • since: pk-06-10-08
  • access: protected
bool $showInList = True (line 230)
  • access: protected
boolean $showQasHidden = False (line 457)
  • var: if True the field is echoed hidden showQuery don't fit else field is not echoed
  • since: since pk-06-11-15
  • access: protected
string $showQuery = "" (line 451)
  • since: pk-05-11-15
  • access: protected
int $size = 30 (line 244)
  • var: default value of the size
  • access: protected

Redefined in descendants as:
int $sortOrder = 99999 (line 234)
  • access: protected
int $srcVersion (line 433)
  • var: current version of the source to discover old version serialized object in the database
  • since: pk-05-03-25
  • access: protected

Redefined in descendants as:
int $tabIndex (line 388)
  • since: pk-05-02-18
  • access: protected
string $toolTip = "" (line 239)
  • var: if is set a dialog box is linked with the label showing the toolTip
  • access: protected
boolean $toolTipAsTitle = False (line 439)
  • since: pk-05-09-05
  • access: protected
boolean $trimValue = False (line 371)
  • since: pk-05-09-14
  • access: protected
Methods
Constructor DBMS_FIELD (line 524)

initialises the object

  • version: pk-04-07-29
  • version: pk-04-10-05 no params required
DBMS_FIELD DBMS_FIELD ([string $aTable = NULL], [string $aName = NULL], [array $aDesc = NULL], [int $sOrder = 99999], [string $aLabel = ""], [string $aAlias = NULL], [ $aFormId = 0])
  • string $aTable: name of the table where the field is a column
  • string $aName: name of the table column
  • array $aDesc: database column description
  • int $sOrder: sort order
  • string $aLabel: Label of the field
  • string $aAlias: db table alias in a join
  • $aFormId
allowNull (line 1684)

check if NULL values are allowed

  • version: pk-06-02-21 check for empty COLNAME
  • version: pk-06-11-27 allowNull is true whereas dbDesc['NULL'] is flase
bool allowNull ()
check (line 1657)

compares the values of $aDesc (DB Field definition) with the field definition stored in the object

bool check (array $aDesc)
  • array $aDesc
editLst_getAdminLstStyle (line 1485)

return a css style definition for the fieldlist

  • since: pk-06-10-13
string editLst_getAdminLstStyle ()
editLst_getClassSelectOptions (line 1510)

returns the option list for the class select element

  • version: pk-08-05-19
  • version: pk-08-06-06
  • todo: dirty workaround
  • since: pk-07-08-06
string editLst_getClassSelectOptions ([boolean $debug = False])
  • boolean $debug
editTblForm (line 1623)

show the filed definition form

  • version: pk-04-10-13
  • version: pk-05-02-11 fldDbgGetValue added
  • version: pk-05-09-14 trimValue added
  • deprecated: since pk-06-04-26
void editTblForm ([bool $showSize = True], [bool $showNull = True])
  • bool $showSize: show size input
  • bool $showNull: show input field to handle null values

Redefined in descendants as:
editTbl_echoForm (line 1605)

echos the field definition form from the field edit array @see editTbl_getFieldEditArr()

  • version: pk-06-07-17
  • version: pk-07-05-03
  • since: pk-06-04-26
void editTbl_echoForm ([array $fldEditArr = NULL], [boolen $debug = False])
  • array $fldEditArr
  • boolen $debug
editTbl_getForm (line 1559)

returns the field definition form from the field edit array @see editTbl_getFieldEditArr()

  • since: pk-07-05-03
  • access: public
string editTbl_getForm ([array $fldEditArr = NULL], [boolen $debug = False])
  • array $fldEditArr
  • boolen $debug

Implementation of:
INFA_DBMS_FIELD::editTbl_getForm()
returns the field definition form
fldTypeIsUseable (line 1443)

checks if a db fieldtype is compatible to the class

  • version: pk-05-06-24
  • version: pk-06-02-10
  • version: pk-06-04-07 DECIMAL added
  • since: pk-05-04-18
boolean fldTypeIsUseable (string $fldType, [boolean $debug = False])
  • string $fldType
  • boolean $debug

Redefined in descendants as:
getAddTag (line 1792)

returns the addTag parsed as template with global ${$arrName} as data

  • version: pk-05-02-25
string getAddTag ([string $arrName = "DBVAL"])
  • string $arrName
getBlockId (line 1181)
int getBlockId ()
getDataArrName (line 858)
  • since: pk-07-02-27
string getDataArrName ()
getDBColName (line 957)

returns the databas column name

  • version: pk-03-10-22
  • version: pk-05-02-16
  • version: pk-07-12-29 $withAlias added
string getDBColName ([boolean $withAlias = True])
  • boolean $withAlias: if empty $this::dbDesc['COLNAME'] $this->getName() is returned which should in most cases be same as dbDesc['COLNAME']
getDBColType (line 895)

returns the database type of the fields column

  • since: pk-07-04-28
  • access: public
string getDBColType ()
getDbDefault (line 1705)

returns the field database default value

  • version: pk-03-10-14
mixed getDbDefault ()
getdbDesc (line 978)

returns $dbDesc (COPY OF THE ARRAY)

  • version: pk-03-10-22
array getdbDesc ()
getDebugMode (line 1043)

returns the debug mode of the field

  • D fldDebug
  • G fldDbgGetValue
  • A ajaxDebug

  • since: pk-07-09-24
string getDebugMode ()
getDefaultValue (line 1765)

returns the field default value

if $defaultValue !empty it is returned else getDbDefault is return

  • version: pk-04-02-05
  • version: pk-05-03-17
mixed getDefaultValue ([ $debug = False])
  • $debug

Redefined in descendants as:
getFieldRow (line 2237)

returns the html code for a field form row

  • version: pk-04-10-13
  • version: pk-07-03-05 id added to table row
  • since: pk-04-09-08
string getFieldRow (int $mode, [mixed $aValue = NULL], [boolean $debug = False])
  • int $mode
  • mixed $aValue
  • boolean $debug
getFieldRowCols (line 2287)

returns the row columns for a field row

  • version: pk-05-02-25 bugif colspan
  • version: pk-07-02-15 set class even if we have set $this->labeltd_add
  • version: pk-07-02-28 add id to value column
  • since: pk-05-02-08
string getFieldRowCols (int $mode, [mixed $aValue = NULL], [boolean $debug = False])
  • int $mode
  • mixed $aValue
  • boolean $debug

Redefined in descendants as:
getFieldTag (line 2039)

returns the html code for the field value input / show adds $this->myName to ${$this->myDataArrName}['_DBMS_FIELDS']

  • version: pk-04-10-13
  • version: pk-04-12-21
  • version: pk-05-01-03
  • version: pk-06-02-26 getListValue()
  • since: pk-04-09-08
string getFieldTag (int $mode, [mixed $aValue = NULL], [boolean $debug = False])
  • int $mode
  • mixed $aValue
  • boolean $debug

Redefined in descendants as:
getFrmId (line 1075)

returns the id of the form the field belongs to

  • since: pk-04-02-23
  • access: public
int getFrmId ()
getInputTag (line 1842)

returns the html code for a editable formular element

  • version: pk-05-01-06
  • version: pk-06-05-18 inputAdd added
  • version: pk-06-08-09 debug added
  • version: pk-07-12-07 avoid maxlength 0
string getInputTag (mixed $aValue, [string $arrName = "DBVAL"], [string $nameAdd = ""], [boolean $debug = False])
  • mixed $aValue: the value to set
  • string $arrName
  • string $nameAdd: append something to name like "[VALUE]" for search forms
  • boolean $debug: since pk-06-08-09

Redefined in descendants as:
getKey (line 1017)

returns the field key ($this->myTableAlias.".".$this->myName)

string getKey ()
getLabel (line 2120)
  • since: pk-05-10-03
string getLabel ()
getLabelColTag (line 2178)
void getLabelColTag ([ $useTh = False], [ $style = ""], [ $debug = False])
  • $useTh
  • $style
  • $debug

Redefined in descendants as:
getListLink (line 2416)
void getListLink ( $aValue, [ $arrName = ""], [ $debug = False])
  • $aValue
  • $arrName
  • $debug

Redefined in descendants as:
getListLinkArr (line 2393)
  • since: pk-07-07-04
array getListLinkArr ()
getListValue (line 2370)

returns the html representation of the field in a list (table col)

  • return: the html representation of the field
  • since: pk-06-04-26
mixed getListValue ([mixed $aValue = NULL], [string $arrName = "DBVAL"], [bool $debug = False])
  • mixed $aValue: the falue
  • string $arrName: name of the global array holding data values
  • bool $debug: show debug info

Redefined in descendants as:
getLstColSpan (line 2149)

list colspan (<td colspan="x">)

int getLstColSpan ()
getLstLabel (line 2139)
  • since: pk-06-01-19
string getLstLabel ()
getLstWidth (line 2158)
  • since: pk-08-06-03
  • access: public
int getLstWidth ()
getModuleKey (line 1196)
  • since: pk-07-08-07
  • access: public
string getModuleKey ()
getMyBlock (line 1166)
  • version: pk-08-08-08
OCSP_FORM_BLOCK &getMyBlock ()
getMyForm (line 1112)

returns a pointer to the owner form or NULL in case of error

  • version: pk-05-01-11
  • version: pk-05-09-14
  • version: pk-06-11-19 always set myForm
  • version: pk-08-01-16
  • since: pk-04-07-29
OCSP_FORM &getMyForm ([bool $debug = False])
  • bool $debug: since pk-05-01-11
getMyFormName (line 1132)

returns the name of the form

  • since: pk-04-12-29
string getMyFormName ()
getName (line 1029)

returns the field name

string getName ()
getObjectData (line 615)

returns an 2 dimensional array of object data

  • $ret['OBJDESC'] -> discription of the object
  • $ret['OBJVAL'] -> get_object_vars($this)

  • version: pk-07-03-06
  • since: pk-04-10-05
  • access: public
array getObjectData ([boolean $debug = False])
  • boolean $debug
getObjectVars (line 644)

returns an array of the object vars see also php function get_object_vars

  • version: pk-07-08-05
  • version: pk-07-03-06
  • access: public
array getObjectVars ([boolean $debug = False])
  • boolean $debug
getOrderNr (line 791)

returns the orderNr of the field

  • version: pk-07-05-02 bugfix orderNr => sortOrder
  • since: pk-06-12-01
  • access: public
int getOrderNr ()
getScreenValue (line 2345)

returns the html representation of the field

  • return: the html representation of the field
mixed getScreenValue ([mixed $aValue = NULL], [string $arrName = "DBVAL"], [bool $debug = False])
  • mixed $aValue: the falue
  • string $arrName: name of the global array holding data values
  • bool $debug: show debug info

Redefined in descendants as:
getSetting (line 872)

returns a field setting value

mixed getSetting (string $name)
  • string $name
getShowGroup (line 1894)

returns the group id which is required to see the field

  • since: pk-07-09-12
int getShowGroup ()
getSize (line 1812)

returns the (show) size (chars) of a field

  • since: pk-08-05-29
  • access: public
int getSize ()
getSourceFile (line 580)

returns the source file of the class

without

  • $GLOBALS['PROJECT']['PATH']
  • __OCSP_PHPINCPATH__ (if not in project path)
overwrite this

  • version: pk-05-02-10
  • version: pk-05-12-01 compleate rewrite of the method
  • since: pk-04-10-05
string getSourceFile ([boolean $debug = False])
  • boolean $debug
getTabIndex (line 831)

returns the tabIndex of the field

  • since: pk-07-10-26
int getTabIndex ()
getTable (line 908)

returns the table of the field

  • since: pk-05-07-11
string getTable ()
getTblAlias (line 920)

returns the table alias used in joins normaly this is the same as $this->myTable

  • since: pk-07-10-26
string getTblAlias ()
getToolTip (line 2128)
  • since: pk-07-07-09
string getToolTip ()
getType (line 882)

returns the database column type of the field

string getType ()
getValId (line 1226)

returns the td id of the value col

  • since: pk-07-02-28
  • access: public
string getValId ()
get_lstTDAdd (line 2353)
  • since: pk-07-10-16
string get_lstTDAdd ()
incOrderNr (line 821)

increase orderNr by 1

  • version: pk-07-05-02 bugfix orderNr => sortOrder
  • since: pk-06-12-02
  • access: public
void incOrderNr ([int $by = 1])
  • int $by
isAutoInc (line 1732)

returns if the field represents an auto_increment column in the database

  • version: pk-06-08-03
  • since: pk-06-06-07
boolean isAutoInc ()
isEnabled (line 2002)

returns if the field is enabled in $mode and to show

  • since: pk-06-09-12
boolean isEnabled (int $mode, [boolean $debug = False])
  • int $mode
  • boolean $debug
isHidden (line 1337)

returns if the field is hidden or not

  • version: pk-07-05-02 scope added
  • version: pk-07-08-20 first check $this->isHidden
  • version: pk-08-06-03 $scope => setting
  • since: pk-06-01-13
  • access: public
boolean isHidden ([string $scope = 'setting'])
  • string $scope
isLayoutFld (line 1749)
  • since: pk-06-09-27
boolean isLayoutFld ()

Redefined in descendants as:
isMarkedDeleted (line 763)

returns if the field is marked as deleted

boolen isMarkedDeleted ()
isPrimaryKey (line 1001)

returns if the field is (part of) the primary key

  • since: pk-06-08-07
boolean isPrimaryKey ([boolean $debug = False])
  • boolean $debug
isReadOnlyShown (line 1869)

returns if a field is shown readonly

  • since: pk-04-09-15
boolean isReadOnlyShown (int $mode, [boolean $debug = False])
  • int $mode
  • boolean $debug
isSearchable (line 1321)

returns if the field is searchable or not

  • since: pk-06-01-13
boolean isSearchable ()
isToShow (line 1921)

checks if the field is to show due to $this->showQuery

  • version: pk-06-10-08
  • version: pk-05-11-15
  • version: pk-07-01-09 use showQuery in FRM_MODE_SEARCH too
  • version: pk-07-09-12 global $OCSP_OBJ
  • version: pk-08-09-22 no global
  • since: pk-05-11-13
  • requires: pcf_templates.phpinc
boolean isToShow (int $mode, array $dataArr, [boolean $debug = False], [boolean $inFieldGroup = False])
  • int $mode
  • array $dataArr
  • boolean $debug
  • boolean $inFieldGroup
labelIsHidden (line 1307)
  • since: pk-07-08-27
boolean labelIsHidden ()
lstLinksDisabled (line 2384)

returns if the list cell can be linked with the ['EDIT'] link

  • since: pk-06-01-30
boolean lstLinksDisabled ()

Redefined in descendants as:
markDeleted (line 754)

marks the field as deleted by setting $this->myDeleteFlag to true

the next time the field is written to the database it should be deleted

void markDeleted ()
markUnDeleted (line 771)

removes the deleteFlag

void markUnDeleted ()
save (line 1644)

save the filed definition form

  • return: return True
  • version: pk-05-02-11 fldDbgGetValue added
  • version: pk-04-10-13
  • version: pk-04-07-23 debug added
  • version: pk-05-06-29 unsetGrpKey added
  • version: pk-05-08-09 regexcheck_pattern/regexErrMsg added
  • version: pk-06-09-27 exportCSV added
  • version: pk-06-02-21 allowNull setting if $this->dbDesc['COLNAME'] is empty
  • version: pk-05-09-14 trimValue added
  • version: pk-06-10-08 showGroup added
bool save ([bool $debug = False])
  • bool $debug: since pk-04-07-23

Redefined in descendants as:
setDataArrName (line 848)

sets myDataArrName

  • since: pk-04-09-08
void setDataArrName (string $arrName)
  • string $arrName
setdbDesc (line 988)

sets the database column description array

  • since: pk-07-09-19
void setdbDesc (array $dbDesc)
  • array $dbDesc
setFieldVar (line 1417)

sets a field value

  • since: pk-06-07-22
void setFieldVar (string $varName, mixed $value, [boolean $debug = False])
  • string $varName
  • mixed $value
  • boolean $debug
setFrmId (line 1063)

sets the id of the form the field belongs to

  • since: pk-04-02-23
void setFrmId ( $aId)
  • $aId
setHidden (line 1363)

sets a field as hidden

  • version: pk-07-05-02 scope added
  • since: pk-05-07-21
  • access: public
void setHidden ([string $scope = 'form'])
  • string $scope
setLabel (line 1299)

sets the Form label text

void setLabel (string $aLabel)
  • string $aLabel: text used in <td ...>$aLabel</td> column
setModuleKey (line 1211)
  • since: pk-07-08-07
  • access: public
void setModuleKey (string $modKey)
  • string $modKey
setMyBlock (line 1147)
void setMyBlock (OCSP_FORM_BLOCK &$aBlock, [boolean $debug = False])
setMyForm (line 1090)

sets the owner form Object

  • version: pk-06-11-09 ensure myFrmId is also set
  • version: pk-08-01-16 $force
  • since: pk-05-09-14
void setMyForm ( &$frmObj, [boolean $force = False], DBMS_FORM $frmObj)
setName (line 1236)

sets the field name

void setName (string $aName)
  • string $aName
setObjectVars (line 687)

sets the objectvars return value is used to raise an error by default True is returned at the moment

  • version: pk-07-03-06
  • since: pk-04-10-05
  • access: public
boolean setObjectVars (array $varArr, [boolean $debug = False])
  • array $varArr
  • boolean $debug

Redefined in descendants as:
setObjVarsFrom (line 728)

sets the object vars from an other object

  • version: pk-07-10-31
void setObjVarsFrom (DBMS_FIELD $fld, [boolean $debug = False])
setOrderNr (line 806)

sets the orderNr of the field

  • version: pk-07-05-02 bugfix orderNr => sortOrder
  • since: pk-06-12-01
  • access: public
void setOrderNr ( $aNr, int $anr)
  • int $anr
  • $aNr
setShown (line 1390)

sets a field as shown

  • version: pk-07-05-02 scope added
  • since: pk-05-07-21
  • access: public
void setShown ([string $scope = 'form'])
  • string $scope
setTable (line 1255)

sets the field table (and load dbDesc again)

  • return: success?
  • version: pk-03-10-22
  • version: pk-06-07-14
  • version: pk-08-08-07
bool setTable (string $aTable, [string $colPreFix = ""], [bool $getDesc = True], [bool $debug = False])
  • string $aTable
  • bool $getDesc: load field Desc from table def
  • string $colPreFix: is added to db column name
  • bool $debug
setTblAlias (line 937)

sets the table alias

  • since: pk-08-07-12
  • access: public
void setTblAlias (string $alias)
  • string $alias
showInList (line 1986)

returns if the field is in list (does not check rights)

boolean showInList ()

Documentation generated on Thu, 08 Jan 2009 17:40:27 +0100 by phpDocumentor 1.4.0a2