Class: I2CE Module Forms (4.1.7)
This article describes the class I2CE_Module_Forms .
- Extends the class: I2CE_Module.
- Location: Part of the module forms in the package I2CE 4.1.7-release
- Source: Defined in the file modules/Forms/lib/I2CE_Module_Forms.php on line 26
- Author: Luke Duncan <lduncan@intrahealth.org> carl leitner <litlfred@ibiblio.org>
- Since: v1.0.0
Variables
$isReview
A flag to determine if the page is a confirmation form. This will cause the form display to make all elements "hidden" and display the values as text for a confirmation view.
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 219
- Type: protected boolean $isReview
Methods
__construct()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 235
- Signature: public function __construct()
createDateIndexOnLastEntry()
Checks to make sure there is an index on the date column last_entry table named date. If it does not exist it adds it. Note: this should seem to need be in the last entry mdoule, but this existed before it was created. probably msotyl dead code at this point as noone should be less than 3.1
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 184
- Signature: protected function createDateIndexOnLastEntry()
finalizeDisplay()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 75
- Signature: public function finalizeDisplay($page)
- Parameters:
- $page
getField()
returns the indicated field from the indicated form that is responsible for the data in this node.
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 273
- Signature: public function getField($template,$form_field,$node)
- Parameters:
- $template
- string $form_field
The form name and field name separataed by a colon. Example $form_field = "salary:begin"; - mixed $node
Specfies the node at which the data is set. If $node is a DOMNode then it is the node. If null (default) then the data applies to the whole. Otherwise $node should specify the ID of some node in the DOM.- Default Value: null
- Returns: I2CE_Field
getForm()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 241
- Signature: public function getForm($template,$form,$node)
- Parameters:
- $template
- $form
- $node
- Default Value: null
getHooks()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 29
- Signature: static public function getHooks()
getMethods()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 125
- Signature: static public function getMethods()
hasPermission_form()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 143
- Signature: protected function hasPermission_form($node,$args)
- Parameters:
- $node
- $args
invisibleClass()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 62
- Signature: public function invisibleClass($class_name)
- Parameters:
- $class_name
isReview()
Get the review status
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 229
- Signature: public function isReview($template)
- Parameters:
- $template
processForms()
Process any form elements on the page. This method will parse all form elements on the page to replace the values if they are known. There are three type of form directives for a span. The first two are as follows and method_name(args)'> In each case we find the form with form name 'form_name'. In the first case, we call the processDom() method for the form field identified by form_field_name. For the seconcd case we call the method_name method of the form with the arguments specified by args. The last case is for In this case is like the first case except that the form used is the default form for this page.
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 313
- Signature: public function processForms($page)
- Parameters:
- $page
removeCache_hook()
Hooked method to marks a form as dirty (needs to be cached).
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 46
- Signature: public function removeCache_hook($args)
- Parameters:
- mixed $args
an array of two elements whose first element is a form object, the second is the user
- mixed $args
setForm()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 251
- Signature: public function setForm($template,$form,$node)
- Parameters:
- $template
- $form
- $node
- Default Value: null
setFormPriority()
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 113
- Signature: public function setFormPriority($page)
- Parameters:
- $page
setReview()
Set the isReview variable to true.
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 223
- Signature: public function setReview($template)
- Parameters:
- $template
upgrade()
Upgrade module method
- Defined in i2ce/modules/Forms/lib/I2CE_Module_Forms.php on line 167
- Signature: public function upgrade($old_vers,$new_vers)
- Parameters:
- $old_vers
- $new_vers
Inherited Methods
action_configure()
This public method is inherited from I2CE_Module->action_configure()
action_disable()
This public method is inherited from I2CE_Module->action_disable()
action_enable()
This public method is inherited from I2CE_Module->action_enable()
action_initialize()
This public method is inherited from I2CE_Module->action_initialize()
getCLIMethods()
This public method is inherited from I2CE_Module->getCLIMethods()
getConfig()
This public method is inherited from I2CE_Module->getConfig()
post_update()
This public method is inherited from I2CE_Module->post_update()
pre_upgrade()
This public method is inherited from I2CE_Module->pre_upgrade()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Fuzzy Methods
launchBackgroundProcess()
This method is inherited from I2CE_Module->launchBackgroundProcess()
launchBackgroundPHPScript()
This method is inherited from I2CE_Module->launchBackgroundPHPScript()
launchBackgroundPage()
This method is inherited from I2CE_Module->launchBackgroundPage()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()