|
|
| Line 1: |
Line 1: |
| The class I2CE_FormStorage_magicdata contains 2 definitions:
| | #REDIRECT [[Class: I2CE_FormStorage_magicdata (4.0.3)]] |
| *Definition in [[#i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php|i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php]] of the package <span style='color:FireBrick'>I2CE</span>
| |
| *Definition in [[#i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php|i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php]] of the package <span style='color:FireBrick'>I2CE</span>
| |
| =i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php=
| |
| This article describes the class ''I2CE_FormStorage_magicdata''.
| |
| *Extends the class: [[Class: I2CE_FormStorage_DB | I2CE_FormStorage_DB]].
| |
| *Location: Part of the module [[I2CE Module List#forms-storage-magicdata|forms-storage-magicdata]] 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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L33 modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 33
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| *Since: v4.0.0
| |
| @filesource Class I2CE_FormStorage_magicdata
| |
| ==Methods==
| |
| ===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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L315 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 315
| |
| *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.
| |
| ** [[Class: I2CE_User | I2CE_User]] $user <br/>The user saving this data.
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===__construct()===
| |
| Construct this module class
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L42 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 42
| |
| *Signature: public function __construct($name,$options)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name of this storage mechanism
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $options
| |
| ***Default Value: array()
| |
| ===delete()===
| |
| Deletes a form from the entry tables. @param boolean $deleted_records: a flag to determine if the record should not go to the deleted_records table. default: false
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L221 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 221
| |
| *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
| |
| ** [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
| |
| **$no_history
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===getFormConfig()===
| |
| Return the magic data node for the given form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L176 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 176
| |
| *Signature: protected function getFormConfig($form,$create_id)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $form <br/>I2CE_Form or I2CE_FormField
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create_id <br/>Defaults to false
| |
| ***Default Value: false
| |
| *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]]
| |
| ===getFormConfigById()===
| |
| Return the magic data node for the given form name and id
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L193 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 193
| |
| *Signature: protected function getFormConfigById($form_name,$id,$create_id)
| |
| *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 ] $id
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create_id <br/>Defaults to false.
| |
| ***Default Value: false
| |
| ===getNextAvailableId()===
| |
| Gets the next unused integer id for the form. At least 1
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L283 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 283
| |
| *Signature: protected function getNextAvailableId($form_name)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
| |
| *Returns: int.<br/>0 on failure. An integer > 0 on success.
| |
| ===getRequiredFieldsQuery()===
| |
| Construct a query (to be used as a sub-select) to view the fields of the given form. It always will return the id of the form as well @param callback $field_refernece_callback. A callback function whose first arguement is the form, the second arguements is the field and which returns the way the field value should be references as a field. If the callback is null (the default) then the reference used is "$form+$field"
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L65 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 65
| |
| *Signature: public function getRequiredFieldsQuery($form,$fields,$id,$parent,$field_reference_callback,$mod_time)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $fields <br/>Either a string, the field, or an array of string, the fields.
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $id <br/>Defaults to null. If non-null it is the id that we wish to limit to.
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If true, we include the parent id as a referenced field. 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
| |
| **$field_reference_callback
| |
| ***Default Value: null
| |
| ** 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.types.string.php string ]<br/>the query or false on failed.
| |
| ===isWritable()===
| |
| Checks to see if this is writalbe
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L237 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 237
| |
| *Signature: public function isWritable()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===save()===
| |
| Save a form object into magicdata
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php#L249 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php] on line 249
| |
| *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
| |
| | |
| ==Inherited Methods==
| |
| ===getFields()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#getFields() | I2CE_FormStorage_DB->getFields()]]
| |
| | |
| ===getIdsAsChild()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#getIdsAsChild() | I2CE_FormStorage_DB->getIdsAsChild()]]
| |
| | |
| ===FF_IG_setSequence()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#FF_IG_setSequence() | I2CE_FormStorage_Mechanism->FF_IG_setSequence()]]
| |
| | |
| ===getFormsById()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#getFormsById() | I2CE_FormStorage_Mechanism->getFormsById()]]
| |
| | |
| ===populateHistory()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#populateHistory() | I2CE_FormStorage_Mechanism->populateHistory()]]
| |
| | |
| ===compareFormsByFields()===
| |
| This protected method is inherited from [[Class: I2CE_FormStorage_Mechanism#compareFormsByFields() | I2CE_FormStorage_Mechanism->compareFormsByFields()]]
| |
| | |
| ===getLimitedFields()===
| |
| This protected method is inherited from [[Class: I2CE_FormStorage_Mechanism#getLimitedFields() | I2CE_FormStorage_Mechanism->getLimitedFields()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Variables==
| |
| ===$db===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormStorage_DB#$db | I2CE_FormStorage_DB->$db]]
| |
| | |
| ===$name===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$name | I2CE_FormStorage_Mechanism->$name]]
| |
| | |
| ===$global_options===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$global_options | I2CE_FormStorage_Mechanism->$global_options]]
| |
| | |
| ===$ordering===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$ordering | I2CE_FormStorage_Mechanism->$ordering]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| =i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php=
| |
| This article describes the class ''I2CE_FormStorage_magicdata''.
| |
| *Extends the class: [[Class: I2CE_FormStorage_Mechanism | I2CE_FormStorage_Mechanism]].
| |
| *Location: Part of the module [[I2CE Module List#forms-storage-magicdata|forms-storage-magicdata]] 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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L38 modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 38
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| *Since: 3.2
| |
| I2CE_Module_FormStorageEntry
| |
| ==Methods==
| |
| ===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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L140 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 140
| |
| *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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L804 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 804
| |
| *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.
| |
| ** [[Class: I2CE_User | I2CE_User]] $user <br/>The user saving this data.
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===__construct()===
| |
| Construct this module class
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L53 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 53
| |
| *Signature: public function __construct($name,$options)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name of this storage mechanism
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $options
| |
| ***Default Value: array()
| |
| ===delete()===
| |
| Deletes a form from the entry tables. @param boolean $deleted_records: a flag to determine if the record should not go to the deleted_records table. default: false
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L719 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 719
| |
| *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
| |
| ** [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
| |
| **$no_history
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===getFormConfig()===
| |
| Return the magic data node for the given form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L64 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 64
| |
| *Signature: protected function getFormConfig($form,$create_id)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $form <br/>I2CE_Form or I2CE_FormField
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create_id <br/>Defaults to false
| |
| ***Default Value: false
| |
| *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]]
| |
| ===getFormConfigById()===
| |
| Return the magic data node for the given form name and id
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L81 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 81
| |
| *Signature: protected function getFormConfigById($form_name,$id,$create_id)
| |
| *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 ] $id
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create_id <br/>Defaults to false.
| |
| ***Default Value: false
| |
| ===getNextAvailableId()===
| |
| Gets the next unused integer id for the form. At least 1
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L772 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 772
| |
| *Signature: protected function getNextAvailableId($form_name)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
| |
| *Returns: int.<br/>0 on failure. An integer > 0 on success.
| |
| ===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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L161 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 161
| |
| *Signature: public function getRecords($form_name)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===isWritable()===
| |
| Checks to see if this is writalbe
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L44 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 44
| |
| *Signature: public function isWritable()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===listDisplayFields()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L551 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 551
| |
| *Signature: 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. If true, we return the parent as one of the fields.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $where_data <br/>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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L397 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 397
| |
| *Signature: 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. If true, we return the parent as one of the fields.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $where_data <br/>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 vlaue 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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L235 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 235
| |
| *Signature: 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.types.array.php array ] $fields <br/>A list of fields to look up and return.
| |
| ** [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, returns the values as an array.
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>false on failure
| |
| ===lookupField()===
| |
| Looks up the db 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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L191 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 191
| |
| *Signature: 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.types.array.php array ] $fields <br/>A list of fields to look up and return.
| |
| ** [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, returns the values as an array.
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>false on failure
| |
| ===orderByFields()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L700 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 700
| |
| *Signature: static public function orderByFields($vals,$ordering)
| |
| *Parameters:
| |
| **$vals
| |
| **$ordering
| |
| ===populate()===
| |
| Populate the member variables of the object from the database.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L104 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 104
| |
| *Signature: public function populate($form)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ===quickSearch()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L319 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 319
| |
| *Signature: protected function quickSearch($form,$parent,$where_data,$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 ] $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.
| |
| ===save()===
| |
| Save a form object into magicdata
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L738 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 738
| |
| *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
| |
| ===search()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php#L290 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php] on line 290
| |
| *Signature: 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.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
| |
| *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.
| |
| | |
| ==Inherited Methods==
| |
| ===FF_IG_setSequence()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#FF_IG_setSequence() | I2CE_FormStorage_Mechanism->FF_IG_setSequence()]]
| |
| | |
| ===getFormsById()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#getFormsById() | I2CE_FormStorage_Mechanism->getFormsById()]]
| |
| | |
| ===getIdsAsChild()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#getIdsAsChild() | I2CE_FormStorage_Mechanism->getIdsAsChild()]]
| |
| | |
| ===populateHistory()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#populateHistory() | I2CE_FormStorage_Mechanism->populateHistory()]]
| |
| | |
| ===compareFormsByFields()===
| |
| This protected method is inherited from [[Class: I2CE_FormStorage_Mechanism#compareFormsByFields() | I2CE_FormStorage_Mechanism->compareFormsByFields()]]
| |
| | |
| ===getLimitedFields()===
| |
| This protected method is inherited from [[Class: I2CE_FormStorage_Mechanism#getLimitedFields() | I2CE_FormStorage_Mechanism->getLimitedFields()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Variables==
| |
| ===$name===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$name | I2CE_FormStorage_Mechanism->$name]]
| |
| | |
| ===$global_options===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$global_options | I2CE_FormStorage_Mechanism->$global_options]]
| |
| | |
| ===$ordering===
| |
| Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$ordering | I2CE_FormStorage_Mechanism->$ordering]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
