Class DBMS_FIELD_HTMLCODE

• author: <pitlinz@users.sourceforge.net>
• version: $Id: DBMS_FIELD_HTMLCODE.phpclass,v 1.11 2008/12/12 17:35:14 pitlinz Exp $
• project: Open CSP-Management
• license: GNU Public License

Located in /db/frmClasses/DBMS_FIELD_HTMLCODE.phpclass (line 32)

DBMS_FIELD
   |
   --DBMS_FIELD_TEXTAREA
      |
      --DBMS_FIELD_HTMLCODE

bool $allowHTML = TRUE (line 76)

• var: overwrite parent set to TRUE
• access: protected

---

Redefinition of:

DBMS_FIELD_TEXTAREA::$allowHTML

mixed $className = "HTML-Code" (line 66)

---

Redefinition of:

DBMS_FIELD_TEXTAREA::$className

source file of the class

---

Redefined in descendants as:

• DBMS_FIELD_HTMLFCKEDITOR::$className

string $classSrcFile = __FILE__ (line 64)

source file of the class

• since: pk-05-02-08

---

Redefinition of:

DBMS_FIELD_TEXTAREA::$classSrcFile

source file of the class

---

Redefined in descendants as:

• DBMS_FIELD_HTMLFCKEDITOR::$classSrcFile : source file of the class

string $editorUrl = "" (line 84)

• var: which editor url to start with edit button
• access: protected

mixed $fb_allowCd_Grp = -1 (line 109)

• access: protected

mixed $fb_allowMkDir_Grp = -80 (line 108)

• access: protected

mixed $fb_overWrite_Grp = -81 (line 110)

• access: protected

mixed $fb_uploadOnly = False (line 112)

• access: protected

mixed $fb_upload_Grp = -82 (line 111)

• access: protected

mixed $imgDefaultDir = "" (line 107)

• access: protected

string $imgRootDir = "" (line 106)

FCKeditor definition

• var: rootPath where images are stored (filebrowse is jailed to this dir)
• since: pk-06-11-09
• access: protected

bool $isSearchable = FALSE (line 72)

• var: overwrite parent set to FALSE
• access: protected

---

Redefinition of:

DBMS_FIELD_TEXTAREA::$isSearchable

bool $nlToBr = FALSE (line 80)

• var: overwrite parent set to FALSE
• access: protected

---

Redefinition of:

DBMS_FIELD_TEXTAREA::$nlToBr

mixed $ocspModuleKey = 'CMS' (line 113)

• access: protected

bool $replaceServer = TRUE (line 88)

• var: replace http://server/ with /
• access: protected

Inherited Variables

Inherited from DBMS_FIELD_TEXTAREA

DBMS_FIELD_TEXTAREA::$cols
DBMS_FIELD_TEXTAREA::$extJSxType
DBMS_FIELD_TEXTAREA::$lstTAreaCols
DBMS_FIELD_TEXTAREA::$lstTAreaRows
DBMS_FIELD_TEXTAREA::$myHTMLOutMode
DBMS_FIELD_TEXTAREA::$myLstOutMode
DBMS_FIELD_TEXTAREA::$myLstOutSize
DBMS_FIELD_TEXTAREA::$myROShowMode
DBMS_FIELD_TEXTAREA::$rows
DBMS_FIELD_TEXTAREA::$srcVersion
DBMS_FIELD_TEXTAREA::$static_Showmodes
DBMS_FIELD_TEXTAREA::$static_wrapMode
DBMS_FIELD_TEXTAREA::$wrap

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::$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::$tabIndex
DBMS_FIELD::$toolTip
DBMS_FIELD::$toolTipAsTitle
DBMS_FIELD::$trimValue

editTblForm (line 366)

echos input form for field definition

• version: pk-03-10-10

void editTblForm ([bool $showSize = FALSE], [ $allowHTML = TRUE])

• bool $showSize: show size and maxlength input
• $allowHTML

---

Redefinition of:

DBMS_FIELD_TEXTAREA::editTblForm()

echos input form for field definition

---

Redefined in descendants as:

• DBMS_FIELD_HTMLFCKEDITOR::editTblForm() : echos input form for field definition

editTbl_getFieldEditArr (line 235)

returns an array of field to be 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
• version: pk-06-11-09
• since: pk-06-04-26

array editTbl_getFieldEditArr ([boolean $debug = FALSE])

• boolean $debug

---

Redefinition of:

DBMS_FIELD_TEXTAREA::editTbl_getFieldEditArr()

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

getBasePath (line 125)

returns the base path (DOCUMENTROOT or PROJECT PATH)

• access: protected

string getBasePath ()

getHtmlTag (line 604)

gets a htmltag for the value

this is mainly used in CMS Module

• since: pk-06-09-29

string getHtmlTag (mixed $aValue, [string $arrName = "DBVAL"], [boolean $debug = FALSE])

• mixed $aValue
• string $arrName
• boolean $debug

---

Redefinition of:

DBMS_FIELD_TEXTAREA::getHtmlTag()

gets a htmltag for the value

getImgDefaultPath (line 185)

• return: NULL in case of $this->imgDefaultDir is empty
• since: pk-06-12-04

string getImgDefaultPath ([boolean $fullPath = FALSE], [boolean $debug = FALSE])

• boolean $fullPath: include the imgRootPath
• boolean $debug

getImgRootPath (line 139)

• return: NULL in case of $this->imgRootDir is empty
• since: pk-06-12-04

string getImgRootPath ([boolean $fullPath = TRUE], [boolean $debug = FALSE])

• boolean $fullPath: include the linux path from /
• boolean $debug

getInputTag (line 420)

returns a string with the HTML input-tag for the field

• version: pk-03-11-27 layout changed
• version: pk-05-02-08 $nameAdd added
• version: pk-07-01-11 check imgRootDir as template for FCKeditor
• version: pk-07-02-14 append session to editorUrl
• version: pk-08-01-15 fixed editor url to FCKeditor

string getInputTag (string $aValue, [string $arrName = "DBVAL"], [string $nameAdd = ""], [ $debug = FALSE])

• string $aValue: the value to show
• string $arrName: name of the form array used in name=
• string $nameAdd: add string to the field name
• $debug

---

Redefinition of:

DBMS_FIELD_TEXTAREA::getInputTag()

returns the html code for a editable formular element

---

Redefined in descendants as:

• DBMS_FIELD_HTMLFCKEDITOR::getInputTag() : returns a string with the HTML input-tag for the field

getRootDir (line 171)

returns the root dir (without base path)

• access: public

string getRootDir ()

getValue (line 557)

returns the value with slashes create use in a db statement do some textreplaces before - because the editors always adds the url - to avoid jumping into a test system

calls parent::slashedValue()

• version: pk-03-11-27 DB-Object used instead of DB_.. function
• version: pk-06-12-04 replace HTMLspecialChars

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

• string $aValue: the value
• array $err: error array
• string $arrName: DBVAL
• &$err
• $debug

jOCSP_getAdditonalFieldObjElems (line 489)

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

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

array jOCSP_getAdditonalFieldObjElems ([boolean $debug = False])

• boolean $debug

jOCSP_getRequiredModules (line 466)

returns an array of jOCSP/jQuery Modules which are required

$arr_ret[]="script url";

• version: pk-08-10-07
• access: public

string jOCSP_getRequiredModules ([boolean $debug = False])

• boolean $debug

jOCSP_openEditor (line 506)

retuns a js command to change the directory

• return: (js)
• access: public

string jOCSP_openEditor (array $request, boolean $debug)

• array $request
• boolean $debug

save (line 379)

saves the field definition from $_POST array

• version: pk-06-11-09

boolean save ()

---

Redefinition of:

DBMS_FIELD_TEXTAREA::save()

saves the field definition from $_POST array

---

Redefined in descendants as:

• DBMS_FIELD_HTMLFCKEDITOR::save() : saves the field definition from $_POST array

setRootDir (line 161)

sets the root dir

• access: public

void setRootDir (string $aRootDir, [boolean $debug = False])

• string $aRootDir
• boolean $debug

slashedValue (line 584)

returns the value with slashes create use in a db statement do some textreplaces before - because the editors always adds the url - to avoid jumping into a test system

calls parent::slashedValue()

• version: pk-03-11-27 DB-Object used instead of DB_.. function

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

• string $aValue: the value
• array $err: error array
• string $arrName: DBVAL
• &$err
• $debug

Inherited Methods

Inherited From DBMS_FIELD_TEXTAREA

DBMS_FIELD_TEXTAREA::editTblForm()
DBMS_FIELD_TEXTAREA::editTbl_getFieldEditArr()
DBMS_FIELD_TEXTAREA::getExtJSConfigOptions()
DBMS_FIELD_TEXTAREA::getHtmlTag()
DBMS_FIELD_TEXTAREA::getInputTag()
DBMS_FIELD_TEXTAREA::getListValue()
DBMS_FIELD_TEXTAREA::getScreenValue()
DBMS_FIELD_TEXTAREA::save()

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

Inherited Constants

Inherited from DBMS_FIELD_TEXTAREA

DBMS_FIELD_TEXTAREA::CLASS_SRC_FILE