Class: I2CE Module Forms

This article desrcibes the class I2CE_Module_Forms which extends the class I2CE_Module It is contained in the module forms in the package I2CE

The class is defined in the file: modules/Forms/lib/I2CE_Module_Forms.php

@author Luke Duncan <lduncan@intrahealth.org> carl leitner <litlfred@ibiblio.org>

@since v1.0.0

@version v2.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.

• Type: protected n $isReview

$showForm

A flag to determine if the page is a form and should display the form elements.

If this is false then instead of adding in form elements for form fields the value will be displayed.

• Type: protected $showForm

Methods

__construct()

• 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.

• Signature: protected function createDateIndexOnLastEntry()

getCLIHooks()

• Signature: static public function getCLIHooks()

getField()

returns the indicated field from the indicated form that is responsible for the data in this node. 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.

• Signature: public function getField($template,$form_field,$node)
• Returns: I2CE_Field

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
  • Default Value: null

getHooks()

• Signature: static public function getHooks()

getMethods()

• Signature: static public function getMethods()

hasPermission_form()

• Signature: protected function hasPermission_form($calling_args)

Parameters:

• $calling_args

invisibleClass()

• Signature: public function invisibleClass($class_name)

Parameters:

• $class_name

isReview()

Get the review status

• 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.

• Signature: public function processForms($page)

Parameters:

• $page

setForm()

• Signature: public function setForm($template,$form,$node)

Parameters:

• $template
• $form
• $node
  • Default Value: null

setFormPriority()

• Signature: public function setFormPriority($page)

Parameters:

• $page

setReview()

Set the {@link isReview} variable to true.

• Signature: public function setReview($template)

Parameters:

• $template

setShowForm()

Set the {@link showForm} flag to true.

• Signature: public function setShowForm($template)

Parameters:

• $template

showForm()

• Signature: public function showForm($template)
• Returns: boolean

Parameters:

• $template

upgrade()

Upgrade module method

• Signature: public function upgrade($old_vers,$new_vers)

Parameters:

• $old_vers
• $new_vers

validate_formfield()

Hooked Function to check if a fieldObj is valid

• Signature: public function validate_formfield($fieldObj)

Parameters:

• I2CE_FormField $fieldObj

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