|
|
| (12 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_FormStorage''.
| | #REDIRECT [[Class: I2CE_FormStorage (4.1.7)]] |
| *Extends the class: [[Class: I2CE_Module | I2CE_Module]].
| |
| *Location: Part of the module [[I2CE Module List#forms-storage|forms-storage]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L38 modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 38
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| *Since: 3.2
| |
| I2CE_Module_FormStorage
| |
| ==Variables==
| |
| ===$componentized_forms===
| |
| A cached list of componentized forms. array of string, the form names
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L156 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 156
| |
| *Type: static protected static $componentized_forms
| |
| | |
| ===$storage===
| |
| An array with a cache of the storage type for a form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L182 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 182
| |
| *Type: static protected [http://www.php.net/manual/en/language.types.array.php array ] $storage
| |
| | |
| ===$storageMechs===
| |
| An array with a cache of the storage mechanisms
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L214 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 214
| |
| *Type: static protected [http://www.php.net/manual/en/language.types.array.php array ] $storageMechs
| |
| | |
| ==Methods==
| |
| ===FF_IG_save()===
| |
| Save the FormField to the database.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1127 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1127
| |
| *Signature: public function FF_IG_save($form_field,$do_check,$user)
| |
| *Parameters:
| |
| **$form_field
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_check <br/>A flag to determine if a check should be made for the same value being saved. @param I2CE_User I2CE_User The user saving this data.
| |
| **$user
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===FF_IG_setSequence()===
| |
| Set the value of this field to the next sequence for the form field.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1185 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1185
| |
| *Signature: public function FF_IG_setSequence($form_field)
| |
| *Parameters:
| |
| ** [[Class: I2CE_FormField_INT_GENERATE | I2CE_FormField_INT_GENERATE]] $form_field
| |
| ===FF_SP_save()===
| |
| Save the FormField_STRING_PASS to the database.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1156 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1156
| |
| *Signature: public function FF_SP_save($form_field,$do_check,$user)
| |
| *Parameters:
| |
| ** [[Class: I2CE_FormField_STRING_PASS | I2CE_FormField_STRING_PASS]] $form_field
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_check <br/>A flag to determine if a check should be made for the same value being saved. @param I2CE_User I2CE_User The user saving this data.
| |
| **$user
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===FF_populateHistory()===
| |
| Populate the history of entries for the form field if the storage module handles history.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1205 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1205
| |
| *Signature: public function FF_populateHistory($form_field)
| |
| *Parameters:
| |
| ** [[Class: I2CE_FormField | I2CE_FormField]] $form_field
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===FF_save()===
| |
| Save the FormField to the database.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1103 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1103
| |
| *Signature: public function FF_save($form_field,$do_check,$user)
| |
| *Parameters:
| |
| ** [[Class: I2CE_FormField | I2CE_FormField]] $form_field
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_check <br/>A flag to determine if a check should be made for the same value being saved. @param I2CE_User I2CE_User The user saving this data.
| |
| **$user
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===addChild()===
| |
| add the given child to the form for this object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L925 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 925
| |
| *Signature: public function addChild($form,$form_name,$id)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name <br/>The form name to add @param string the id of this form
| |
| **$id
| |
| ===delete()===
| |
| Delete a form object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1068 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1068
| |
| *Signature: public function delete($form,$transact,$complete,$no_history)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $transact <br/>a flag to use transactions or not. default: true
| |
| ***Default Value: true
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $complete <br/>a flag to determine if a complete delete should happen. default: false
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $no_history <br/>a flag to determine if the record should not go to the deleted_records table. default: false
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===getChildIds()===
| |
| Gets the id's for the given child for this form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L906 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 906
| |
| *Signature: public function getChildIds($form,$child_form_name,$order_by,$where,$limit)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $child_form_name <br/>the child form name
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $order_by <br/>A string or array of strings. The fields to oreder by . defaults to empty array.
| |
| ***Default Value: array()
| |
| **$where
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $limit <br/>Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===getComponentizedForms()===
| |
| static function which gets a list of all componentized forms
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L162 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 162
| |
| *Signature: static public function getComponentizedForms($use_cache)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $use_cache <br/>Use the cached value of the list for componentized forms if possible. Defualts to true
| |
| ***Default Value: true
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string, the componentized forms
| |
| ===getHooks()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L76 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 76
| |
| *Signature: static public function getHooks()
| |
| ===getMechanismByStorage()===
| |
| Returns the storage mechanism for the given storage type.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L232 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 232
| |
| *Signature: static public function getMechanismByStorage($storage)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $storage
| |
| *Returns: [[Class: I2CE_FormStorage_Mechanism | I2CE_FormStorage_Mechanism]]<br/>or false on failure
| |
| ===getMethods()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L42 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 42
| |
| *Signature: static public function getMethods()
| |
| ===getMigratedValue()===
| |
| Get the new value for a field that has been migrated.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L350 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 350
| |
| *Signature: static public function getMigratedValue($migrate_node,$form,$old_id,$field,$map_form)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $migrate_node
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $old_id
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $field
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $map_form
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getNewMigratedValue()===
| |
| Get the new migrated value for from the old value. @param mixed $old_id
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L327 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 327
| |
| *Signature: static public function getNewMigratedValue($migrate_node,$map_form,$old_value,$old_amt)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $migrate_node
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $map_form
| |
| **$old_value
| |
| ** integer $old_amt <br/>For currency data this is the amount
| |
| ***Default Value: 0
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===getOldMigratedValue()===
| |
| Get the old value for a field that has been migrated.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L276 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 276
| |
| *Signature: static public function getOldMigratedValue($migrate_node,$form,$old_id,$field,$map_form)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $migrate_node
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $old_id
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $field
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $map_form
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>array( 'map_form', 'old_value' );
| |
| ===getRecords()===
| |
| Return an array of all the record ids for a given form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1230 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1230
| |
| *Signature: public function getRecords($factory,$form_name)
| |
| *Parameters:
| |
| ** [[Class: I2CE_FormFactory | I2CE_FormFactory]] $factory
| |
| **$form_name
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===getStorage()===
| |
| Return the storage class for the given form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L192 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 192
| |
| *Signature: static public function getStorage($form_name,$no_cache)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $no_cache <br/>Check from the source, not the cached array
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getStorageMechanism()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L222 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 222
| |
| *Signature: static public function getStorageMechanism($form_name,$no_cache)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $no_cache <br/>Check from the source, not the cached array
| |
| ***Default Value: false
| |
| *Returns: [[Class: I2CE_FormStorage_Mechanism | I2CE_FormStorage_Mechanism]]<br/>or false on failure
| |
| ===isComponentized()===
| |
| static function to determine if a form is componentized
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L139 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 139
| |
| *Signature: static public function isComponentized($form)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===isComponentizedForm()===
| |
| Fuzzy method to check if a form instance is componentized
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L763 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 763
| |
| *Signature: public function isComponentizedForm($formClass)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $formClass
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===isWritable()===
| |
| Check to see if this form is considered to be writable.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1253 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1253
| |
| *Signature: static public function isWritable($form)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $form <br/>string, I2CE_Form or I2CE_FormField
| |
| ===listDisplayFields()===
| |
| Lists the display values for a field
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L735 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 735
| |
| *Signature: static public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $fields <br/>of string. The fields we want returned
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $where_data <br/>Either I2CE_MagicDataNode or array. contains the where clause information about this form or a nested
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $ordering <br/>An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $limit <br/>Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| ***Default Value: false
| |
| ** integer $mod_time <br/>Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.
| |
| ***Default Value: -1
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.
| |
| ===listFields()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L709 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 709
| |
| *Signature: static public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $fields <br/>of string. The fields we want returned
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $where_data <br/>Either I2CE_MagicDataNode or array. contains the where clause information about this form or a nested
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $ordering <br/>An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $limit <br/>Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| ***Default Value: false
| |
| ** integer $mod_time <br/>Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.
| |
| ***Default Value: -1
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.
| |
| ===lookupDisplayField()===
| |
| Looks up the display value of the item based on the code. This is the default method that most implementations of lookup () use. It finds the description of the object based on the code and saves it in the cache and returns it.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L680 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 680
| |
| *Signature: static public function lookupDisplayField($form,$id,$fields,$delim)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The name of the form in the database.
| |
| ** integer $id <br/>The code of the entry to lookup.
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $fields <br/>A field or an array of fields to look up and return. Defaults to 'name'
| |
| ***Default Value: array('name')
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $delim <br/>The delimiter to put between returned fields if there are more than one. If false , then we return as an array. Defaults to '-'
| |
| ***Default Value: '-'
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>or false on failure
| |
| ===lookupField()===
| |
| Looks up the dbvalue of the item based on the code. This is the default method that most implementations of lookup () use. It finds the description of the object based on the code and saves it in the cache and returns it.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L653 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 653
| |
| *Signature: static public function lookupField($form,$id,$fields,$delim)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The name of the form in the database.
| |
| ** integer $id <br/>The code of the entry to lookup.
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $fields <br/>A field or an array of fields to look up and return. Defaults to 'name'
| |
| ***Default Value: array('name')
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $delim <br/>The delimiter to put between returned fields if there are more than one. If false , then we return as an array. Defaults to '-'
| |
| ***Default Value: '-'
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>or false on failure
| |
| ===migrateField()===
| |
| Migrate field data from an old setMap reference to a new MAP form field type. The old data should have been saved in a migrate_data magic data (see storeMigrateData ).
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L543 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 543
| |
| *Signature: static public function migrateField($form_name,$field_list,$migrate_path,$user)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $field_list <br/>The list of fields that need to be changed as an array of field => map_form. Optionally the field list can be: array( "field" => array( "prev_field" => "prev_map_form" ) ) The field will get the old value from the list of fields (with mapped forms) for when the field name was changed.
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $migrate_path <br/>Where the migrate data has been saved.
| |
| ** [[Class: I2CE_User | I2CE_User]] $user <br/>The user to save the new form field.
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===migrateForm()===
| |
| Migrate a given form from one storage method to the current storage method. This should only be used when upgrading a module that moved a form storage from one type to another.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L388 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 388
| |
| *Signature: static public function migrateForm($form_name,$storage,$user,$migrate_path,$id_field,$skip_fields,$migrate_fields,$callback)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $storage <br/>The old storage mechanism
| |
| ** [[Class: I2CE_User | I2CE_User]] $user <br/>The user object to use to save the new forms.
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $migrate_path <br/>The full path in MagicData to save the old to new mappings.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $id_field <br/>The old field name to use the value of for the new form id.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $skip_fields <br/>A list of fields to not migrate to the new form.
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $migrate_fields <br/>A list of fields that have already been migrated and need to use the migrate path to convert the data. Format is array( "field" => "map_form" ) These forms and fields should have already been passed to storeMigrateData so the data can be retrieved from there.
| |
| ***Default Value: array()
| |
| **$callback
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===populate()===
| |
| Populate a form object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L783 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 783
| |
| *Signature: public function populate($form)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ===populateChild()===
| |
| Populate all instances of the given child form for this object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L948 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 948
| |
| *Signature: public function populateChild($form,$form_name,$order_by,$where,$type)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name <br/>The form name to populate
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $order_by <br/>A field or array of fields to sort by. Preceded by "-" to sort in reverse order. - array( "-start_date", "name" ). Defaults to null in which case if get the default sort order that is registered for the type (which defaults to none) @param mixed @where an aarray of where information to limit getting the child id's by. If null, we get the default limits for the type (which defaults to none)
| |
| ***Default Value: null
| |
| **$where
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $type <br/>Defaults to 'default'
| |
| ***Default Value: 'default'
| |
| ===populateChildren()===
| |
| Populate the given child form for this object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L987 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 987
| |
| *Signature: public function populateChildren($form,$forms,$orderBy)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $forms <br/>A string or an array such, the form names (the child forms to populate) - array( "demographic", "contact" )
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $orderBy <br/>An associative array of form names with an array of either string, field to sort by or an array of the fields Defaults to empty array - array( "contact" => "contact_type" )
| |
| ***Default Value: array()
| |
| ===populateFirst()===
| |
| Populate the first child of a form object based on the given field
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L865 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 865
| |
| *Signature: public function populateFirst($form,$forms)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>an associative array with keys form names and values field names or ordering array
| |
| ***Default Value: array()
| |
| ===populateHistory()===
| |
| Populate Last of a form object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L804 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 804
| |
| *Signature: public function populateHistory($form)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ===populateLast()===
| |
| Populate the last child of a form object based on the given field
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L818 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 818
| |
| *Signature: public function populateLast($form,$forms)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>an associative array with keys form names and values field names or ordering array
| |
| ***Default Value: array()
| |
| ===save()===
| |
| Save a form object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1041 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1041
| |
| *Signature: public function save($form,$user,$transact)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** [[Class: I2CE_User | I2CE_User]] $user
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $transact <br/>Defaults to true.
| |
| ***Default Value: true
| |
| ===search()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L612 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 612
| |
| *Signature: static public function search($form,$parent,$where_data,$ordering,$limit)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name.
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $where_data <br/>array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $ordering <br/>An field or an array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $limit <br/>Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array of matching form ids. However, ff $limit_one is true or 1 or array ($offset,1) then then we return either the id or false, if none found or there was an error.
| |
| ===setChangeType()===
| |
| Set the change type for the given form. If this method isn't called then the change type will be I2CE_FormStorage::CHANGE_UPDATE
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L1020 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 1020
| |
| *Signature: public function setChangeType($form,$change_type,$field)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ** integer $change_type <br/>the change type to set Defautls to I2CE_FormStorage::CHANGE_UPDATE
| |
| ***Default Value: I2CE_FormStorage_Mechanism::CHANGE_UPDATE
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $field <br/>Defaults to 'default'. optional field name to set the change type to.
| |
| ***Default Value: 'default'
| |
| ===storeMigrateData()===
| |
| Save the given fields to the given magic data node so it can later be referenced when migrating the form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L255 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 255
| |
| *Signature: static public function storeMigrateData($forms,$migrate_path)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>An array of forms with an array of fields for each: array( "form_name" => array( "field1", "field2" ) );
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $migrate_path <br/>The path in magic data to save the data
| |
| ===validate_formfield()===
| |
| Hooked Function to check if a field is unique or unique restricted to a certain field
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php#L89 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php] on line 89
| |
| *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 ]
| |
| ==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()]]
| |
| | |
| ===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]]
| |
