Class: I2CE FormStorage magicdata: Difference between revisions
No edit summary |
No edit summary |
||
| Line 194: | Line 194: | ||
===$name=== | ===$name=== | ||
Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$name | I2CE_FormStorage_Mechanism->$name]] | Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$name | I2CE_FormStorage_Mechanism->$name]] | ||
===$global_options=== | ===$global_options=== | ||
Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$global_options | I2CE_FormStorage_Mechanism->$global_options]] | Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$global_options | I2CE_FormStorage_Mechanism->$global_options]] | ||
===$ordering=== | ===$ordering=== | ||
Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$ordering | I2CE_FormStorage_Mechanism->$ordering]] | Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$ordering | I2CE_FormStorage_Mechanism->$ordering]] | ||
| Line 393: | Line 395: | ||
===$name=== | ===$name=== | ||
Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$name | I2CE_FormStorage_Mechanism->$name]] | Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$name | I2CE_FormStorage_Mechanism->$name]] | ||
===$global_options=== | ===$global_options=== | ||
Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$global_options | I2CE_FormStorage_Mechanism->$global_options]] | Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$global_options | I2CE_FormStorage_Mechanism->$global_options]] | ||
===$ordering=== | ===$ordering=== | ||
Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$ordering | I2CE_FormStorage_Mechanism->$ordering]] | Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism#$ordering | I2CE_FormStorage_Mechanism->$ordering]] | ||
Revision as of 20:42, 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_magicdatawhich 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 @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org>
@version 3.2 @since 3.2 @access public
Methods
FF_populateHistory()
Populate the history of entries for the form field if the storage module handles history.
- Signature: public function FF_populateHistory($form_field)
- Returns: 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_magicdatawhich 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 @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org>
@version 3.2 @since 3.2 @access public
Methods
FF_populateHistory()
Populate the history of entries for the form field if the storage module handles history.
- Signature: public function FF_populateHistory($form_field)
- Returns: 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()
