|
|
| (13 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_FormStorage_multi_flat''.
| | #REDIRECT [[Class: I2CE_FormStorage_multi_flat (4.1.7)]] |
| *Extends the class: [[Class: I2CE_FormStorage_DB | I2CE_FormStorage_DB]].
| |
| *Location: Part of the module [[I2CE Module List#forms-storage-multiflat|forms-storage-multiflat]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.1-release/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| *Since: v4.0.1
| |
| @filesource Class I2CE_FormStorage_multi_flat
| |
| ==Variables==
| |
| ===$storage_options_cache===
| |
| of I2CE_MagicDataNodes. The keys are the names of forms which have flat storage.
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $storage_options_cache
| |
| | |
| ===$databases===
| |
| sting. Keys are componentities and values are the assoicated database
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $databases
| |
| | |
| ===$componentized_forms===
| |
| componentized_forms. The array of componentized forms
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $componentized_forms
| |
| | |
| ===$formObjs===
| |
| . Keys are form names, values are instanceof I2CE_Form
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $formObjs
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| The constructor for the storage mechanism
| |
| *Signature: public function __construct($name,$global_options)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $global_options <br/>Default to empty array. The array of options that are the same across all all forms which share a commone storage mechanisms
| |
| ***Default Value: array()
| |
| ===fieldIsColumn()===
| |
| *Signature: protected function fieldIsColumn($data)
| |
| *Parameters:
| |
| **$data
| |
| ===getFieldData()===
| |
| *Signature: protected function getFieldData($data)
| |
| *Parameters:
| |
| **$data
| |
| ===getFormObj()===
| |
| Get a (cached) form object for the given form
| |
| *Signature: protected function getFormObj($form)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| *Returns: [[Class: I2CE_Form | I2CE_Form]]<br/>or false on failure.
| |
| ===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"
| |
| *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.
| |
| ===getStorageOptions()===
| |
| Checks that the storage mechansim for the given form is 'multi_flat' and has storage options.
| |
| *Signature: protected function getStorageOptions($form)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>I2CE_MagicDataNode of flat storage options on success, false on failure.
| |
| ===isWritable()===
| |
| Checks to see if this storage mechansim is writable
| |
| *Signature: public function isWritable()
| |
| *Returns: boolean.<br/>false
| |
| ==Inherited Methods==
| |
| ===FF_populateHistory()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#FF_populateHistory() | I2CE_FormStorage_DB->FF_populateHistory()]]
| |
| | |
| ===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()]]
| |
| | |
| ===getRecords()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#getRecords() | I2CE_FormStorage_DB->getRecords()]]
| |
| | |
| ===listDisplayFields()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#listDisplayFields() | I2CE_FormStorage_DB->listDisplayFields()]]
| |
| | |
| ===listFields()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#listFields() | I2CE_FormStorage_DB->listFields()]]
| |
| | |
| ===lookupDisplayField()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#lookupDisplayField() | I2CE_FormStorage_DB->lookupDisplayField()]]
| |
| | |
| ===lookupField()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#lookupField() | I2CE_FormStorage_DB->lookupField()]]
| |
| | |
| ===populate()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#populate() | I2CE_FormStorage_DB->populate()]]
| |
| | |
| ===search()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_DB#search() | I2CE_FormStorage_DB->search()]]
| |
| | |
| ===FF_IG_setSequence()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#FF_IG_setSequence() | I2CE_FormStorage_Mechanism->FF_IG_setSequence()]]
| |
| | |
| ===FF_save()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#FF_save() | I2CE_FormStorage_Mechanism->FF_save()]]
| |
| | |
| ===delete()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#delete() | I2CE_FormStorage_Mechanism->delete()]]
| |
| | |
| ===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()]]
| |
| | |
| ===save()===
| |
| This public method is inherited from [[Class: I2CE_FormStorage_Mechanism#save() | I2CE_FormStorage_Mechanism->save()]]
| |
| | |
| ===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()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
