|
|
| (15 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_Module_Lists''.
| | #REDIRECT [[Class: I2CE_Module_Lists (4.1.7)]] |
| *Extends the class: [[Class: I2CE_Module | I2CE_Module]].
| |
| *Parent Classses: [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *Location: Part of the module [[I2CE Module List#Lists|Lists]] 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/modules/Lists/lib/I2CE_Module_Lists.php modules/Forms/modules/Lists/lib/I2CE_Module_Lists.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| *Since: v3.2.3
| |
| @filesource Class I2CE_Module_Lists
| |
| ==Methods==
| |
| ===action_initialize()===
| |
| Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error.
| |
| *Signature: public function action_initialize()
| |
| ===deleteMappedValues()===
| |
| Deletes id's of a list with field matchin a given value. Intended to be called after rempaFields has been succesfully called.
| |
| *Signature: static public function deleteMappedValues($list,$evals,$lookup_field)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $list <br/>the list form.
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $evals <br/>an array when keys the new id you want the value to be. the values are the values we lookup on the form name
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $lookup_field <br/>the name of the list field to lookup on. Defaults to 'name'
| |
| ***Default Value: 'name'
| |
| *Returns: voolean.<br/>true on success
| |
| ===getHooks()===
| |
| *Signature: static public function getHooks()
| |
| ===remapFields()===
| |
| Remaps the list values of the given list based on the field to lookup on for the form @param string $mapped_field. the mapped field of $form. The Defaults to null in which case then mapped field that is used is the $list
| |
| *Signature: static public function remapFields($list,$evals,$forms,$lookup_field)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $list <br/>the list form.
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $evals <br/>an array when keys the new id you want the value to be. the values are the values we lookup on the form name. If a list instance with the new id does not exist it creates it.
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>an array of string keys are forms values are mapped fields. Defulats to false in which case we do not try to update any form.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $lookup_field <br/>the name of the list field to lookup on. Defaults to 'name'
| |
| ***Default Value: 'name'
| |
| *Returns: boolean.<br/>true on success
| |
| ===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 field is unique
| |
| *Signature: public function validate_formfield($field_obj)
| |
| *Parameters:
| |
| ** [[Class: I2CE_FormField | I2CE_FormField]] $field_obj
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
