Class: I2CE FormStorage magicdata: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
*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]] | *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= | =modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php= | ||
This article desrcibes the class '''I2CE_FormStorage_magicdata''' | This article desrcibes the class '''I2CE_FormStorage_magicdata'''. | ||
*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] | It is contained in the module [[iHRIS Module List#forms-storage-magicdata|forms-storage-magicdata]] in the package [https://launchpad.net/i2ce I2CE] | ||
| Line 16: | Line 17: | ||
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. | ||
*Signature: public function FF_populateHistory($form_field) | *Signature: public function FF_populateHistory($form_field) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_FormField | I2CE_FormField]] $form_field | * [[Class: I2CE_FormField | I2CE_FormField]] $form_field | ||
| Line 22: | Line 23: | ||
Save the FormField to the database. | Save the FormField to the database. | ||
*Signature: public function FF_save($form_field,$do_check,$user) | *Signature: public function FF_save($form_field,$do_check,$user) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_FormField | I2CE_FormField]] $form_field | * [[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. | * [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. | * [[Class: I2CE_User | I2CE_User]] $user<br/>: The user saving this data. | ||
===__construct()=== | ===__construct()=== | ||
| Line 31: | Line 32: | ||
*Signature: public function __construct($name,$options) | *Signature: public function __construct($name,$options) | ||
Parameters: | 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.string.php string ] $name<br/>The name of this storage mechanism | ||
* [http://www.php.net/manual/en/language.types.array.php array] $options | * [http://www.php.net/manual/en/language.types.array.php array ] $options | ||
**Default Value: array() | **Default Value: array() | ||
===delete()=== | ===delete()=== | ||
| Line 39: | Line 40: | ||
table. default: false | table. default: false | ||
*Signature: public function delete($form,$transact,$complete,$no_history) | *Signature: public function delete($form,$transact,$complete,$no_history) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_Form | I2CE_Form]] $form | * [[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 ] $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 | * [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 | *$no_history | ||
===getFormConfig()=== | ===getFormConfig()=== | ||
| Line 50: | Line 51: | ||
*Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] | *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] | ||
Parameters: | 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.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 | * [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create_id<br/>Defaults to false | ||
**Default Value: false | **Default Value: false | ||
===getFormConfigById()=== | ===getFormConfigById()=== | ||
| Line 57: | Line 58: | ||
*Signature: protected function getFormConfigById($form_name,$id,$create_id) | *Signature: protected function getFormConfigById($form_name,$id,$create_id) | ||
Parameters: | 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 ] $form_name | ||
* [http://www.php.net/manual/en/language.types.string.php string] $id | * [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. | * [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create_id<br/>Defaults to false. | ||
**Default Value: false | **Default Value: false | ||
===getNextAvailableId()=== | ===getNextAvailableId()=== | ||
| Line 66: | Line 67: | ||
*Returns: int. 0 on failure. An integer > 0 on success. | *Returns: int. 0 on failure. An integer > 0 on success. | ||
Parameters: | 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 ] $form_name | ||
===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. | ||
*Signature: public function getRecords($form_name) | *Signature: public function getRecords($form_name) | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
Parameters: | 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 ] $form_name | ||
===isWritable()=== | ===isWritable()=== | ||
Checks to see if this is writalbe | Checks to see if this is writalbe | ||
*Signature: public function isWritable() | *Signature: public function isWritable() | ||
*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()=== | ||
and then we get all forms with parent the given id. If true, we return the parent as one of the fields. | and then we get all forms with parent the given id. If true, we return the parent as one of the fields. | ||
| Line 82: | Line 83: | ||
time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | 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) | *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. | *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: | 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 | ||
* [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, | * [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 | **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 | * [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() | **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. | * [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() | **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. | * [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 | **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 | * 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 | ||
| Line 101: | Line 102: | ||
time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | 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) | *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. | *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: | 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 | ||
* [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, | * [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 | **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 | * [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() | **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. | * [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() | **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. | * [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 | **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 | * 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 | ||
| Line 122: | Line 123: | ||
than one. If false, returns the values as an array. | than one. If false, returns the values as an array. | ||
*Signature: public function lookupDisplayField($form,$id,$fields,$delim) | *Signature: public function lookupDisplayField($form,$id,$fields,$delim) | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string] false on failure | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] false on failure | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of the form in the database. | * [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. | * 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.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 | * [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()=== | ===lookupField()=== | ||
Looks up the db value of the item based on the code. | Looks up the db value of the item based on the code. | ||
| Line 135: | Line 136: | ||
than one. If false, returns the values as an array. | than one. If false, returns the values as an array. | ||
*Signature: public function lookupField($form,$id,$fields,$delim) | *Signature: public function lookupField($form,$id,$fields,$delim) | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string] false on failure | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] false on failure | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of the form in the database. | * [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. | * 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.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 | * [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()=== | ===orderByFields()=== | ||
*Signature: static public function orderByFields($vals,$ordering) | *Signature: static public function orderByFields($vals,$ordering) | ||
| Line 155: | Line 156: | ||
If it is as an array of two integers, it is the offset and then number of results to limit to. | 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) | *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 | *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. | array ($offset,1) then then we return either the id or false, if none found or there was an error. | ||
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.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, | * [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 | **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. | * [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() | **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. | * [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 | **Default Value: false | ||
===save()=== | ===save()=== | ||
| Line 171: | Line 172: | ||
* [[Class: I2CE_Form | I2CE_Form]] $form | * [[Class: I2CE_Form | I2CE_Form]] $form | ||
* [[Class: I2CE_User | I2CE_User]] $user | * [[Class: I2CE_User | I2CE_User]] $user | ||
* [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()=== | ||
and then we get all forms with parent the given id. | 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. | 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) | *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 | *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. | array ($offset,1) then then we return either the id or false, if none found or there was an error. | ||
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.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, | * [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 | **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. | * [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() | **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. | * [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() | **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. | * [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 | **Default Value: false | ||
| Line 202: | Line 203: | ||
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->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= | =modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php= | ||
This article desrcibes the class '''I2CE_FormStorage_magicdata''' | This article desrcibes the class '''I2CE_FormStorage_magicdata'''. | ||
*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] | It is contained in the module [[iHRIS Module List#forms-storage-magicdata|forms-storage-magicdata]] in the package [https://launchpad.net/i2ce I2CE] | ||
| Line 215: | Line 217: | ||
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. | ||
*Signature: public function FF_populateHistory($form_field) | *Signature: public function FF_populateHistory($form_field) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_FormField | I2CE_FormField]] $form_field | * [[Class: I2CE_FormField | I2CE_FormField]] $form_field | ||
| Line 221: | Line 223: | ||
Save the FormField to the database. | Save the FormField to the database. | ||
*Signature: public function FF_save($form_field,$do_check,$user) | *Signature: public function FF_save($form_field,$do_check,$user) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_FormField | I2CE_FormField]] $form_field | * [[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. | * [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. | * [[Class: I2CE_User | I2CE_User]] $user<br/>: The user saving this data. | ||
===__construct()=== | ===__construct()=== | ||
| Line 230: | Line 232: | ||
*Signature: public function __construct($name,$options) | *Signature: public function __construct($name,$options) | ||
Parameters: | 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.string.php string ] $name<br/>The name of this storage mechanism | ||
* [http://www.php.net/manual/en/language.types.array.php array] $options | * [http://www.php.net/manual/en/language.types.array.php array ] $options | ||
**Default Value: array() | **Default Value: array() | ||
===delete()=== | ===delete()=== | ||
| Line 238: | Line 240: | ||
table. default: false | table. default: false | ||
*Signature: public function delete($form,$transact,$complete,$no_history) | *Signature: public function delete($form,$transact,$complete,$no_history) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_Form | I2CE_Form]] $form | * [[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 ] $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 | * [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 | *$no_history | ||
===getFormConfig()=== | ===getFormConfig()=== | ||
| Line 249: | Line 251: | ||
*Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] | *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] | ||
Parameters: | 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.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 | * [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create_id<br/>Defaults to false | ||
**Default Value: false | **Default Value: false | ||
===getFormConfigById()=== | ===getFormConfigById()=== | ||
| Line 256: | Line 258: | ||
*Signature: protected function getFormConfigById($form_name,$id,$create_id) | *Signature: protected function getFormConfigById($form_name,$id,$create_id) | ||
Parameters: | 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 ] $form_name | ||
* [http://www.php.net/manual/en/language.types.string.php string] $id | * [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. | * [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create_id<br/>Defaults to false. | ||
**Default Value: false | **Default Value: false | ||
===getNextAvailableId()=== | ===getNextAvailableId()=== | ||
| Line 265: | Line 267: | ||
*Returns: int. 0 on failure. An integer > 0 on success. | *Returns: int. 0 on failure. An integer > 0 on success. | ||
Parameters: | 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 ] $form_name | ||
===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. | ||
*Signature: public function getRecords($form_name) | *Signature: public function getRecords($form_name) | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
Parameters: | 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 ] $form_name | ||
===isWritable()=== | ===isWritable()=== | ||
Checks to see if this is writalbe | Checks to see if this is writalbe | ||
*Signature: public function isWritable() | *Signature: public function isWritable() | ||
*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()=== | ||
and then we get all forms with parent the given id. If true, we return the parent as one of the fields. | and then we get all forms with parent the given id. If true, we return the parent as one of the fields. | ||
| Line 281: | Line 283: | ||
time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | 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) | *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. | *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: | 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 | ||
* [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, | * [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 | **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 | * [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() | **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. | * [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() | **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. | * [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 | **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 | * 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 | ||
| Line 300: | Line 302: | ||
time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | 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) | *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. | *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: | 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 | ||
* [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, | * [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 | **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 | * [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() | **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. | * [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() | **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. | * [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 | **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 | * 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 | ||
| Line 321: | Line 323: | ||
than one. If false, returns the values as an array. | than one. If false, returns the values as an array. | ||
*Signature: public function lookupDisplayField($form,$id,$fields,$delim) | *Signature: public function lookupDisplayField($form,$id,$fields,$delim) | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string] false on failure | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] false on failure | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of the form in the database. | * [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. | * 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.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 | * [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()=== | ===lookupField()=== | ||
Looks up the db value of the item based on the code. | Looks up the db value of the item based on the code. | ||
| Line 334: | Line 336: | ||
than one. If false, returns the values as an array. | than one. If false, returns the values as an array. | ||
*Signature: public function lookupField($form,$id,$fields,$delim) | *Signature: public function lookupField($form,$id,$fields,$delim) | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string] false on failure | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] false on failure | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of the form in the database. | * [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. | * 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.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 | * [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()=== | ===orderByFields()=== | ||
*Signature: static public function orderByFields($vals,$ordering) | *Signature: static public function orderByFields($vals,$ordering) | ||
| Line 354: | Line 356: | ||
If it is as an array of two integers, it is the offset and then number of results to limit to. | 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) | *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 | *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. | array ($offset,1) then then we return either the id or false, if none found or there was an error. | ||
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.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, | * [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 | **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. | * [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() | **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. | * [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 | **Default Value: false | ||
===save()=== | ===save()=== | ||
| Line 370: | Line 372: | ||
* [[Class: I2CE_Form | I2CE_Form]] $form | * [[Class: I2CE_Form | I2CE_Form]] $form | ||
* [[Class: I2CE_User | I2CE_User]] $user | * [[Class: I2CE_User | I2CE_User]] $user | ||
* [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()=== | ||
and then we get all forms with parent the given id. | 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. | 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) | *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 | *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. | array ($offset,1) then then we return either the id or false, if none found or there was an error. | ||
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.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, | * [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 | **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. | * [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() | **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. | * [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() | **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. | * [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 | **Default Value: false | ||
Revision as of 22:26, 16 October 2009
The class I2CE_FormStorage_magicdata contains 2 definitions:
- Definition in 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
This article desrcibes the class I2CE_FormStorage_magicdata.
- Extends the class: I2CE_FormStorage_Mechanism.
It is contained in the module forms-storage-magicdata in the package I2CE
The class is defined in the file: modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php
I2CE_Module_FormStorageEntry @subpackage Core
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: 3.2
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: boolean
Parameters:
- I2CE_FormField $form_field
FF_save()
Save the FormField to the database.
- Signature: public function FF_save($form_field,$do_check,$user)
- Returns: boolean
Parameters:
- I2CE_FormField $form_field
- boolean $do_check
: A flag to determine if a check should be made for the same value being saved. - I2CE_User $user
: The user saving this data.
__construct()
Construct this module class
- Signature: public function __construct($name,$options)
Parameters:
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: boolean
Parameters:
- I2CE_Form $form
- boolean $transact
: a flag to use transactions or not. default: true - boolean $complete
: 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: I2CE_MagicDataNode
Parameters:
getFormConfigById()
Return the magic data node for the given form name and id
- Signature: protected function getFormConfigById($form_name,$id,$create_id)
Parameters:
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:
- string $form_name
getRecords()
Return an array of all the record ids for a given form.
- Signature: public function getRecords($form_name)
- Returns: array
Parameters:
- string $form_name
isWritable()
Checks to see if this is writalbe
- Signature: public function isWritable()
- Returns: 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: 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:
- string $form
THe form name - array $fields
of string. The fields we want returned - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent,- 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.- 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- 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: 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:
- string $form
THe form name - array $fields
of string. The fields we want returned - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent,- 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.- 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- 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: string false on failure
Parameters:
- string $form
The name of the form in the database. - integer $id
The code of the entry to lookup. - array $fields
A list of fields to look up and return. - string $delim
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: string false on failure
Parameters:
- string $form
The name of the form in the database. - integer $id
The code of the entry to lookup. - array $fields
A list of fields to look up and return. - string $delim
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:
- 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: 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:
- 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,- Default Value: false
- mixed $where_data
array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.- 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.- Default Value: false
save()
Save a form object into magicdata
- Signature: public function save($form,$user,$transact)
Parameters:
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: 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:
- 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,- 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.- Default Value: false
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
$ordering
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$ordering
Inherited Fuzzy Methods
userMessage()
This method is inherited from 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.
- Extends the class: I2CE_FormStorage_Mechanism.
It is contained in the module forms-storage-magicdata in the package I2CE
The class is defined in the file: modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php
I2CE_Module_FormStorageEntry @subpackage Core
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: 3.2
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: boolean
Parameters:
- I2CE_FormField $form_field
FF_save()
Save the FormField to the database.
- Signature: public function FF_save($form_field,$do_check,$user)
- Returns: boolean
Parameters:
- I2CE_FormField $form_field
- boolean $do_check
: A flag to determine if a check should be made for the same value being saved. - I2CE_User $user
: The user saving this data.
__construct()
Construct this module class
- Signature: public function __construct($name,$options)
Parameters:
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: boolean
Parameters:
- I2CE_Form $form
- boolean $transact
: a flag to use transactions or not. default: true - boolean $complete
: 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: I2CE_MagicDataNode
Parameters:
getFormConfigById()
Return the magic data node for the given form name and id
- Signature: protected function getFormConfigById($form_name,$id,$create_id)
Parameters:
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:
- string $form_name
getRecords()
Return an array of all the record ids for a given form.
- Signature: public function getRecords($form_name)
- Returns: array
Parameters:
- string $form_name
isWritable()
Checks to see if this is writalbe
- Signature: public function isWritable()
- Returns: 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: 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:
- string $form
THe form name - array $fields
of string. The fields we want returned - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent,- 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.- 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- 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: 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:
- string $form
THe form name - array $fields
of string. The fields we want returned - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent,- 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.- 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- 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: string false on failure
Parameters:
- string $form
The name of the form in the database. - integer $id
The code of the entry to lookup. - array $fields
A list of fields to look up and return. - string $delim
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: string false on failure
Parameters:
- string $form
The name of the form in the database. - integer $id
The code of the entry to lookup. - array $fields
A list of fields to look up and return. - string $delim
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:
- 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: 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:
- 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,- Default Value: false
- mixed $where_data
array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.- 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.- Default Value: false
save()
Save a form object into magicdata
- Signature: public function save($form,$user,$transact)
Parameters:
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: 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:
- 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,- 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.- Default Value: false
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
$ordering
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$ordering
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
