Class DBMS_FIELD_CHECKBOX

• author: Peter Krebs <pitlinz@users.sourceforge.net>
• version: pk-04-05-27
• version:

  pk-05-11-13

  pk-04-05-27: --------------------------------- changed parent class from DBMS_FIELD_INT to DBMS_FIELD

• project: Open CSP-Management
• license: GNU Public License

Located in /db/frmClasses/DBMS_FIELD_CHECKBOX.phpclass (line 36)

DBMS_FIELD
   |
   --DBMS_FIELD_CHECKBOX

mixed $checkedValue = 1 (line 75)

• access: protected

string $checkText = "" (line 84)

• access: protected

string $classSrcFile = __FILE__ (line 70)

source file of the class (without $GLOBALS['PROJECT']['PATH']

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

---

Redefinition of:

DBMS_FIELD::$classSrcFile

source file of the class

mixed $lstStyle = 0 (line 103)

list layout

styles:

1. -> check/uncheckText
2. -> disabled checkbox
3. -> ok.gif / nothing
4. -> ok.gif / cancel.gif
5. -> cancel.gif / ok.gif

• since: pk-06-01-30
• access: protected

boolean $reloadFormOnChange = False (line 109)

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

mixed $uncheckedValue = 0 (line 79)

• access: protected

string $uncheckText = "" (line 88)

• access: protected

Inherited Variables

Inherited from DBMS_FIELD

DBMS_FIELD::$addTag
DBMS_FIELD::$ajaxDebug
DBMS_FIELD::$ajaxNotifyLst
DBMS_FIELD::$allowNull
DBMS_FIELD::$dbDesc
DBMS_FIELD::$defaultValue
DBMS_FIELD::$enableCopy
DBMS_FIELD::$enableEdit
DBMS_FIELD::$enableEditIfEmpty
DBMS_FIELD::$enableNew
DBMS_FIELD::$errMsg
DBMS_FIELD::$exportCSV
DBMS_FIELD::$extConfOptions
DBMS_FIELD::$extJSxType
DBMS_FIELD::$fieldtd_add
DBMS_FIELD::$fldDbgGetValue
DBMS_FIELD::$fldDebug
DBMS_FIELD::$hideAddTag_ro
DBMS_FIELD::$hideCopy
DBMS_FIELD::$hideEdit
DBMS_FIELD::$hideNew
DBMS_FIELD::$hideReadOnly
DBMS_FIELD::$inputAdd
DBMS_FIELD::$isHidden
DBMS_FIELD::$isSearchable
DBMS_FIELD::$js_check
DBMS_FIELD::$label
DBMS_FIELD::$labelcol_hide
DBMS_FIELD::$labeltd_add
DBMS_FIELD::$lstColSpan
DBMS_FIELD::$lstDisableLinks
DBMS_FIELD::$lstLabel
DBMS_FIELD::$lstLink
DBMS_FIELD::$lstTDAdd
DBMS_FIELD::$lstWidth
DBMS_FIELD::$maxlength
DBMS_FIELD::$myAjaxObj
DBMS_FIELD::$myBlock
DBMS_FIELD::$myBlockId
DBMS_FIELD::$myControll
DBMS_FIELD::$myCurrentMode
DBMS_FIELD::$myDataArrName
DBMS_FIELD::$myDeleteFlag
DBMS_FIELD::$myDesc
DBMS_FIELD::$myDOMId
DBMS_FIELD::$myForm
DBMS_FIELD::$myFrmId
DBMS_FIELD::$myGrpKey
DBMS_FIELD::$myHelpUrl
DBMS_FIELD::$myModuleKey
DBMS_FIELD::$myName
DBMS_FIELD::$myTable
DBMS_FIELD::$myTableAlias
DBMS_FIELD::$myView
DBMS_FIELD::$nullErrMsg
DBMS_FIELD::$ps_defaultDataArrName
DBMS_FIELD::$regexcheck_pattern
DBMS_FIELD::$regexErrMsg
DBMS_FIELD::$searchGroup_allowAll
DBMS_FIELD::$showGroup
DBMS_FIELD::$showInList
DBMS_FIELD::$showQasHidden
DBMS_FIELD::$showQuery
DBMS_FIELD::$size
DBMS_FIELD::$sortOrder
DBMS_FIELD::$srcVersion
DBMS_FIELD::$tabIndex
DBMS_FIELD::$toolTip
DBMS_FIELD::$toolTipAsTitle
DBMS_FIELD::$trimValue

editTblForm (line 196)

show the filed definition form

• deprecated: since pk-06-06-29

void editTblForm ([bool $showSize = FALSE], [boolean $showUnit = FALSE], [bool $showNull = FALSE])

• bool $showSize: obsulet show size input
• boolean $showUnit: obsulet
• bool $showNull: obsulet show input field to handle null values

---

Redefinition of:

DBMS_FIELD::editTblForm()

show the filed definition form

editTbl_getFieldEditArr (line 141)

returns an array of field to bie shown in the edit form by using editTbl_echoForm

the array is in the form:

1.  [_sectionName_]
2.       [TITLE] -> string
3.       [_rowName_]
4.          [FLDLAB]  (complete html code with <td></td>)
5.          [FLDVAL] (complete html code with <td></td>)

• since: pk-06-06-29

array editTbl_getFieldEditArr ([boolean $debug = FALSE])

• boolean $debug

getFieldTag (line 310)

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

• version: pk-06-01-30 FRM_MODE_LIST added
• since: pk-05-12-28

string getFieldTag (int $mode, [mixed $aValue = NULL], [boolean $debug = FALSE], [boolean $addChkTxt = TRUE])

• int $mode
• mixed $aValue
• boolean $debug
• boolean $addChkTxt

---

Redefinition of:

DBMS_FIELD::getFieldTag()

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

getInputTag (line 275)

returns the html code for the checkbox

• version: pk-05-12-28

string getInputTag (mixed $aValue, [string $arrName = "DBVAL"], [string $nameAdd = ""], [boolean $addChkTxt = TRUE])

• mixed $aValue
• string $arrName
• string $nameAdd
• boolean $addChkTxt

---

Redefinition of:

DBMS_FIELD::getInputTag()

returns the html code for a editable formular element

getListValue (line 531)

void getListValue ([ $aValue = NULL], [ $arrName = "DBVAL"], [ $debug = FALSE])

• $aValue
• $arrName
• $debug

---

Redefinition of:

DBMS_FIELD::getListValue()

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

getReloadButton (line 249)

gets the htmlcode for the reload button (if $this->reloadFormOnChange) a html link which submits document.forms['".$this->getMyFormName()."'] to global $frmReloadURL if set otherwise the form is submitted to $_SERVER['REQUEST_URI']

• since: pk-04-08-31

string getReloadButton ([string $arrName = "DBVAL"])

• string $arrName

getScreenValue (line 464)

void getScreenValue ( $aValue,  $arrName,  $debug)

• $aValue
• $arrName
• $debug

---

Redefinition of:

DBMS_FIELD::getScreenValue()

returns the html representation of the field

getSearchCompTypes (line 378)

only no options for this fieldtype

• since: pk-05-02-16

string getSearchCompTypes (string $arrName)

• string $arrName: name of the post array

getSearchInputTag (line 401)

returns the html code for a searchformular element 3 radiobox are shown checked, unchecked and ignore to avoid trubbles with 0 NULL and so an the

radioboxes uses the values:

• !CHECKED!
• !UNCHECKED!
• !IGNORE!

• version: pk-06-02-13
• since: pk-06-01-25

string getSearchInputTag (mixed $aValue, [string $arrName = "DBVAL"])

• mixed $aValue: the value to set
• string $arrName

getValue (line 482)

returns the field value if the referenzed row exists

• version: pk-04-06-02
• since: pk-03-12-13

string getValue (string $aValue,  &$err, [string $arrName = "DBVAL"], [bool $debug = FALSE], array $err)

• string $aValue: the value
• array $err: error array
• string $arrName: name of the array to access fieldsarray gloabl ${$arrName}
• bool $debug
• &$err

lstLinksDisabled (line 231)

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

• since: pk-06-01-30

boolean lstLinksDisabled ()

---

Redefinition of:

DBMS_FIELD::lstLinksDisabled()

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

save (line 210)

save the filed definition form

boolean save ()

---

Redefinition of:

DBMS_FIELD::save()

save the filed definition form

searchWhere (line 439)

checks the searchform post field array if [VALUE] != "!IGNORE!" if the field is not to ignore parent::searchWhere() is called

string searchWhere (array $aArr, [bool $debug = FALSE])

• array $aArr: the posted array of the filed form the search form
• bool $debug

slashedValue (line 503)

add slashes to the value to add it to a sql command

• version: pk-03-12-13
• version: pk-06-07-28

string slashedValue (string $aValue,  &$err, [string $arrName = "DBVAL"], [bool $debug = FALSE], array $err)

• string $aValue: the value
• array $err: error array
• string $arrName: name of the global array to access field gloabl ${$arrName}
• bool $debug
• &$err

Inherited Methods

Inherited From DBMS_FIELD

DBMS_FIELD::DBMS_FIELD()
DBMS_FIELD::allowNull()
DBMS_FIELD::check()
DBMS_FIELD::editLst_getAdminLstStyle()
DBMS_FIELD::editLst_getClassSelectOptions()
DBMS_FIELD::editTblForm()
DBMS_FIELD::editTbl_echoForm()
DBMS_FIELD::editTbl_getForm()
DBMS_FIELD::fldTypeIsUseable()
DBMS_FIELD::getAddTag()
DBMS_FIELD::getBlockId()
DBMS_FIELD::getDataArrName()
DBMS_FIELD::getDBColName()
DBMS_FIELD::getDBColType()
DBMS_FIELD::getDbDefault()
DBMS_FIELD::getdbDesc()
DBMS_FIELD::getDebugMode()
DBMS_FIELD::getDefaultValue()
DBMS_FIELD::getFieldRow()
DBMS_FIELD::getFieldRowCols()
DBMS_FIELD::getFieldTag()
DBMS_FIELD::getFrmId()
DBMS_FIELD::getInputTag()
DBMS_FIELD::getKey()
DBMS_FIELD::getLabel()
DBMS_FIELD::getLabelColTag()
DBMS_FIELD::getListLink()
DBMS_FIELD::getListLinkArr()
DBMS_FIELD::getListValue()
DBMS_FIELD::getLstColSpan()
DBMS_FIELD::getLstLabel()
DBMS_FIELD::getLstWidth()
DBMS_FIELD::getModuleKey()
DBMS_FIELD::getMyBlock()
DBMS_FIELD::getMyForm()
DBMS_FIELD::getMyFormName()
DBMS_FIELD::getName()
DBMS_FIELD::getObjectData()
DBMS_FIELD::getObjectVars()
DBMS_FIELD::getOrderNr()
DBMS_FIELD::getScreenValue()
DBMS_FIELD::getSetting()
DBMS_FIELD::getShowGroup()
DBMS_FIELD::getSize()
DBMS_FIELD::getSourceFile()
DBMS_FIELD::getTabIndex()
DBMS_FIELD::getTable()
DBMS_FIELD::getTblAlias()
DBMS_FIELD::getToolTip()
DBMS_FIELD::getType()
DBMS_FIELD::getValId()
DBMS_FIELD::get_lstTDAdd()
DBMS_FIELD::incOrderNr()
DBMS_FIELD::isAutoInc()
DBMS_FIELD::isEnabled()
DBMS_FIELD::isHidden()
DBMS_FIELD::isLayoutFld()
DBMS_FIELD::isMarkedDeleted()
DBMS_FIELD::isPrimaryKey()
DBMS_FIELD::isReadOnlyShown()
DBMS_FIELD::isSearchable()
DBMS_FIELD::isToShow()
DBMS_FIELD::labelIsHidden()
DBMS_FIELD::lstLinksDisabled()
DBMS_FIELD::markDeleted()
DBMS_FIELD::markUnDeleted()
DBMS_FIELD::save()
DBMS_FIELD::setDataArrName()
DBMS_FIELD::setdbDesc()
DBMS_FIELD::setFieldVar()
DBMS_FIELD::setFrmId()
DBMS_FIELD::setHidden()
DBMS_FIELD::setLabel()
DBMS_FIELD::setModuleKey()
DBMS_FIELD::setMyBlock()
DBMS_FIELD::setMyForm()
DBMS_FIELD::setName()
DBMS_FIELD::setObjectVars()
DBMS_FIELD::setObjVarsFrom()
DBMS_FIELD::setOrderNr()
DBMS_FIELD::setShown()
DBMS_FIELD::setTable()
DBMS_FIELD::setTblAlias()
DBMS_FIELD::showInList()