Docs for page forms.phpinc

/db/forms/forms.phpinc

Description

forms.phpinc

provides database settings and functions to handle DBMS_FORMS uses $GLOABLS['DBMS_FORM'] to store the forms in an array only pointers are returned in the public functions

author: Peter Krebs <p.krebs@lvus.at>
copyright: (c) 2002-2003 by Peter Krebs and Landesverlag Unternehmensservice
deprecated: since pk-08-06-23
since: pk-05-02-16 moved form php/db to php/db/forms
project: Open CSP-Management
filesource: Source Code for this file
license: GNU Public License

Includes

require_once ($str_cachePath."frmFldsDefinition.cache") (line 55)

require_once (__OCSP_PHPINCPATH__."db"._OCSP_DIRSEP_."forms"._OCSP_DIRSEP_."DBMS_FORM.phpclass") (line 122)

Constants

require_once ($GLOBALS['PHPFORMPATH']."DBMS_FORM.phpclass") (line 120)

Constants

DBMS_FLDTYPE_HTMLCODE = "htmlcode" (line 38)

DBMS_FLDTYPE_SELECTLIST = "selectlist" (line 37)

DBMS_NO_DBFIELD = "__NO-DBFIELD__" (line 44)

since: pk-03-12-15

FRM_MODE_COPY = 7 (line 114)

Constants

FRM_MODE_DELETE = 6 (line 113)

Constants

FRM_MODE_EDIT = 2 (line 109)

Constants

FRM_MODE_HIDDEN = 3 (line 110)

Constants

FRM_MODE_LIST = 4 (line 111)

Constants

FRM_MODE_NEW = 1 (line 108)

Constants

FRM_MODE_READONLY = 0 (line 107)

Constants

FRM_MODE_SEARCH = 5 (line 112)

Constants

Functions

DBMS_field_ChangeClass (line 607)

changes the class of a form field

Constants

since: pk-05-02-09

DBMS_FIELD DBMS_field_ChangeClass (DBMS_FIELD $fld, string $newClassName, [boolean $debug = FALSE])

DBMS_FIELD $fld
string $newClassName
boolean $debug

DBMS_field_IncludeAllSrc (line 656)

includes all field object class sources

Constants

version: pk-05-08-26 default for $debug added
version: pk-05-10-10 DBMD_FLDCLASS_DESC -> DBMS_FLDCLASS_DESC
since: pk-05-08-01

void DBMS_field_IncludeAllSrc ([boolean $debug = FALSE])

boolean $debug

DBMS_field_IncludeSrc (line 532)

includes the form field class src file

Constants

since: pk-05-02-09

boolean DBMS_field_IncludeSrc ([string $className = "DBMS_FIELD"], [boolean $debug = FALSE])

string $className
boolean $debug

DBMS_form_cacheFrm (line 139)

writes a form object to file cache

Constants

version: pk-04-07-23
version: pk-05-01-13

bool DBMS_form_cacheFrm (DBMS_FORM $frmObj, [bool $debug = FALSE])

DBMS_FORM $frmObj
bool $debug: since pk-05-01-13

DBMS_form_cache_ClearId (line 240)

clears the cache for a form

Constants

since: pk-04-07-28

void DBMS_form_cache_ClearId ( $aId)

$aId

DBMS_form_cache_GetId (line 179)

gets a form from the file cache with id

Constants if file cache does not exists or is expired NULL is returned

DBMS_FORM DBMS_form_cache_GetId (int $aId, [bool $debug = FALSE])

int $aId: the form ID
bool $debug

DBMS_form_cache_GetName (line 214)

gets a form from the file cache with unique name

Constants if file cache does not exists or is expired NULL is returned

DBMS_FORM DBMS_form_cache_GetName (string $aName, [bool $debug = FALSE])

string $aName: the unique name of the form
bool $debug: since pk-05-01-20

DBMS_form_loadClassId (line 363)

loads a form of a special type (subclass ob DBMS_FORM)

Constants the subcluss must have the method castFromFrmObj() if not an object of DBMS_FORM is returned

you also have to include the class source before calling this method

since: pk-06-12-21

DBMS_FORM &DBMS_form_loadClassId (string $className, int $aId, [boolean $debug = FALSE], [boolean $reloadGlobals = FALSE])

string $className: name of the form class
int $aId
boolean $debug
boolean $reloadGlobals: if TRUE the form in $GLOBALS['DBMS_NAMED_FORMS'] is reloaded from cache or DB

DBMS_form_loadClassName (line 474)

loads a form of a special type (subclass ob DBMS_FORM)

Constants the subcluss must have the method castFromFrmObj() if not an object of DBMS_FORM is returned

you also have to include the class source before calling this method

since: pk-06-12-17

DBMS_FORM &DBMS_form_loadClassName (string $className, string $frmName, [boolean $debug = FALSE], [boolean $reloadGlobals = FALSE])

string $className: name of the form class
string $frmName: nome of the form
boolean $debug
boolean $reloadGlobals: if TRUE the form in $GLOBALS['DBMS_NAMED_FORMS'] is reloaded from cache or DB

DBMS_form_loadId (line 314)

returns a POINTER to the form with id $aId

Constants loads a from from cache (or db) into GLOABALS['DBMS_FORMS'][$aId] array if the array element is not an object. Uses $OCSP_OBJ['USRDB'] as DB Object returns a pointer to the global array element

version: pk-04-07-29 return changed FALSE -> NULL
version: pk-04-08-09
version: pk-06-07-28

DBMS_FORM &DBMS_form_loadId (int $aId, [boolean $debug = FALSE], [boolean $forceDB = FALSE])

int $aId
boolean $debug
boolean $forceDB: force a reload from the database since pk-06-07-28

DBMS_form_loadName (line 405)

returns a POINTER to the form with unique name $name

version: pk-04-07-29 return changed FALSE -> NULL
version: pk-05-02-15 check if $aName not empty
version: pk-06-11-28 $useGlobals added

DBMS_FORM &DBMS_form_loadName (string $aName, [boolean $debug = FALSE], [boolean $reloadGlobals = FALSE])

string $aName
boolean $debug
boolean $reloadGlobals: if TRUE the form in $GLOBALS['DBMS_NAMED_FORMS'] is reloaded from cache or DB

DBMS_form_new (line 259)

generates a new form

Constants

int DBMS_form_new (string $aName, [string $tbls = ""], [int $asDefault = 0])

string $aName
string $tbls
int $asDefault

DBMS_form_register (line 280)

Constants

since: pk-05-01-13

bool DBMS_form_register ( &$aForm, [bool $debug = FALSE], DBMS_FORM $aForm)

DBMS_FORM $aForm
bool $debug
&$aForm

DBMS_form_unset (line 506)

destroies a FORM Object

Constants

since: pk-04-07-30

void DBMS_form_unset (int $aId, [ $debug = FALSE])

int $aId
$debug

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