Docs for page DBMS_FIELD.phpclass

/db/frmClasses/DBMS_FIELD.phpclass

Description

Class file DBMS_FIELD.phpclass

author: Peter Krebs <pitlinz@sourceforge.net>
version: $Id: DBMS_FIELD.phpclass,v 1.54 2008/12/04 16:02:28 peterkrebs Exp $
project: Open CSP-Management
filesource: Source Code for this file
license: GNU Public License

Classes

Class	Description
DBMS_FIELD

Includes

require_once (__OCSP_PHPINCPATH__."db"._OCSP_DIRSEP_."db.phpinc") (line 21)

requirements

Constants

DBMS_NO_DBFIELD = "__NO-DBFIELD__" (line 32)

since: pk-07-10-26

DMBS_FIELD_DEFAULT_SIZE = 30 (line 33)

Variables

array ${$this->myDataArrName} (line 2423)

get the link url for a list entry

return: empty if no link is to show a url if the field is linked or [EDIT] if the edit link can be used
version: pk-06-10-19
version: pk-06-10-25 "bugfix" parse link as template
version: pk-07-10-27 $this->myDataArrName instead of $GLOBAL

Functions

checkControl (line 3294)

sets $this->myControll form $this->myForm if not pcf_is_instance_of $str_className

boolean checkControl ([string $str_className = 'OCSP_FRMCONTR'], [boolean $debug = False])

string $str_className
boolean $debug

checkControll (line 3281)

alias for $this->checkControl()

deprecated: since pk-08-11-27

boolean checkControll ([string $str_className = 'OCSP_FRMCONTR'], [boolean $debug = False])

string $str_className
boolean $debug

clearError (line 2759)

void clearError ()

editTabl_save (line 3095)

save the filed definition form

boolean editTabl_save ([boolean $debug = False])

boolean $debug

editTbl_getFieldEditArr (line 3074)

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

the array is in the form:

[_sectionName_]
[TITLE] -> string
[_rowName_]
[FLDLAB] (complete html code with <td></td>)
[FLDVAL] (complete html code with <td></td>)
[FLDTIT] (title of the label column)

NOTE as this is not implemented in the whole classTree at the moment ensure all parents use editTbl_echoForm() in theire editTblForm otherwise you'll get a mismatch of field order

version: pk-06-07-17 HIDDEN added to array
version: pk-06-08-15 FLDTIT added
version: pk-06-09-12 Tabs & Link showQuery added
version: pk-07-08-31 language file
since: pk-06-04-26

array editTbl_getFieldEditArr ([boolean $debug = False])

boolean $debug

exportCSV (line 2883)

returns if the field is to be added to the csv export

since: pk-06-09-27

boolen exportCSV ()

getAjaxFldKey (line 2797)

returns a serialized array to identify the field in the called ajax script

since: pk-07-09-05
requires: pcf_md5.phpinc

string getAjaxFldKey ()

getAssignment (line 2688)

void getAssignment ( $aValue, &$err, [ $arrName = "DBVAL"], [ $debug = False])

$aValue
&$err
$arrName
$debug

getControl (line 3258)

returns the controll object

access: public

OCSP_FRMCONTR &getControl ()

getControll (line 3247)

alias for $this->getControl()

deprecated: since pk-08-11-24

OCSP_FRMCONTR &getControll ()

getCSV_Value (line 2901)

returns the CSV value of field

since: pk-06-09-27

string getCSV_Value (mixed $aValue, [string $arrName = "DBVAL"], [boolean $debug = False], char $txtSep)

mixed $aValue
string $arrName
char $txtSep: enclose strings in $txtSep
boolean $debug

getDOMId (line 3020)

returns a unique DOM id for the field

Note: $this->myDOMId MUST NOT be stored in the db make sure it is excluded

since: pk-07-07-29

string getDOMId ()

getErrorMsg (line 2733)

returns the errMsg

since: pk-07-07-11

string getErrorMsg ()

getExtJSConfigOptions (line 3416)

returns options of an ext js field config object

NOTE the return string is NOT enclosed by {}

return: of json object values
since: pk-08-09-08

array getExtJSConfigOptions ([boolean $debug = False])

boolean $debug

getExtJSxType (line 3400)

returns the xtype of the field

see: http://extjs.com/deploy/dev/docs/output/Ext.Component.html

string getExtJSxType ()

getFormFieldTag (line 3490)

returns the html code for the field value input / show

string getFormFieldTag (int $mode, [mixed $aValue = NULL], [boolean $debug = False])

int $mode
mixed $aValue
boolean $debug

getFormLabelTag (line 3473)

returns the html tag for the label

string getFormLabelTag (int $mode, [boolean $debug = False])

int $mode
boolean $debug

getGrpFld (line 3526)

version: pk-07-08-08
since: pk-04-02-23

DBMS_FIELD &getGrpFld ([bool $debug = False])

bool $debug

getGrpKey (line 3514)

since: pk-04-02-23

string getGrpKey ()

getInputName (line 3006)

returns the input name

string getInputName ()

getJsName (line 2777)

retuns a string which can be used in js var and functions to name the field

since: pk-07-03-02

string getJsName ()

getSearchCompTypes (line 2468)

returns the html code for the search compare type select

since: pk-04-09-09

string getSearchCompTypes (string $arrName)

string $arrName

getSearchInputTag (line 2453)

returns the html code for a searchformular element

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

mixed $aValue: the value to set
string $arrName

getTableValSelect (line 2502)

returns a html select with all values (distinct) where $aValue is selected

NOTE only works on database fields

version: pk-07-01-15
todo: object value tables
since: pk-05-10-18

string getTableValSelect ( &$aValue, [string $arrName = ""], [string $selTagAdd = ""], [string $whereCond = ""], [ $nullLabel = ""], [ $debug = False], mixed $aValue)

mixed $aValue
string $arrName
string $selTagAdd: added into <select ...>
string $whereCond: added to query ($s_query="SELECT ... FROM TABLE ".$whereCond." ORDER BY")
&$aValue
$nullLabel
$debug

getView (line 3205)

returns the view object

access: public

OCSP_FRMVIEW &getView ()

hasErrors (line 2723)

returns if the field has an error ($this->errMsg not empty)

since: pk-07-07-11

boolean hasErrors ()

jOCSP_getFieldObj (line 3357)

returns the javascript code to register the field to an form

return: (json)

string jOCSP_getFieldObj ([boolean $debug = False])

boolean $debug

js_register_field (line 2814)

js code that ensures the form is registered

return: (js-code)
deprecated: since pk-08-02-22

string js_register_field ([string $aJsName = ""], [string $aName = ""], [boolean $debug = False])

string $aJsName
string $aName
boolean $debug

searchWhere (line 2658)

returns a where part for sql queries out of search form input

version: pk-07-02-14 ($this->myDataArrName)

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

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

setControl (line 3235)

sets the controll object

access: public

void setControl ( &$aControl, OCSP_FRMCONTR $aControl)

OCSP_FRMCONTR $aControl
&$aControl

setControll (line 3224)

alias for $this->setControl()

deprecated: since pk-08-11-24

void setControll ( &$aControl, OCSP_FRMCONTR $aControl)

OCSP_FRMCONTR $aControl
&$aControl

setDOMId (line 3036)

sets the unique DOM id for the field

since: pk-08-06-09

void setDOMId (string $aDOMId)

string $aDOMId

setErrorMsg (line 2747)

sets an error msg

since: pk-07-07-29

void setErrorMsg (string $aErrorMsg, [boolean $append = True], [boolean $debug = False])

string $aErrorMsg
boolean $append: (if True append the message else overwrite the old message)
boolean $debug

setGrpKey (line 3506)

since: pk-04-02-23

void setGrpKey (string $aKey)

string $aKey

setView (line 3194)

sets the view object

access: public

void setView ( &$aView, OCSP_FRMVIEW $aView)

OCSP_FRMVIEW $aView
&$aView

slashedValue (line 2626)

returns the value with slashes create use in a db statement

version: pk-03-11-27 DB-Object used instead of DB_.. function
version: pk-03-12-13 use $this->getValue to check the Value
version: pk-04-06-02 handling 0

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

xmladdDOMElement (line 2927)

version: pk-05-09-14

bool; xmladdDOMElement ( &$domObj, &$fldRoot, [ $base64 = True], [ $debug = False], string $fldRoot)

string $fldRoot
&$domObj
&$fldRoot
$base64
$debug

xml_loadDomElement (line 2961)

void xml_loadDomElement ( &$fldRoot, [ $debug = False])

&$fldRoot
$debug

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