handles foreign key fields

• author: Peter Krebs (pk) <pitlinz@users.sourceforge.net>
• version: pk-06-10-05 nullToZero added
• version: pk-06-08-09
• version: pk-07-08-31
• version: $Id: DBMS_FIELD_FOREIGNKEY.phpclass,v 1.18 2008/12/03 21:32:40 pitlinz Exp $
• project: Open CSP-Management
• license: GNU Public License

Located in /db/frmClasses/DBMS_FIELD_FOREIGNKEY.phpclass (line 38)

DBMS_FIELD
   |
   --DBMS_FIELD_SELECTLIST
      |
      --DBMS_FIELD_DBSELECTLIST
         |
         --DBMS_FIELD_DBLOOKUPSELECTLIST
            |
            --DBMS_FIELD_FOREIGNKEY

boolean $checkWhereAnd = FALSE (line 77)

• since: pk-05-09-30
• access: protected

string $classSrcFile = __FILE__ (line 71)

source file of the class

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

---

Redefinition of:

DBMS_FIELD_DBLOOKUPSELECTLIST::$classSrcFile

---

Redefined in descendants as:

• DBMS_FIELD_CLISELECT::$classSrcFile : source file of the class
• DBMS_FIELD_CLI_TYPESELECT::$classSrcFile : source file of the class
• DBMS_FIELD_CST_TYPESELECT::$classSrcFile : source file of the class
• DBMS_FIELD_CURRENTUSER::$classSrcFile : source file of the class
• DBMS_FIELD_DBMS_FORMFIELDSELECT::$classSrcFile : source file of the class
• DBMS_FIELD_DBMS_FORMSELECT::$classSrcFile : source file of the class
• DBMS_FIELD_MEDIA::$classSrcFile : source file of the class
• DBMS_FIELD_MEDIAFILE_SELID::$classSrcFile : source file of the class
• DBMS_FIELD_PAGESELECT::$classSrcFile : source file of the class
• DBMS_FIELD_PAGTMPL_SELECT::$classSrcFile : source file of the class
• DBMS_FIELD_PROJECTSELECT::$classSrcFile : source file of the class
• DBMS_FIELD_CLI_STATESELECT::$classSrcFile : source file of the class
• DBMS_FIELD_MODULESELECT::$classSrcFile : source file of the class
• DBMS_FIELD_ADRSELECT::$classSrcFile : source file of the class

int $editEnableInList = TRUE (line 132)

• var: link List field with edit url
• version: pk-03-10-17
• access: protected

---

Redefined in descendants as:

• DBMS_FIELD_DBMS_FORMSELECT::$editEnableInList

int $editFormId (line 125)

• since: pk-08-02-21
• access: protected

string $editUrl = "" (line 119)

• var: url to the field editor
• version: pk-03-10-17
• todo: add tags to input field link new
• access: protected

---

Redefined in descendants as:

• DBMS_FIELD_DBMS_FORMSELECT::$editUrl

string $myLayerDivClass = "" (line 148)

css class of the detail layer div

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

string $myLayerDivStyle = "" (line 157)

css style of the detail layer div

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

string $myURIQueryArrgs = "" (line 139)

• var: semicolon seperated list of url arguments
• since: pk-04-09-07
• access: protected

boolean $newEditAsAjax = TRUE (line 97)

edit or insert data with ajax or open an popup

• access: protected

int $newFormId (line 90)

• since: pk-08-02-21
• access: protected

string $newUrl = "" (line 84)

url to popup for a new entry

• access: protected

int $popupWndHeight = "400" (line 111)

hight of the popup window

• var: popupWndHeight
• access: protected

int $popupWndWidth = "600" (line 104)

width of the popup window

• access: protected

Inherited Variables

Inherited from DBMS_FIELD_DBLOOKUPSELECTLIST

DBMS_FIELD_DBLOOKUPSELECTLIST::$allowAddValues
DBMS_FIELD_DBLOOKUPSELECTLIST::$allowEditValues
DBMS_FIELD_DBLOOKUPSELECTLIST::$lookupField
DBMS_FIELD_DBLOOKUPSELECTLIST::$lookupShowField
DBMS_FIELD_DBLOOKUPSELECTLIST::$lookupShowLstField
DBMS_FIELD_DBLOOKUPSELECTLIST::$lookupSort
DBMS_FIELD_DBLOOKUPSELECTLIST::$lookupTable
DBMS_FIELD_DBLOOKUPSELECTLIST::$lookupWhere

Inherited from DBMS_FIELD_DBSELECTLIST

DBMS_FIELD_DBSELECTLIST::$classCache
DBMS_FIELD_DBSELECTLIST::$classValPopulateTs
DBMS_FIELD_DBSELECTLIST::$query

Inherited from DBMS_FIELD_SELECTLIST

DBMS_FIELD_SELECTLIST::$ajax_onChange_FuncName
DBMS_FIELD_SELECTLIST::$extJSxType
DBMS_FIELD_SELECTLIST::$lstValueIsHtml
DBMS_FIELD_SELECTLIST::$multiselect
DBMS_FIELD_SELECTLIST::$mySeperator
DBMS_FIELD_SELECTLIST::$myValues
DBMS_FIELD_SELECTLIST::$notInLstValues
DBMS_FIELD_SELECTLIST::$nullLabel
DBMS_FIELD_SELECTLIST::$nullToZero
DBMS_FIELD_SELECTLIST::$reloadFormOnChange
DBMS_FIELD_SELECTLIST::$selectAddTag
DBMS_FIELD_SELECTLIST::$selectsize
DBMS_FIELD_SELECTLIST::$showAsCheckRadio
DBMS_FIELD_SELECTLIST::$showNullOption
DBMS_FIELD_SELECTLIST::$showValuesInList
DBMS_FIELD_SELECTLIST::$static_fixedSelSize

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::$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

editTbl_getFieldEditArr (line 244)

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

• version: pk-06-04-29
• since: pk-06-04-26

array editTbl_getFieldEditArr ([boolean $debug = FALSE])

• boolean $debug

---

Redefinition of:

DBMS_FIELD_DBLOOKUPSELECTLIST::editTbl_getFieldEditArr()

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

---

Redefined in descendants as:

• DBMS_FIELD_CLISELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_CLI_TYPESELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_CST_TYPESELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_CURRENTUSER::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_DBMS_FORMFIELDSELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_DBMS_FORMSELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_MEDIAFILE_SELID::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_PAGESELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_PROJECTSELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_CLI_STATESELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_MODULESELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm
• DBMS_FIELD_ADRSELECT::editTbl_getFieldEditArr() : returns an array of field to bie shown in the edit form by using editTbl_echoForm

editTbl_tableChanged (line 323)

update editTbl_getFieldEditArr fields after change of the table

• return: (js)
• since: pk-08-02-10
• access: public

string editTbl_tableChanged (array $options)

• array $options

getNewBtn (line 427)

void getNewBtn ([ $arrName = "DBVAL"], [ $debug = FALSE])

• $arrName
• $debug

---

Redefinition of:

DBMS_FIELD_DBLOOKUPSELECTLIST::getNewBtn()

returns the html code for the new button

getValue (line 536)

returns the field value if the referenzed row exists

• version: pk-03-12-13
• version: pk-04-12-31 $this->label added to NULL ERROR MSG
• version: pk-05-06-16 debug due to fieldsettings
• version: pk-07-09-10 null handling
• 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

---

Redefinition of:

DBMS_FIELD_SELECTLIST::getValue()

returns the field value if its an array, it is imploded with $this->mySeperator as seperator

---

Redefined in descendants as:

• DBMS_FIELD_CURRENTUSER::getValue()
• DBMS_FIELD_MEDIA::getValue() : returns the field value if the referenzed row exists
• DBMS_FIELD_PAGESELECT::getValue() : returns the field value

getZoomBtn (line 476)

returns the html code for a button to zoom to the foreign record

• version: pk-05-02-22 parse url as template using ${$arrName} as value array
• version: pk-05-03-17 getPopupLinkJs added -> rewrite
• version: pk-05-10-04
• version: pk-05-10-23 param $debug added
• version: pk-06-01-03

string getZoomBtn ([boolean $debug = FALSE], string $arrName)

• string $arrName
• boolean $debug: (pk-05-10-23)

jOCSP_addDetail (line 710)

shows the form or url to add a new record in the foreign table

• return: (javascript)
• access: public

string jOCSP_addDetail (array $options, [boolean $debug = FALSE])

• array $options
• boolean $debug

jOCSP_detailFormLayer (line 603)

creates an layer for the detail record

• return: (js)
• access: public

string jOCSP_detailFormLayer (int $mode,  &$options, [boolean $debug = FALSE], array $options)

• int $mode
• array $options
• boolean $debug
• &$options

jOCSP_editDetail (line 730)

shows the form or url to edit a record in the foreign table

• return: (javascript)
• access: public

string jOCSP_editDetail (array $options, [boolean $debug = FALSE])

• array $options
• boolean $debug

jOCSP_showDetail (line 750)

shows the form or url to edit a record in the foreign table

• return: (javascript)
• access: public

string jOCSP_showDetail (array $options, [boolean $debug = FALSE])

• array $options
• boolean $debug

save (line 372)

save the filed definition form

• return:
  1. parent::save()
• version: pk-03-10-17
• version: pk-06-01-24
• version: pk-08-02-27

bool save ([ $debug = FALSE])

• $debug

---

Redefinition of:

DBMS_FIELD_DBLOOKUPSELECTLIST::save()

save the filed definition form

---

Redefined in descendants as:

• DBMS_FIELD_CLISELECT::save()
• DBMS_FIELD_CLI_TYPESELECT::save() : saves the posted values to the field object
• DBMS_FIELD_CST_TYPESELECT::save() : saves the edit form
• DBMS_FIELD_CURRENTUSER::save() : save the filed definition form
• DBMS_FIELD_DBMS_FORMFIELDSELECT::save()
• DBMS_FIELD_DBMS_FORMSELECT::save() : saves the postet values to the object but not to the db
• DBMS_FIELD_MEDIA::save() : save the filed definition form
• DBMS_FIELD_MEDIAFILE_SELID::save() : save the filed definition form
• DBMS_FIELD_PAGESELECT::save() : save the filed definition form
• DBMS_FIELD_PAGTMPL_SELECT::save()
• DBMS_FIELD_PROJECTSELECT::save()
• DBMS_FIELD_CLI_STATESELECT::save() : saves the edit form
• DBMS_FIELD_MODULESELECT::save()

setObjectVars (line 175)

convert old object vars to DBMS_FIELD_DBLOOKUPSELECTLIST and then calls the parent method

void setObjectVars (array $varArr, [boolean $debug = FALSE])

• array $varArr
• boolean $debug

---

Redefinition of:

DBMS_FIELD::setObjectVars()

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

---

Redefined in descendants as:

• DBMS_FIELD_CLI_TYPESELECT::setObjectVars() : convert old object vars to DBMS_FIELD_DBLOOKUPSELECTLIST and then calls the parent method
• DBMS_FIELD_CURRENTUSER::setObjectVars() : convert old object vars to DBMS_FIELD_DBLOOKUPSELECTLIST and then calls the parent method

Inherited Methods

Inherited From DBMS_FIELD_DBLOOKUPSELECTLIST

DBMS_FIELD_DBLOOKUPSELECTLIST::DBcheckEditInput()
DBMS_FIELD_DBLOOKUPSELECTLIST::editTbl_getFieldEditArr()
DBMS_FIELD_DBLOOKUPSELECTLIST::getClassCacheKey()
DBMS_FIELD_DBLOOKUPSELECTLIST::getDBValue()
DBMS_FIELD_DBLOOKUPSELECTLIST::getInputTag()
DBMS_FIELD_DBLOOKUPSELECTLIST::getListValue()
DBMS_FIELD_DBLOOKUPSELECTLIST::getMyValueQuery()
DBMS_FIELD_DBLOOKUPSELECTLIST::getNewBtn()
DBMS_FIELD_DBLOOKUPSELECTLIST::getScreenValue()
DBMS_FIELD_DBLOOKUPSELECTLIST::save()
DBMS_FIELD_DBLOOKUPSELECTLIST::setMyValues()
DBMS_FIELD_DBLOOKUPSELECTLIST::_getMyValueWhere()

Inherited From DBMS_FIELD_DBSELECTLIST

DBMS_FIELD_DBSELECTLIST::editTbl_getFieldEditArr()
DBMS_FIELD_DBSELECTLIST::getClassCacheKey()
DBMS_FIELD_DBSELECTLIST::getPopupLinkJs()
DBMS_FIELD_DBSELECTLIST::jOCSP_reloadOptionLst()
DBMS_FIELD_DBSELECTLIST::save()
DBMS_FIELD_DBSELECTLIST::setMyValues()

Inherited From DBMS_FIELD_SELECTLIST

DBMS_FIELD_SELECTLIST::editTabl_save()
DBMS_FIELD_SELECTLIST::editTbl_getFieldEditArr()
DBMS_FIELD_SELECTLIST::getArrayFromString()
DBMS_FIELD_SELECTLIST::getCheckRadio()
DBMS_FIELD_SELECTLIST::getExtJSConfigOptions()
DBMS_FIELD_SELECTLIST::getFormFieldSelect()
DBMS_FIELD_SELECTLIST::getFormFieldSelectAttributes()
DBMS_FIELD_SELECTLIST::getInputName()
DBMS_FIELD_SELECTLIST::getInputTag()
DBMS_FIELD_SELECTLIST::getListValue()
DBMS_FIELD_SELECTLIST::getOnChangedTag()
DBMS_FIELD_SELECTLIST::getOptionList()
DBMS_FIELD_SELECTLIST::getReloadButton()
DBMS_FIELD_SELECTLIST::getScreenValue()
DBMS_FIELD_SELECTLIST::getSearchCompTypes()
DBMS_FIELD_SELECTLIST::getSearchInputTag()
DBMS_FIELD_SELECTLIST::getSelectTag()
DBMS_FIELD_SELECTLIST::getValue()
DBMS_FIELD_SELECTLIST::jOCSP_getAdditonalFieldObjElems()
DBMS_FIELD_SELECTLIST::jOCSP_getReloadScript()
DBMS_FIELD_SELECTLIST::jOCSP_getRequiredModules()
DBMS_FIELD_SELECTLIST::setMyValues()
DBMS_FIELD_SELECTLIST::slashedValue()

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

CLASS_SRC_FILE = __FILE__ (line 47)

Inherited Constants

Inherited from DBMS_FIELD_DBLOOKUPSELECTLIST

DBMS_FIELD_DBLOOKUPSELECTLIST::CLASS_SRC_FILE

Inherited from DBMS_FIELD_DBSELECTLIST

DBMS_FIELD_DBSELECTLIST::CLASS_SRC_FILE