Class: I2CE FormStorage magicdata: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 14: | Line 14: | ||
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) | ||
*Parameters: | |||
** [[Class: I2CE_FormField | I2CE_FormField]] $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 ] | ||
===FF_save()=== | ===FF_save()=== | ||
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) | ||
*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. | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===__construct()=== | ===__construct()=== | ||
Construct this module class | Construct this module class | ||
*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()=== | ||
Deletes a form from the entry tables. | 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 | ||
@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) | *Signature: public function delete($form,$transact,$complete,$no_history) | ||
*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 | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===getFormConfig()=== | ===getFormConfig()=== | ||
Return the magic data node for the given form. | Return the magic data node for the given form. | ||
*Signature: protected function getFormConfig($form,$create_id) | *Signature: protected function getFormConfig($form,$create_id) | ||
*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 | |||
*Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] | *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] | ||
===getFormConfigById()=== | ===getFormConfigById()=== | ||
Return the magic data node for the given form name and id | Return the magic data node for the given form name and id | ||
*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()=== | ||
Gets the next unused integer id for the form. At least 1 | Gets the next unused integer id for the form. At least 1 | ||
*Signature: protected function getNextAvailableId($form_name) | *Signature: protected function getNextAvailableId($form_name) | ||
* | *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 | *Returns: int.<br/>0 on failure. An integer > 0 on success. | ||
===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) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $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 ] | ||
===isWritable()=== | ===isWritable()=== | ||
Checks to see if this is writalbe | Checks to see if this is writalbe | ||
| Line 76: | Line 74: | ||
*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()=== | ||
*Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | *Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | ||
* | *Parameters: | ||
Parameters: | ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>THe form name | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>THe form name | ** [http://www.php.net/manual/en/language.types.array.php array ] $fields <br/>of string. The fields we want returned | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $fields<br/>of string. The fields we want returned | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. If true, we return the parent as one of the fields. | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent<br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, | ***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. If it is as an array of two integers, it is the offset and then number of results 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 time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | ||
* integer $mod_time<br/>Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification | ***Default Value: -1 | ||
**Default Value: -1 | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value. | ||
===listFields()=== | ===listFields()=== | ||
*Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | *Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | ||
* | *Parameters: | ||
Parameters: | ** [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, and then we get all forms with parent the given id. If true, we return the parent as one of the fields. | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent<br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, | ***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. If it is as an array of two integers, it is the offset and then number of results 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 time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | ||
* integer $mod_time<br/>Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification | ***Default Value: -1 | ||
**Default Value: -1 | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value. | ||
===lookupDisplayField()=== | ===lookupDisplayField()=== | ||
Looks up the display vlaue of the item based on the code. | 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 cache and returns it. | ||
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 cache and returns it | |||
*Signature: public function lookupDisplayField($form,$id,$fields,$delim) | *Signature: public function lookupDisplayField($form,$id,$fields,$delim) | ||
* | *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 than one. If false, returns the values as an array. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $delim<br/>The delimiter to put between returned fields if there are more | *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>false on failure | ||
===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. 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 cache and returns it. | ||
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 cache and returns it | |||
*Signature: public function lookupField($form,$id,$fields,$delim) | *Signature: public function lookupField($form,$id,$fields,$delim) | ||
* | *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 than one. If false, returns the values as an array. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $delim<br/>The delimiter to put between returned fields if there are more | *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>false on failure | ||
===orderByFields()=== | ===orderByFields()=== | ||
*Signature: static public function orderByFields($vals,$ordering) | *Signature: static public function orderByFields($vals,$ordering) | ||
Parameters: | *Parameters: | ||
*$vals | *$vals | ||
*$ordering | *$ordering | ||
| Line 147: | Line 131: | ||
Populate the member variables of the object from the database. | Populate the member variables of the object from the database. | ||
*Signature: public function populate($form) | *Signature: public function populate($form) | ||
Parameters: | *Parameters: | ||
* [[Class: I2CE_Form | I2CE_Form]] $form | ** [[Class: I2CE_Form | I2CE_Form]] $form | ||
===quickSearch()=== | ===quickSearch()=== | ||
*Signature: protected function quickSearch($form,$parent,$where_data,$limit) | *Signature: protected function quickSearch($form,$parent,$where_data,$limit) | ||
* | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name. | |||
Parameters: | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The form name. | ***Default Value: false | ||
* [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.pseudo-types.php mixed ] $where_data <br/>array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data. | ||
**Default Value: false | ***Default Value: array() | ||
* [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 ] $limit <br/>Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to. | ||
**Default Value: array() | ***Default Value: false | ||
* [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. | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>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. | ||
**Default Value: false | |||
===save()=== | ===save()=== | ||
Save a form object into magicdata | Save a form object into magicdata | ||
*Signature: public function save($form,$user,$transact) | *Signature: public function save($form,$user,$transact) | ||
Parameters: | *Parameters: | ||
* [[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()=== | ||
*Signature: public function search($form,$parent,$where_data,$ordering,$limit) | *Signature: public function search($form,$parent,$where_data,$ordering,$limit) | ||
* | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name. | |||
Parameters: | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The form name. | ***Default Value: false | ||
* [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.pseudo-types.php mixed ] $where_data <br/>array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data. | ||
**Default Value: false | ***Default Value: array() | ||
* [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.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.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.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. If it is as an array of two integers, it is the offset and then number of results to limit to. | ||
**Default Value: array() | ***Default Value: false | ||
* [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. | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>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. | ||
**Default Value: false | |||
==Inherited Variables== | ==Inherited Variables== | ||
| Line 211: | Line 189: | ||
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) | ||
*Parameters: | |||
** [[Class: I2CE_FormField | I2CE_FormField]] $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 ] | ||
===FF_save()=== | ===FF_save()=== | ||
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) | ||
*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. | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===__construct()=== | ===__construct()=== | ||
Construct this module class | Construct this module class | ||
*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()=== | ||
Deletes a form from the entry tables. | 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 | ||
@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) | *Signature: public function delete($form,$transact,$complete,$no_history) | ||
*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 | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===getFormConfig()=== | ===getFormConfig()=== | ||
Return the magic data node for the given form. | Return the magic data node for the given form. | ||
*Signature: protected function getFormConfig($form,$create_id) | *Signature: protected function getFormConfig($form,$create_id) | ||
*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 | |||
*Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] | *Returns: [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] | ||
===getFormConfigById()=== | ===getFormConfigById()=== | ||
Return the magic data node for the given form name and id | Return the magic data node for the given form name and id | ||
*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()=== | ||
Gets the next unused integer id for the form. At least 1 | Gets the next unused integer id for the form. At least 1 | ||
*Signature: protected function getNextAvailableId($form_name) | *Signature: protected function getNextAvailableId($form_name) | ||
* | *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 | *Returns: int.<br/>0 on failure. An integer > 0 on success. | ||
===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) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $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 ] | ||
===isWritable()=== | ===isWritable()=== | ||
Checks to see if this is writalbe | Checks to see if this is writalbe | ||
| Line 273: | Line 249: | ||
*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()=== | ||
*Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | *Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | ||
* | *Parameters: | ||
Parameters: | ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>THe form name | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>THe form name | ** [http://www.php.net/manual/en/language.types.array.php array ] $fields <br/>of string. The fields we want returned | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $fields<br/>of string. The fields we want returned | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. If true, we return the parent as one of the fields. | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent<br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, | ***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. If it is as an array of two integers, it is the offset and then number of results 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 time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | ||
* integer $mod_time<br/>Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification | ***Default Value: -1 | ||
**Default Value: -1 | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value. | ||
===listFields()=== | ===listFields()=== | ||
*Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | *Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time) | ||
* | *Parameters: | ||
Parameters: | ** [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, and then we get all forms with parent the given id. If true, we return the parent as one of the fields. | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent<br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, | ***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. If it is as an array of two integers, it is the offset and then number of results 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 time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed. | ||
* integer $mod_time<br/>Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification | ***Default Value: -1 | ||
**Default Value: -1 | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value. | ||
===lookupDisplayField()=== | ===lookupDisplayField()=== | ||
Looks up the display vlaue of the item based on the code. | 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 cache and returns it. | ||
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 cache and returns it | |||
*Signature: public function lookupDisplayField($form,$id,$fields,$delim) | *Signature: public function lookupDisplayField($form,$id,$fields,$delim) | ||
* | *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 than one. If false, returns the values as an array. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $delim<br/>The delimiter to put between returned fields if there are more | *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>false on failure | ||
===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. 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 cache and returns it. | ||
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 cache and returns it | |||
*Signature: public function lookupField($form,$id,$fields,$delim) | *Signature: public function lookupField($form,$id,$fields,$delim) | ||
* | *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 than one. If false, returns the values as an array. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $delim<br/>The delimiter to put between returned fields if there are more | *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>false on failure | ||
===orderByFields()=== | ===orderByFields()=== | ||
*Signature: static public function orderByFields($vals,$ordering) | *Signature: static public function orderByFields($vals,$ordering) | ||
Parameters: | *Parameters: | ||
*$vals | *$vals | ||
*$ordering | *$ordering | ||
| Line 344: | Line 306: | ||
Populate the member variables of the object from the database. | Populate the member variables of the object from the database. | ||
*Signature: public function populate($form) | *Signature: public function populate($form) | ||
Parameters: | *Parameters: | ||
* [[Class: I2CE_Form | I2CE_Form]] $form | ** [[Class: I2CE_Form | I2CE_Form]] $form | ||
===quickSearch()=== | ===quickSearch()=== | ||
*Signature: protected function quickSearch($form,$parent,$where_data,$limit) | *Signature: protected function quickSearch($form,$parent,$where_data,$limit) | ||
* | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name. | |||
Parameters: | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The form name. | ***Default Value: false | ||
* [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.pseudo-types.php mixed ] $where_data <br/>array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data. | ||
**Default Value: false | ***Default Value: array() | ||
* [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 ] $limit <br/>Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to. | ||
**Default Value: array() | ***Default Value: false | ||
* [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. | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>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. | ||
**Default Value: false | |||
===save()=== | ===save()=== | ||
Save a form object into magicdata | Save a form object into magicdata | ||
*Signature: public function save($form,$user,$transact) | *Signature: public function save($form,$user,$transact) | ||
Parameters: | *Parameters: | ||
* [[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()=== | ||
*Signature: public function search($form,$parent,$where_data,$ordering,$limit) | *Signature: public function search($form,$parent,$where_data,$ordering,$limit) | ||
* | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name. | |||
Parameters: | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $parent <br/>Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The form name. | ***Default Value: false | ||
* [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.pseudo-types.php mixed ] $where_data <br/>array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data. | ||
**Default Value: false | ***Default Value: array() | ||
* [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.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.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.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. If it is as an array of two integers, it is the offset and then number of results to limit to. | ||
**Default Value: array() | ***Default Value: false | ||
* [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. | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>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. | ||
**Default Value: false | |||
==Inherited Variables== | ==Inherited Variables== | ||
Revision as of 23:41, 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.
- Location: Part of the module forms-storage-magicdata in the package I2CE
- Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: 3.2
I2CE_Module_FormStorageEntry
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)
- Parameters:
- I2CE_FormField $form_field
- Returns: boolean
FF_save()
Save the FormField to the database.
- Signature: public function FF_save($form_field,$do_check,$user)
- 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.
- Returns: boolean
__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)
- Parameters:
- $no_history
- Returns: boolean
getFormConfig()
Return the magic data node for the given form.
- Signature: protected function getFormConfig($form,$create_id)
- Parameters:
- Returns: I2CE_MagicDataNode
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)
- Parameters:
- string $form_name
- Returns: int.
0 on failure. An integer > 0 on success.
getRecords()
Return an array of all the record ids for a given form.
isWritable()
Checks to see if this is writalbe
- Signature: public function isWritable()
- Returns: boolean
listDisplayFields()
- Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
- Parameters:
- string $form
THe form name - array $fields
of string. The fields we want returned - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. If true, we return the parent as one of the fields.- Default Value: false
- array $where_data
contains the where clause information about this form or a nested- Default Value: array()
- array $ordering
An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.- Default Value: array()
- mixed $limit
Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.- Default Value: false
- integer $mod_time
Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.- Default Value: -1
- string $form
- Returns: mixed
an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.
listFields()
- Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
- Parameters:
- string $form
THe form name - array $fields
of string. The fields we want returned - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. If true, we return the parent as one of the fields.- Default Value: false
- array $where_data
contains the where clause information about this form or a nested- Default Value: array()
- array $ordering
An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.- Default Value: array()
- mixed $limit
Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.- Default Value: false
- integer $mod_time
Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.- Default Value: -1
- string $form
- Returns: mixed
an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.
lookupDisplayField()
Looks up the 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 cache and returns it.
- Signature: public function lookupDisplayField($form,$id,$fields,$delim)
- Parameters:
- Returns: string
false on failure
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 cache and returns it.
- Signature: public function lookupField($form,$id,$fields,$delim)
- Parameters:
- Returns: string
false on failure
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()
- Signature: protected function quickSearch($form,$parent,$where_data,$limit)
- Parameters:
- string $form
The form name. - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.- Default Value: false
- mixed $where_data
array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.- Default Value: array()
- mixed $limit
Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.- Default Value: false
- string $form
- Returns: mixed
an array of matching form ids. However, ff $limit_one is true or 1 or array ($offset,1) then then we return either the id or false, if none found or there was an error.
save()
Save a form object into magicdata
- Signature: public function save($form,$user,$transact)
- Parameters:
search()
- Signature: public function search($form,$parent,$where_data,$ordering,$limit)
- Parameters:
- string $form
The form name. - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.- Default Value: false
- mixed $where_data
array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.- Default Value: array()
- array $ordering
An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.- Default Value: array()
- mixed $limit
Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.- Default Value: false
- string $form
- Returns: mixed
an array of matching form ids. However, ff $limit_one is true or 1 or array ($offset,1) then then we return either the id or false, if none found or there was an error.
Inherited 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.
- Location: Part of the module forms-storage-magicdata in the package I2CE
- Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: 3.2
I2CE_Module_FormStorageEntry
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)
- Parameters:
- I2CE_FormField $form_field
- Returns: boolean
FF_save()
Save the FormField to the database.
- Signature: public function FF_save($form_field,$do_check,$user)
- 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.
- Returns: boolean
__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)
- Parameters:
- $no_history
- Returns: boolean
getFormConfig()
Return the magic data node for the given form.
- Signature: protected function getFormConfig($form,$create_id)
- Parameters:
- Returns: I2CE_MagicDataNode
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)
- Parameters:
- string $form_name
- Returns: int.
0 on failure. An integer > 0 on success.
getRecords()
Return an array of all the record ids for a given form.
isWritable()
Checks to see if this is writalbe
- Signature: public function isWritable()
- Returns: boolean
listDisplayFields()
- Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
- Parameters:
- string $form
THe form name - array $fields
of string. The fields we want returned - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. If true, we return the parent as one of the fields.- Default Value: false
- array $where_data
contains the where clause information about this form or a nested- Default Value: array()
- array $ordering
An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.- Default Value: array()
- mixed $limit
Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.- Default Value: false
- integer $mod_time
Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.- Default Value: -1
- string $form
- Returns: mixed
an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.
listFields()
- Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
- Parameters:
- string $form
THe form name - array $fields
of string. The fields we want returned - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. If true, we return the parent as one of the fields.- Default Value: false
- array $where_data
contains the where clause information about this form or a nested- Default Value: array()
- array $ordering
An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.- Default Value: array()
- mixed $limit
Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.- Default Value: false
- integer $mod_time
Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.- Default Value: -1
- string $form
- Returns: mixed
an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.
lookupDisplayField()
Looks up the 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 cache and returns it.
- Signature: public function lookupDisplayField($form,$id,$fields,$delim)
- Parameters:
- Returns: string
false on failure
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 cache and returns it.
- Signature: public function lookupField($form,$id,$fields,$delim)
- Parameters:
- Returns: string
false on failure
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()
- Signature: protected function quickSearch($form,$parent,$where_data,$limit)
- Parameters:
- string $form
The form name. - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.- Default Value: false
- mixed $where_data
array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.- Default Value: array()
- mixed $limit
Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.- Default Value: false
- string $form
- Returns: mixed
an array of matching form ids. However, ff $limit_one is true or 1 or array ($offset,1) then then we return either the id or false, if none found or there was an error.
save()
Save a form object into magicdata
- Signature: public function save($form,$user,$transact)
- Parameters:
search()
- Signature: public function search($form,$parent,$where_data,$ordering,$limit)
- Parameters:
- string $form
The form name. - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.- Default Value: false
- mixed $where_data
array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.- Default Value: array()
- array $ordering
An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.- Default Value: array()
- mixed $limit
Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.- Default Value: false
- string $form
- Returns: mixed
an array of matching form ids. However, ff $limit_one is true or 1 or array ($offset,1) then then we return either the id or false, if none found or there was an error.
Inherited 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()
