Class DBMS_FIELD_SELECTLIST

Description

Implements interfaces:

Class DBMS_FIELD_SELECTLIST

handels select fields (<SELECT>) the class holds all values available in $this->myValues

in case of multiselect serialization is done with expolde and implode functions the default seperator is "\n" make sure the database column is big enough to hold all the values.

  • author: Peter Krebs <pitlinz@sourceforge.net>
  • version: pk-06-02-10
  • version: $Id: DBMS_FIELD_SELECTLIST.phpclass,v 1.33 2008/11/24 23:30:31 pitlinz Exp $
  • project: Open CSP-Management
  • license: GNU Public License

Located in /db/frmClasses/DBMS_FIELD_SELECTLIST.phpclass (line 50)

DBMS_FIELD
   |
   --DBMS_FIELD_SELECTLIST
Direct descendents
Class Description
 class DBMS_FIELD_ARRSELECTLIST Class DBMS_FIELD_ARRSELECTLIST
 class DBMS_FIELD_CMS_PAGECLASSSELECT Class DBMS_FIELD_CMS_PAGECLASSSELECT
 class DBMS_FIELD_DBATTRSELLIST Class DBMS_FIELD_DBATTRSELLIST
 class DBMS_FIELD_DBCOLSELECTLIST Class DBMS_FIELD_DBCOLSELECTLIST
 class DBMS_FIELD_DBSELECTLIST Class DBMS_FIELD_DBSELECTLIST
 class DBMS_FIELD_DIRSELECTLIST Class DBMS_FIELD_DIRSELECTLIST
 class DBMS_FIELD_FILESELECTLIST Class DBMS_FIELD_SELECTLIST
 class DBMS_FIELD_GLOBALARRSELECTLIST Class DBMS_FIELD_GLOBALARRSELECTLIST
 class DBMS_FIELD_GROUPSELECT Class DBMS_FIELD_GROUPSELECT
 class DBMS_FIELD_RADIOSELECT Class DBMS_FIELD_RADIOSELECT
 class DBMS_FIELD_SELINOUT Class DBMS_FIELD_SELINOUT
 class DBMS_FIELD_SER_ARRAY handle show readonly serilaized data in a table field
Variable Summary
Method Summary
 void editTabl_save ([ $debug = False])
 array editTbl_getFieldEditArr ([boolean $debug = False])
 array getArrayFromString (string $str)
 string getCheckRadio (string $aValue, [array $arrName = "DBVAL"], [boolean $debug = False])
 string getExtJSConfigOptions ([boolean $debug = False])
 void getFormFieldSelect (mixed $aValue, [boolean $debug = False])
 array getFormFieldSelectAttributes (boolean $debug)
 string getInputName ()
 string getInputTag (string $aValue, [array $arrName = "DBVAL"], [boolean $debug = False])
 string getListValue (mixed $aValue, [string $arrName = "DBVAL"], [boolean $debug = False])
 void getOnChangedTag (array $arrName)
 string getOptionList (array $aValArr, [bool $addNull = False], [bool $debug = False])
 string getReloadButton ([boolean $debug = False])
 string getScreenValue (mixed $aValue, [string $arrName = "DBVAL"], [boolean $debug = False])
 string getSearchCompTypes (string $arrName)
 string getSearchInputTag (mixed $aValue, [string $arrName = "DBVAL"], string $nameAdd)
 string getSelectTag (string $aValue, [array $arrName = "DBVAL"], [boolean $debug = False])
 string getValue (string $aValue,  &$err, [string $arrName = "DBVAL"], [bool $debug = False], array $err)
 array jOCSP_getAdditonalFieldObjElems ([boolean $debug = False])
 string jOCSP_getReloadScript ([boolean $debug = False])
 string jOCSP_getRequiredModules ([boolean $debug = False])
 void setMyValues ([string $arrName = "DBVAL"], [bool $debug = False])
 string slashedValue (string $aValue,  &$err, [string $arrName = "DBVAL"], [bool $debug = False], array $err)
Variables
boolean $ajax_onChange_FuncName = NULL (line 175)
  • since: pk-07-03-07
  • access: protected
string $classSrcFile = __FILE__ (line 60)

source file of the class

  • since: pk-04-10-05
  • access: protected

Redefinition of:
DBMS_FIELD::$classSrcFile
source file of the class

Redefined in descendants as:
string $extJSxType = 'combo' (line 182)

xtype to use in the extJS framework for the field

  • access: protected

Redefinition of:
DBMS_FIELD::$extJSxType
xtype to use in the extJS framework for the field
boolean $lstValueIsHtml = False (line 159)

do not htmlspecialchars list values

  • since: pk-06-05-29
  • access: protected
boolean $multiselect = False (line 76)
  • access: protected
char $mySeperator = "\n" (line 151)

seperator used in multiselect mode

NOTE: this::save() sets this too

  • since: pk-06-02-10
  • access: protected

Redefined in descendants as:
array $myValues = array() (line 70)
  • access: protected
boolean $notInLstValues = False (line 142)

show not in list values

if true all values of $valArr are added to the list even if the are not in myValues

  • since: pk-05-12-01
  • access: protected
boolean $nullToZero = False (line 96)
  • var: set the NullOptionValue to 0
  • since: pk-05-12-12
  • access: protected
int $reloadFormOnChange = 0 (line 114)
  • var: (if >0 a onChange event forces to reload the form)
  • since: pk-04-09-15
  • access: protected
string $selectAddTag = "" (line 108)
  • var: (additional html tag attributes for &lt;select ...&gt;)
  • access: protected
int $selectsize = 1 (line 102)
  • var: (added into &lt;select ... size=&quote;$this->selectsize&quote; ... &gt;)
  • access: protected
boolean $showAsCheckRadio = False (line 131)

use a table of checkboxes or radio boxes instead of

a select

  • since: pk-05-09-16
  • access: protected
boolean $showValuesInList = False (line 168)

wether to lookup in the select list for the representation of a value

or just output the value in list view

  • since: pk-06-07-22
  • access: protected
mixed $static_fixedSelSize = False (line 122)
  • staticvar: boolean $static_fixedSelSize:
  • since: pk-05-08-29
  • 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::$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
Methods
editTabl_save (line 668)
  • access: public
void editTabl_save ([ $debug = False])
  • $debug
editTbl_getFieldEditArr (line 649)

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-08-02-06
  • since: pk-06-04-26
  • access: protected
array editTbl_getFieldEditArr ([boolean $debug = False])
  • boolean $debug

Redefined in descendants as:
getArrayFromString (line 205)

extracts the array out of the input string

where it is inter like

  1.      key:valuen

array getArrayFromString (string $str)
  • string $str
getCheckRadio (line 348)

returns the html code for the checkbox or radiobox table

  • version: pk-06-02-10
  • version: pk-06-10-30 bugfix 1 entry uses 2 columsn
  • todo: notInLstValues
  • since: pk-05-05-16
string getCheckRadio (string $aValue, [array $arrName = "DBVAL"], [boolean $debug = False])
  • string $aValue
  • array $arrName
  • boolean $debug
getExtJSConfigOptions (line 875)

returns options of an ext js field config object

NOTE the return string is NOT enclosed by {}

  • return: (json)
  • since: pk-08-09-09
  • access: public
string getExtJSConfigOptions ([boolean $debug = False])
  • boolean $debug
getFormFieldSelect (line 971)

returns the html code for the &lt;select&gt field

  • access: protected
void getFormFieldSelect (mixed $aValue, [boolean $debug = False])
  • mixed $aValue
  • boolean $debug

Redefined in descendants as:
getFormFieldSelectAttributes (line 940)

returns an array of &lt;select&gt; attributes

array getFormFieldSelectAttributes (boolean $debug)
  • boolean $debug
getInputName (line 612)

returns the input name

  • version: pk-08-02-06
string getInputName ()
getInputTag (line 285)

returns the html code

  • version: pk-04-08-31 $debug added
  • version: pk-05-09-16
string getInputTag (string $aValue, [array $arrName = "DBVAL"], [boolean $debug = False])
  • string $aValue
  • array $arrName
  • boolean $debug

Redefinition of:
DBMS_FIELD::getInputTag()
returns the html code for a editable formular element

Redefined in descendants as:
getListValue (line 473)

returns the html code to show the value(s) in a list (table column)

  • version: pk-06-10-09
  • since: pk-06-07-22
string getListValue (mixed $aValue, [string $arrName = "DBVAL"], [boolean $debug = False])
  • mixed $aValue
  • string $arrName
  • boolean $debug

Redefinition of:
DBMS_FIELD::getListValue()
returns the html representation of the field in a list (table col)

Redefined in descendants as:
getOnChangedTag (line 262)

returns the html select tag onChange statement to reload the form

  • since: pk-04-08-18
void getOnChangedTag (array $arrName)
  • array $arrName
getOptionList (line 1022)

returns a string with the options

calls setMyValues to be sure $this->myValues is set correkt

  • access: protected
string getOptionList (array $aValArr, [bool $addNull = False], [bool $debug = False])
  • array $aValArr
  • bool $addNull
  • bool $debug

Redefined in descendants as:
getReloadButton (line 1091)

returns the html code for a button to reload the form

  • global: $OCSP_CONF 0:
  • version: pk-06-10-10 link name added
  • version: pk-07-08-31
  • version: pk-08-02-12
  • since: pk-04-08-18
  • access: protected
string getReloadButton ([boolean $debug = False])
  • boolean $debug

Redefined in descendants as:
getScreenValue (line 431)

returns the html code for the readonly field

  • version: pk-04-09-08
  • version: pk-06-02-10
string getScreenValue (mixed $aValue, [string $arrName = "DBVAL"], [boolean $debug = False])
  • mixed $aValue
  • string $arrName
  • boolean $debug

Redefinition of:
DBMS_FIELD::getScreenValue()
returns the html representation of the field

Redefined in descendants as:
getSearchCompTypes (line 517)

returns the html code for the search comp types

string getSearchCompTypes (string $arrName)
  • string $arrName
getSearchInputTag (line 533)

returns the html code for a searchformular element

  • version: pk-06-02-10
string getSearchInputTag (mixed $aValue, [string $arrName = "DBVAL"], string $nameAdd)
  • mixed $aValue: the value to set
  • string $arrName
  • string $nameAdd: @see DBMS_FIELD::getInputTag()
getSelectTag (line 313)

returns the html code for the select

  • version: pk-06-02-10
  • deprecated: since pk-08-02-06
  • since: pk-05-05-16
  • access: protected
string getSelectTag (string $aValue, [array $arrName = "DBVAL"], [boolean $debug = False])
  • string $aValue
  • array $arrName
  • boolean $debug

Redefined in descendants as:
getValue (line 1133)

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

  • version: pk-03-12-01
  • version: pk-05-12-10
  • 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

Redefined in descendants as:
jOCSP_getAdditonalFieldObjElems (line 763)

returns additional object elements of the field object

array definition: [elemName] = value

NOTE: do not js_escapte value this is done when building the json object

  • version: pk-08-06-02
  • since: pk-08-02-06
  • access: protected
array jOCSP_getAdditonalFieldObjElems ([boolean $debug = False])
  • boolean $debug

Redefined in descendants as:
jOCSP_getReloadScript (line 811)

returns a javascript to be called for reloading the form

  • todo: could sometimes not get the controll
  • access: public
string jOCSP_getReloadScript ([boolean $debug = False])
  • boolean $debug
jOCSP_getRequiredModules (line 731)

returns an array of jOCSP/jQuery Modules which are required

$arr_ret[]="script url";

  • version: pk-08-06-02
  • access: public
string jOCSP_getRequiredModules ([boolean $debug = False])
  • boolean $debug

Redefined in descendants as:
setMyValues (line 243)

does nothing in this class becaus $this->myValues

is stored internal. Is redefined in descendants make sure this is called once before accessing $this->myValues

  • version: pk-03-12-18
void setMyValues ([string $arrName = "DBVAL"], [bool $debug = False])
  • string $arrName
  • bool $debug

Redefined in descendants as:
slashedValue (line 573)

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

  • version: pk-03-12-14
  • deprecated: since pk-08-08-11
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

Redefined in descendants as:

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

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