|
|
| (19 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class ''I2CE_Module_Forms''.
| | #REDIRECT [[Class: I2CE_Module_Forms (4.1.7)]] |
| *Extends the class: [[Class: I2CE_Module | I2CE_Module]].
| |
| *Location: Part of the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/lib/I2CE_Module_Forms.php modules/Forms/lib/I2CE_Module_Forms.php]
| |
| *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.
| |
| *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $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.
| |
| *Signature: public function getField($template,$form_field,$node)
| |
| *Parameters:
| |
| **$template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_field <br/>The form name and field name separataed by a colon. Example $form_field = "salary:begin";
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $node <br/>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
| |
| ===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 <span type='form' name='form_name:form_field_name'></span> and <span type='form' name='form_name->method_name(args)'></span> 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 <span type='form' name='form_field_name'></span> 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 isReview variable to true.
| |
| *Signature: public function setReview($template)
| |
| *Parameters:
| |
| **$template
| |
| ===setShowForm()===
| |
| Set the showForm flag to true.
| |
| *Signature: public function setShowForm($template)
| |
| *Parameters:
| |
| **$template
| |
| ===showForm()===
| |
| *Signature: public function showForm($template)
| |
| *Parameters:
| |
| **$template
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===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:
| |
| ** [[Class: I2CE_FormField | I2CE_FormField]] $fieldObj
| |
| ==Inherited Methods==
| |
| ===__construct()===
| |
| This public method is inherited from [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
| |
| | |
| ===action_configure()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
| |
| | |
| ===action_disable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
| |
| | |
| ===action_enable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
| |
| | |
| ===action_initialize()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_initialize() | I2CE_Module->action_initialize()]]
| |
| | |
| ===conflict_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
| |
| | |
| ===getCLIHooks()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
| |
| | |
| ===getCLIMethods()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
| |
| | |
| ===getConfig()===
| |
| This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
| |
| | |
| ===getHooks()===
| |
| This public method is inherited from [[Class: I2CE_Module#getHooks() | I2CE_Module->getHooks()]]
| |
| | |
| ===getMethods()===
| |
| This public method is inherited from [[Class: I2CE_Module#getMethods() | I2CE_Module->getMethods()]]
| |
| | |
| ===post_update()===
| |
| This public method is inherited from [[Class: I2CE_Module#post_update() | I2CE_Module->post_update()]]
| |
| | |
| ===pre_upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#pre_upgrade() | I2CE_Module->pre_upgrade()]]
| |
| | |
| ===requirement_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
| |
| | |
| ===upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#upgrade() | I2CE_Module->upgrade()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===launchBackgroundProcess()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
| |
| | |
| ===launchBackgroundPHPScript()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
| |
| | |
| ===launchBackgroundPage()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
| |
| | |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
