Class: I2CE FormStorage Mechanism (Development): Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 9: Line 9:
*** [[Class: I2CE_FormStorage_multi_flat (Development) | I2CE_FormStorage_multi_flat]]
*** [[Class: I2CE_FormStorage_multi_flat (Development) | I2CE_FormStorage_multi_flat]]
** [[Class: I2CE_FormStorage_CSV (Development) | I2CE_FormStorage_CSV]]
** [[Class: I2CE_FormStorage_CSV (Development) | I2CE_FormStorage_CSV]]
** [[Class: I2CE_FormStorage_SDMXHD (Development) | I2CE_FormStorage_SDMXHD]]
** [[Class: I2CE_FormStorage_eval (Development) | I2CE_FormStorage_eval]]
** [[Class: I2CE_FormStorage_eval (Development) | I2CE_FormStorage_eval]]
** [[Class: I2CE_FormStorage_magicdata (Development) | I2CE_FormStorage_magicdata]]
** [[Class: I2CE_FormStorage_magicdata (Development) | I2CE_FormStorage_magicdata]]
** [[Class: I2CE_FormStorage_XML_BASE (Development) | I2CE_FormStorage_XML_BASE]]
*** [[Class: I2CE_FormStorage_SDMXHD (Development) | I2CE_FormStorage_SDMXHD]]
*** [[Class: I2CE_FormStorage_SDMX_CrossSectional (Development) | I2CE_FormStorage_SDMX_CrossSectional]]
*** [[Class: I2CE_FormStorage_XML (Development) | I2CE_FormStorage_XML]]
*Location: Part of the module [[I2CE Module List (Development)#forms-storage|forms-storage]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#forms-storage|forms-storage]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L33 modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 33
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L33 modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 33
Line 52: Line 55:
===FF_IG_setSequence()===
===FF_IG_setSequence()===
Set FormField_INT_GENERATE sequence
Set FormField_INT_GENERATE sequence
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L651 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 651
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L656 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 656
*Signature: public function FF_IG_setSequence($form_field)
*Signature: public function FF_IG_setSequence($form_field)
*Parameters:
*Parameters:
Line 59: Line 62:
===FF_populateHistory()===
===FF_populateHistory()===
populate FormField history.  By default does nothing.
populate FormField history.  By default does nothing.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L661 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 661
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L666 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 666
*Signature: public function FF_populateHistory($form_field)
*Signature: public function FF_populateHistory($form_field)
*Parameters:
*Parameters:
Line 65: Line 68:
===FF_save()===
===FF_save()===
Save the FormField to the database.
Save the FormField to the database.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L641 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 641
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L646 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 646
*Signature: public function FF_save($form_field,$do_check,$user)
*Signature: public function FF_save($form_field,$do_check,$user)
*Parameters:
*Parameters:
Line 90: Line 93:
===delete()===
===delete()===
Deletes a form from the entry tables.
Deletes a form from the entry tables.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L676 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 676
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L681 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 681
*Signature: public function delete($form,$transact,$complete,$deleted_records)
*Signature: public function delete($form,$transact,$complete,$deleted_records)
*Parameters:
*Parameters:
Line 124: Line 127:
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getLimitedFields()===
===getLimitedFields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L521 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 521
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L526 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 526
*Signature: protected function getLimitedFields($expr)
*Signature: protected function getLimitedFields($expr)
*Parameters:
*Parameters:
Line 148: Line 151:
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===listDisplayFields()===
===listDisplayFields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L483 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 483
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L486 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 486
*Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
*Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
*Parameters:
*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.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.array.php array ] $fields <br/>of string. The fields we want returned Can include the special field 'last_modified' to get the last modification time for any of the fields of that form which is returned in the format  "Y-m-d H:i:s"
** [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.
** [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
***Default Value: false
Line 169: Line 172:
*Parameters:
*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.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.array.php array ] $fields <br/>of string. The fields we want returned.  Can include the special field 'last_modified' to get the last modification time for any of the fields of that form which is returned in the format  "Y-m-d H:i:s"
** [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.
** [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
***Default Value: false
Line 215: Line 218:
===save()===
===save()===
Save a form object into entry tables. If this functio is over-written, it should include the fuzzy method call foreach ($form as $field) { $field->save(true/false, $user) }
Save a form object into entry tables. If this functio is over-written, it should include the fuzzy method call foreach ($form as $field) { $field->save(true/false, $user) }
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L619 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 619
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L624 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 624
*Signature: public function save($form,$user,$transact)
*Signature: public function save($form,$user,$transact)
*Parameters:
*Parameters:
Line 222: Line 225:
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $transact
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $transact
===search()===
===search()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L560 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 560
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php#L565 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php] on line 565
*Signature: public function search($form,$parent,$where_data,$ordering,$limit)
*Signature: public function search($form,$parent,$where_data,$ordering,$limit)
*Parameters:
*Parameters:

Revision as of 07:56, 3 August 2010


This article describes the abstract class I2CE_FormStorage_Mechanism .

@filesource Class I2CE_Module_FormStorage_Mechanism

Constants

I2CE_FormStorage_Mechanism::CHANGE_INITIAL

Constant signifying an initial entry. Defined as: 1

I2CE_FormStorage_Mechanism::CHANGE_VERIFY

Constant signifying a verified entry. Defined as: 2

I2CE_FormStorage_Mechanism::CHANGE_CORRECTION

Constant signifying a corrected entry. Defined as: 3

I2CE_FormStorage_Mechanism::CHANGE_UPDATE

Constant signifying an updated entry. Defined as: 4

Variables

$name

The short name for this storage mechanism

$global_options

$storage_options_cache

of I2CE_MagicDataNodes. The keys are the names of forms which have flat storage.

$ordering

Methods

FF_IG_setSequence()

Set FormField_INT_GENERATE sequence

FF_populateHistory()

populate FormField history. By default does nothing.

FF_save()

Save the FormField to the database.

__construct()

The constructor for the storage mechanism

compareFormsByFields()

Compares two forms to see which is greater based on the field ordering set in $this->ordering @param $form1 @param $form2

delete()

Deletes a form from the entry tables.

getFormsById()

Gets the required fields. @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 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 289
  • Signature: public function getFormsById($form,$parent,$where_data,$ordering,$limit)
  • Parameters:
    • string $form
      The form we are select from
    • boolean $parent
      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.
    • mixed $where_data
      array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.
      • Default Value: array()
    • array $ordering
      An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
      • Default Value: array()
    • mixed $limit
      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: array
    with keys id's and values the I2CE_Form instance.

getIdsAsChild()

Gets the id's for the given child for this form.

getLimitedFields()

getRecords()

Return an array of all the record ids for a given form.

getStorageOptions()

Gets the storage options for the given form.

isWritable()

Checks to see if this storage mechansim implements the writing methods. You need to override this in a subclass that implements writable

listDisplayFields()

  • Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 486
  • Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
  • Parameters:
    • string $form
      THe form name
    • array $fields
      of string. The fields we want returned Can include the special field 'last_modified' to get the last modification time for any of the fields of that form which is returned in the format "Y-m-d H:i:s"
    • boolean $parent
      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
    • array $where_data
      contains the where clause information about this form or a nested
      • Default Value: array()
    • array $ordering
      An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
      • Default Value: array()
    • mixed $limit
      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
      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: mixed
    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 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 442
  • Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
  • Parameters:
    • string $form
      THe form name
    • array $fields
      of string. The fields we want returned. Can include the special field 'last_modified' to get the last modification time for any of the fields of that form which is returned in the format "Y-m-d H:i:s"
    • boolean $parent
      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
    • array $where_data
      contains the where clause information about this form or a nested
      • Default Value: array()
    • array $ordering
      An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
      • Default Value: array()
    • mixed $limit
      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
      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: mixed
    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 description 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.

lookupField()

Looks up the description 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.

populate()

Populate the member variables of the object from the database.

populateHistory()

Populate the member variables of the object from the database.

save()

Save a form object into entry tables. If this functio is over-written, it should include the fuzzy method call foreach ($form as $field) { $field->save(true/false, $user) }

search()

  • Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 565
  • Signature: public function search($form,$parent,$where_data,$ordering,$limit)
  • Parameters:
    • string $form
      The form name.
    • boolean $parent
      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
    • mixed $where_data
      array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.
      • Default Value: array()
    • array $ordering
      An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
      • Default Value: array()
    • mixed $limit
      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: mixed
    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.

setStorageOptions()

Public set the more storage options for a given form

Inherited Methods

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()