|
|
| (32 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| The class I2CE_FormStorage_magicdata contains 2 definitions:
| | #REDIRECT [[Class: I2CE_FormStorage_magicdata (4.1.7)]] |
| *Definition in [[#modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php|modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php]]
| |
| *Definition in [[#modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php|modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php]]
| |
| =modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php=
| |
| This article desrcibes the class '''I2CE_FormStorage_magicdata'''which extends the class [[Class: I2CE_FormStorage_Mechanism | I2CE_FormStorage_Mechanism]]
| |
| It is contained in the module [[iHRIS Module List#forms-storage-magicdata|forms-storage-magicdata]] in the package [https://launchpad.net/i2ce I2CE]
| |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php]
| |
| I2CE_Module_FormStorageEntry
| |
| @package I2CE
| |
| @subpackage Core
| |
| @author Carl Leitner <litlfred@ibiblio.org>
| |
| | |
| @version 3.2
| |
| @since 3.2
| |
| @access public
| |
| ==Methods==
| |
| ===FF_populateHistory()===
| |
| Populate the history of entries for the form field if the storage module handles history.
| |
| *Signature: public function FF_populateHistory($form_field)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| Parameters:
| |
| * [[Class: I2CE_FormField | I2CE_FormField]] $form_field
| |
| ===FF_save()===
| |
| Save the FormField to the database.
| |
| *Signature: public function FF_save($form_field,$do_check,$user)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| 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.
| |
| ===__construct()===
| |
| Construct this module class
| |
| *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
| |
| *Signature: public function delete($form,$transact,$complete,$no_history)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| 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
| |
| ===getFormConfig()===
| |
| Return the magic data node for the given form.
| |
| *Signature: protected function getFormConfig($form,$create_id)
| |
| *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]]
| |
| 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
| |
| ===getFormConfigById()===
| |
| Return the magic data node for the given form name and id
| |
| *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
| |
| *Signature: protected function getNextAvailableId($form_name)
| |
| *Returns: int. 0 on failure. An integer > 0 on success.
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form_name
| |
| ===getRecords()===
| |
| Return an array of all the record ids for a given form.
| |
| *Signature: public function getRecords($form_name)
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array]
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form_name
| |
| ===isWritable()===
| |
| Checks to see if this is writalbe
| |
| *Signature: public function isWritable()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| ===listDisplayFields()===
| |
| and then we get all forms with parent the given id. If true, we return the parent as one of the fields.
| |
| If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.
| |
| *Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php 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.
| |
| 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,
| |
| **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.
| |
| **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
| |
| **Default Value: -1
| |
| ===listFields()===
| |
| and then we get all forms with parent the given id. If true, we return the parent as one of the fields.
| |
| If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.
| |
| *Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php 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.
| |
| 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,
| |
| **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.
| |
| **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
| |
| **Default Value: -1
| |
| ===lookupDisplayField()===
| |
| Looks up the display vlaue of the item based on the code.
| |
| | |
| This is the default method that most implementations of {@link lookup()} use. It finds the description of
| |
| the object based on the code and saves it in the {@link cache} and returns it.
| |
| than one. If false, returns the values as an array.
| |
| *Signature: public function lookupDisplayField($form,$id,$fields,$delim)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string] false on failure
| |
| 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
| |
| ===lookupField()===
| |
| Looks up the db value of the item based on the code.
| |
| | |
| This is the default method that most implementations of {@link lookup()} use. It finds the description of
| |
| the object based on the code and saves it in the {@link cache} and returns it.
| |
| than one. If false, returns the values as an array.
| |
| *Signature: public function lookupField($form,$id,$fields,$delim)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string] false on failure
| |
| 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
| |
| ===orderByFields()===
| |
| *Signature: static public function orderByFields($vals,$ordering)
| |
| Parameters:
| |
| *$vals
| |
| *$ordering
| |
| ===populate()===
| |
| Populate the member variables of the object from the database.
| |
| *Signature: public function populate($form)
| |
| Parameters:
| |
| * [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ===quickSearch()===
| |
| and then we get all forms with parent the given id.
| |
| If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| *Signature: protected function quickSearch($form,$parent,$where_data,$limit)
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php 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.
| |
| 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,
| |
| **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.
| |
| **Default Value: false
| |
| ===save()===
| |
| Save a form object into magicdata
| |
| *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()===
| |
| and then we get all forms with parent the given id.
| |
| If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| *Signature: public function search($form,$parent,$where_data,$ordering,$limit)
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php 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.
| |
| 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,
| |
| **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.
| |
| **Default Value: false
| |
| | |
| ==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()]]
| |
| =modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php=
| |
| This article desrcibes the class '''I2CE_FormStorage_magicdata'''which extends the class [[Class: I2CE_FormStorage_Mechanism | I2CE_FormStorage_Mechanism]]
| |
| It is contained in the module [[iHRIS Module List#forms-storage-magicdata|forms-storage-magicdata]] in the package [https://launchpad.net/i2ce I2CE]
| |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php]
| |
| I2CE_Module_FormStorageEntry
| |
| @package I2CE
| |
| @subpackage Core
| |
| @author Carl Leitner <litlfred@ibiblio.org>
| |
| | |
| @version 3.2
| |
| @since 3.2
| |
| @access public
| |
| ==Methods==
| |
| ===FF_populateHistory()===
| |
| Populate the history of entries for the form field if the storage module handles history.
| |
| *Signature: public function FF_populateHistory($form_field)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| Parameters:
| |
| * [[Class: I2CE_FormField | I2CE_FormField]] $form_field
| |
| ===FF_save()===
| |
| Save the FormField to the database.
| |
| *Signature: public function FF_save($form_field,$do_check,$user)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| 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.
| |
| ===__construct()===
| |
| Construct this module class
| |
| *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
| |
| *Signature: public function delete($form,$transact,$complete,$no_history)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| 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
| |
| ===getFormConfig()===
| |
| Return the magic data node for the given form.
| |
| *Signature: protected function getFormConfig($form,$create_id)
| |
| *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]]
| |
| 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
| |
| ===getFormConfigById()===
| |
| Return the magic data node for the given form name and id
| |
| *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
| |
| *Signature: protected function getNextAvailableId($form_name)
| |
| *Returns: int. 0 on failure. An integer > 0 on success.
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form_name
| |
| ===getRecords()===
| |
| Return an array of all the record ids for a given form.
| |
| *Signature: public function getRecords($form_name)
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array]
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form_name
| |
| ===isWritable()===
| |
| Checks to see if this is writalbe
| |
| *Signature: public function isWritable()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| ===listDisplayFields()===
| |
| and then we get all forms with parent the given id. If true, we return the parent as one of the fields.
| |
| If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.
| |
| *Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php 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.
| |
| 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,
| |
| **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.
| |
| **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
| |
| **Default Value: -1
| |
| ===listFields()===
| |
| and then we get all forms with parent the given id. If true, we return the parent as one of the fields.
| |
| If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.
| |
| *Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php 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.
| |
| 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,
| |
| **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.
| |
| **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
| |
| **Default Value: -1
| |
| ===lookupDisplayField()===
| |
| Looks up the display vlaue of the item based on the code.
| |
| | |
| This is the default method that most implementations of {@link lookup()} use. It finds the description of
| |
| the object based on the code and saves it in the {@link cache} and returns it.
| |
| than one. If false, returns the values as an array.
| |
| *Signature: public function lookupDisplayField($form,$id,$fields,$delim)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string] false on failure
| |
| 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
| |
| ===lookupField()===
| |
| Looks up the db value of the item based on the code.
| |
| | |
| This is the default method that most implementations of {@link lookup()} use. It finds the description of
| |
| the object based on the code and saves it in the {@link cache} and returns it.
| |
| than one. If false, returns the values as an array.
| |
| *Signature: public function lookupField($form,$id,$fields,$delim)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string] false on failure
| |
| 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
| |
| ===orderByFields()===
| |
| *Signature: static public function orderByFields($vals,$ordering)
| |
| Parameters:
| |
| *$vals
| |
| *$ordering
| |
| ===populate()===
| |
| Populate the member variables of the object from the database.
| |
| *Signature: public function populate($form)
| |
| Parameters:
| |
| * [[Class: I2CE_Form | I2CE_Form]] $form
| |
| ===quickSearch()===
| |
| and then we get all forms with parent the given id.
| |
| If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| *Signature: protected function quickSearch($form,$parent,$where_data,$limit)
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php 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.
| |
| 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,
| |
| **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.
| |
| **Default Value: false
| |
| ===save()===
| |
| Save a form object into magicdata
| |
| *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()===
| |
| and then we get all forms with parent the given id.
| |
| If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| *Signature: public function search($form,$parent,$where_data,$ordering,$limit)
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php 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.
| |
| 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,
| |
| **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.
| |
| **Default Value: false
| |
| | |
| ==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]]
| |
