Class: I2CE FormStorage DB (4.1.4): Difference between revisions
(Created page with "{{otherversions|Class: I2CE_FormStorage_DB}} This article describes the ''abstract'' class ''I2CE_FormStorage_DB'' . *Extends the class: [[Class: I2CE_FormStorage_Mechanism (4.1....") |
No edit summary |
||
Line 21: | Line 21: | ||
===FF_populateHistory()=== | ===FF_populateHistory()=== | ||
Populate the history of entries for the form field if the storage module handles history. | 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.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L246 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 246 | ||
*Signature: public function FF_populateHistory($form_field) | *Signature: public function FF_populateHistory($form_field) | ||
*Parameters: | *Parameters: | ||
Line 35: | Line 35: | ||
===getFields()=== | ===getFields()=== | ||
Generates a SQL to select the required fields. @param mixed $expr array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data. @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" | Generates a SQL to select the required fields. @param mixed $expr array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data. @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.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L318 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 318 | ||
*Signature: public function getFields($form,$fields,$parent,$where_data,$ordering,$limit,$field_reference_callback,$mod_time) | *Signature: public function getFields($form,$fields,$parent,$where_data,$ordering,$limit,$field_reference_callback,$mod_time,$user) | ||
*Parameters: | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form we are select from | ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form we are select from | ||
Line 52: | Line 52: | ||
** 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 $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | ** 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 $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | ||
***Default Value: -1 | ***Default Value: -1 | ||
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $user <br/>The user id of the user to limit the results to so it only returns results limited to that user. This can be a single value or an array | |||
***Default Value: false | |||
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>the SQL Query needed to get the form/field data or false on failure. | *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>the SQL Query needed to get the form/field data or false on failure. | ||
===getIdsAsChild()=== | ===getIdsAsChild()=== | ||
Gets the id's for the given child for this form. | Gets the id's for the given child for this form. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L417 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 417 | ||
*Signature: public function getIdsAsChild($form,$parent_form_id,$order_by,$where,$limit) | *Signature: public function getIdsAsChild($form,$parent_form_id,$order_by,$where,$limit) | ||
*Parameters: | *Parameters: | ||
Line 66: | Line 68: | ||
===getRecords()=== | ===getRecords()=== | ||
Return an array of all the record ids for a given form. | Return an array of all the record ids for a given form. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L274 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 274 | ||
*Signature: public function getRecords($form) | *Signature: public function getRecords($form) | ||
*Parameters: | *Parameters: | ||
Line 73: | Line 75: | ||
===getRequiredFieldsQuery()=== | ===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" | 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.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L72 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 72 | ||
*Signature: abstract public function getRequiredFieldsQuery($form,$fields,$id,$parent,$field_reference_callback,$mod_time) | *Signature: abstract public function getRequiredFieldsQuery($form,$fields,$id,$parent,$field_reference_callback,$mod_time,$user) | ||
*Parameters: | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $form | ** [http://www.php.net/manual/en/language.types.string.php string ] $form | ||
Line 86: | Line 88: | ||
** 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. | ** 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 | ***Default Value: -1 | ||
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $user <br/>The user id of the user to limit the results to so it only returns results limited to that user. This can be a single value or an array | |||
***Default Value: false | |||
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>the query or false on failed. | *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>the query or false on failed. | ||
===globalFieldUpdateBySQL()=== | ===globalFieldUpdateBySQL()=== | ||
update value of each instanceo of a given form field by a pho function call @param {I2CE_FormField} $form_field | update value of each instanceo of a given form field by a pho function call @param {I2CE_FormField} $form_field | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L88 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 88 | ||
*Signature: public function globalFieldUpdateBySQL($form_field,$where,$set_sql) | *Signature: public function globalFieldUpdateBySQL($form_field,$where,$set_sql) | ||
*Parameters: | *Parameters: | ||
Line 97: | Line 101: | ||
===hasGlobalFieldUpdateBySql()=== | ===hasGlobalFieldUpdateBySql()=== | ||
Check to see if there is a quick field update implemented | Check to see if there is a quick field update implemented | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L78 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 78 | ||
*Signature: public function hasGlobalFieldUpdateBySql() | *Signature: public function hasGlobalFieldUpdateBySql() | ||
*Returns: true<br/>if there is a method to quickly update all instances of a given field via SQL | *Returns: true<br/>if there is a method to quickly update all instances of a given field via SQL | ||
===listDisplayFields()=== | ===listDisplayFields()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L572 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 572 | ||
*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,$user) | ||
*Parameters: | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $form | ** [http://www.php.net/manual/en/language.types.string.php string ] $form | ||
Line 116: | Line 120: | ||
** 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. | ** 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 | ***Default Value: -1 | ||
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $user <br/>The user id of the user to limit the results to so it only returns results limited to that user. This can be a single value or an array | |||
***Default Value: false | |||
*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. | *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()=== | ===listFields()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L510 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 510 | ||
*Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | *Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | ||
*Parameters: | *Parameters: | ||
Line 136: | Line 142: | ||
===lookupDisplayField()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L193 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 193 | ||
*Signature: public function lookupDisplayField($form,$id,$fields,$delim) | *Signature: public function lookupDisplayField($form,$id,$fields,$delim) | ||
*Parameters: | *Parameters: | ||
Line 146: | Line 152: | ||
===lookupField()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L148 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 148 | ||
*Signature: public function lookupField($form,$id,$fields,$delim) | *Signature: public function lookupField($form,$id,$fields,$delim) | ||
*Parameters: | *Parameters: | ||
Line 156: | Line 162: | ||
===populate()=== | ===populate()=== | ||
Populate the member variables of the object from the database. | Populate the member variables of the object from the database. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L99 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 99 | ||
*Signature: public function populate($form) | *Signature: public function populate($form) | ||
*Parameters: | *Parameters: | ||
Line 162: | Line 168: | ||
===queryLastListCount()=== | ===queryLastListCount()=== | ||
Query the last list count and set it in FormStorage | Query the last list count and set it in FormStorage | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L632 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 632 | ||
*Signature: protected function queryLastListCount($form) | *Signature: protected function queryLastListCount($form) | ||
*Parameters: | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name to set. | ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name to set. | ||
===search()=== | ===search()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.4-release/annotate/head:/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php#L447 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php] on line 447 | ||
*Signature: public function search($form,$parent,$where_data,$ordering,$limit) | *Signature: public function search($form,$parent,$where_data,$ordering,$limit) | ||
*Parameters: | *Parameters: |
Latest revision as of 11:34, 27 July 2012
This article describes the abstract class I2CE_FormStorage_DB .
- Extends the class: I2CE_FormStorage_Mechanism.
- Child Classes:
- Location: Part of the module forms-storage in the package I2CE 4.1.4-release
- Source: Defined in the file modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 33
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v3.2.0
@filesource Class I2CE_Module_FormStorage_DB
Variables
$db
The database object
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 40
- Type: protected MDB2 $db
Methods
FF_populateHistory()
Populate the history of entries for the form field if the storage module handles history.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 246
- Signature: public function FF_populateHistory($form_field)
- Parameters:
- I2CE_FormField $form_field
- Returns: boolean
__construct()
Construct this module class
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 49
- Signature: public function __construct($name,$options)
- Parameters:
getFields()
Generates a SQL to select the required fields. @param mixed $expr array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data. @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_DB.php on line 318
- Signature: public function getFields($form,$fields,$parent,$where_data,$ordering,$limit,$field_reference_callback,$mod_time,$user)
- Parameters:
- string $form
The form we are select from - array $fields
of string. the fields that we want to select. the keys are the fields names, the values are what we wish to select them as. 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"- Default Value: array()
- 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. - $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
- $field_reference_callback
- Default Value: null
- 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 $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.- Default Value: -1
- mixed $user
The user id of the user to limit the results to so it only returns results limited to that user. This can be a single value or an array- Default Value: false
- string $form
- Returns: string
the SQL Query needed to get the form/field data or false on failure.
getIdsAsChild()
Gets the id's for the given child for this form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 417
- Signature: public function getIdsAsChild($form,$parent_form_id,$order_by,$where,$limit)
- Parameters:
- Returns: array
getRecords()
Return an array of all the record ids for a given form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 274
- Signature: public function getRecords($form)
- Parameters:
- string $form
- Returns: array
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 i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 72
- Signature: abstract public function getRequiredFieldsQuery($form,$fields,$id,$parent,$field_reference_callback,$mod_time,$user)
- Parameters:
- string $form
- mixed $fields
Either a string, the field, or an array of string, the fields. Can also include the special field "last_modified" to get the last modification time on any of the fields - mixed $id
Defaults to null. If non-null it is the id that we wish to limit to.- Default Value: null
- 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.- Default Value: false
- $field_reference_callback
- Default Value: null
- 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
- mixed $user
The user id of the user to limit the results to so it only returns results limited to that user. This can be a single value or an array- Default Value: false
- Returns: string
the query or false on failed.
globalFieldUpdateBySQL()
update value of each instanceo of a given form field by a pho function call @param {I2CE_FormField} $form_field
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 88
- Signature: public function globalFieldUpdateBySQL($form_field,$where,$set_sql)
- Parameters:
hasGlobalFieldUpdateBySql()
Check to see if there is a quick field update implemented
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 78
- Signature: public function hasGlobalFieldUpdateBySql()
- Returns: true
if there is a method to quickly update all instances of a given field via SQL
listDisplayFields()
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 572
- Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time,$user)
- Parameters:
- string $form
- 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
- mixed $user
The user id of the user to limit the results to so it only returns results limited to that user. This can be a single value or an array- Default Value: false
- 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_DB.php on line 510
- Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
- Parameters:
- string $form
- 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.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 193
- Signature: public function lookupDisplayField($form,$id,$fields,$delim)
- Parameters:
- Returns: string
false on failure
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.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 148
- Signature: public function lookupField($form,$id,$fields,$delim)
- Parameters:
- Returns: string
false on failure
populate()
Populate the member variables of the object from the database.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 99
- Signature: public function populate($form)
- Parameters:
- I2CE_Form $form
queryLastListCount()
Query the last list count and set it in FormStorage
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 632
- Signature: protected function queryLastListCount($form)
- Parameters:
- string $form
The form name to set.
- string $form
search()
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_DB.php on line 447
- 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
- string $form
- 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.
Inherited Methods
FF_IG_setSequence()
This public method is inherited from I2CE_FormStorage_Mechanism->FF_IG_setSequence()
FF_save()
This public method is inherited from I2CE_FormStorage_Mechanism->FF_save()
changeID()
This public method is inherited from I2CE_FormStorage_Mechanism->changeID()
delete()
This public method is inherited from I2CE_FormStorage_Mechanism->delete()
getFormsById()
This public method is inherited from I2CE_FormStorage_Mechanism->getFormsById()
globalFieldUpdateByFunction()
This public method is inherited from I2CE_FormStorage_Mechanism->globalFieldUpdateByFunction()
hasRecord()
This public method is inherited from I2CE_FormStorage_Mechanism->hasRecord()
isWritable()
This public method is inherited from I2CE_FormStorage_Mechanism->isWritable()
populateHistory()
This public method is inherited from I2CE_FormStorage_Mechanism->populateHistory()
save()
This public method is inherited from I2CE_FormStorage_Mechanism->save()
setStorageOptions()
This public method is inherited from I2CE_FormStorage_Mechanism->setStorageOptions()
compareFormsByFields()
This protected method is inherited from I2CE_FormStorage_Mechanism->compareFormsByFields()
getLimitedFields()
This protected method is inherited from I2CE_FormStorage_Mechanism->getLimitedFields()
getStorageOptions()
This protected method is inherited from I2CE_FormStorage_Mechanism->getStorageOptions()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Variables
$name
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$name
$global_options
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$global_options
$storage_options_cache
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$storage_options_cache
$ordering
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$ordering
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()