Class: I2CE FormStorage (4.0.6)
This article describes the class I2CE_FormStorage .
- Extends the class: I2CE_Module.
- Location: Part of the module forms-storage in the package I2CE 4.0.6-release
- Source: Defined in the file modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 38
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: 3.2
I2CE_Module_FormStorage
Variables
$lastListCount
A list of forms with the last count returned for listDisplayFields
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 43
- Type: static protected array $lastListCount
$componentized_forms
A cached list of componentized forms. array of string, the form names
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 290
- Type: static protected static $componentized_forms
$storage
An array with a cache of the storage type for a form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 316
- Type: static protected array $storage
$storageMechs
An array with a cache of the storage mechanisms
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 348
- Type: static protected array $storageMechs
Methods
FF_IG_save()
Save the FormField to the database.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1309
- Signature: public function FF_IG_save($form_field,$do_check,$user)
- Parameters:
- $form_field
- boolean $do_check
A flag to determine if a check should be made for the same value being saved. @param I2CE_User I2CE_User The user saving this data. - $user
- Returns: boolean
FF_IG_setSequence()
Set the value of this field to the next sequence for the form field.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1367
- Signature: public function FF_IG_setSequence($form_field)
- Parameters:
- I2CE_FormField_INT_GENERATE $form_field
FF_SP_save()
Save the FormField_STRING_PASS to the database.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1338
- Signature: public function FF_SP_save($form_field,$do_check,$user)
- Parameters:
- I2CE_FormField_STRING_PASS $form_field
- boolean $do_check
A flag to determine if a check should be made for the same value being saved. @param I2CE_User I2CE_User The user saving this data. - $user
- Returns: boolean
FF_populateHistory()
Populate the history of entries for the form field if the storage module handles history.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1387
- Signature: public function FF_populateHistory($form_field)
- Parameters:
- I2CE_FormField $form_field
- Returns: boolean
FF_save()
Save the FormField to the database.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1285
- 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. @param I2CE_User I2CE_User The user saving this data. - $user
- Returns: boolean
_populate()
Internal worker method to populate a form object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 941
- Signature: public function _populate($form,$storageMechanism)
- Parameters:
- I2CE_Form $form
- I2CE_FormStorage_Mechanism $storageMechanism
Default to null which indicates we should use the registered form storage mecahnsim.- Default Value: null
- Returns: boolean
_save()
Internal worker method to save a form object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1220
- Signature: protected function _save($form,$user,$transact,$storageMechanism)
- Parameters:
- I2CE_Form $form
- I2CE_User $user
- boolean $transact
Defaults to true.- Default Value: true
- I2CE_FormStorage_Mechanism $storageMechanism
Default to null which indicates we should use the registered form storage mecahnsim.- Default Value: null
- Returns: boolean.
true on success
addChild()
add the given child to the form for this object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1086
- Signature: public function addChild($form,$form_name,$id)
- Parameters:
delete()
Delete a form object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1250
- Signature: public function delete($form,$transact,$complete,$no_history)
- Parameters:
- I2CE_Form $form
- boolean $transact
a flag to use transactions or not. default: true- Default Value: true
- boolean $complete
a flag to determine if a complete delete should happen. default: false- Default Value: false
- boolean $no_history
a flag to determine if the record should not go to the deleted_records table. default: false- Default Value: false
- Returns: boolean
exportData()
Move data for a form from one storage mechansim to another
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 243
- Signature: static public function exportData($form,$target,$user,$ids)
- Parameters:
- Returns: boolean.
true on success
getChildIds()
Gets the id's for the given child for this form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1067
- Signature: public function getChildIds($form,$child_form_name,$order_by,$where,$limit)
- Parameters:
- I2CE_Form $form
- string $child_form_name
the child form name - mixed $order_by
A string or array of strings. The fields to oreder by . defaults to empty array.- Default Value: array()
- $where
- 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
- Returns: array
getComponentizedForms()
static function which gets a list of all componentized forms
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 296
- Signature: static public function getComponentizedForms($use_cache)
- Parameters:
- boolean $use_cache
Use the cached value of the list for componentized forms if possible. Defualts to true- Default Value: true
- boolean $use_cache
- Returns: array
of string, the componentized forms
getHooks()
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 81
- Signature: static public function getHooks()
getLastListCount()
Return the last results from a search query for a form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1478
- Signature: static public function getLastListCount($form)
- Parameters:
- string $form
The form name
- string $form
- Returns: integer
getMechanismByStorage()
Returns the storage mechanism for the given storage type.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 369
- Signature: static public function getMechanismByStorage($storage)
- Parameters:
- string $storage
- Returns: I2CE_FormStorage_Mechanism
or false on failure
getMethods()
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 47
- Signature: static public function getMethods()
getMigratedValue()
Get the new value for a field that has been migrated.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 487
- Signature: static public function getMigratedValue($migrate_node,$form,$old_id,$field,$map_form)
- Parameters:
- I2CE_MagicDataNode $migrate_node
- string $form
- mixed $old_id
- string $field
- mixed $map_form
- Returns: string
getNewMigratedValue()
Get the new migrated value for from the old value. @param mixed $old_id
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 464
- Signature: static public function getNewMigratedValue($migrate_node,$map_form,$old_value,$old_amt)
- Parameters:
- I2CE_MagicDataNode $migrate_node
- string $map_form
- $old_value
- integer $old_amt
For currency data this is the amount- Default Value: 0
- Returns: mixed
getOldMigratedValue()
Get the old value for a field that has been migrated.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 413
- Signature: static public function getOldMigratedValue($migrate_node,$form,$old_id,$field,$map_form)
- Parameters:
- I2CE_MagicDataNode $migrate_node
- string $form
- mixed $old_id
- string $field
- mixed $map_form
- Returns: array
array( 'map_form', 'old_value' );
getRecords()
Return an array of all the record ids for a given form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1412
- Signature: public function getRecords($factory,$form_name)
- Parameters:
- I2CE_FormFactory $factory
- $form_name
- Returns: array
getStorage()
Return the storage class for the given form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 326
- Signature: static public function getStorage($form_name,$no_cache)
- Parameters:
- Returns: string
getStorageMechanism()
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 356
- Signature: static public function getStorageMechanism($form_name,$no_cache)
- Parameters:
- Returns: I2CE_FormStorage_Mechanism
or false on failure
importData()
Move data for a form from one storage mechansim to another @param I2CE_FormStorage_Mechansim $target
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 258
- Signature: static public function importData($form,$source,$user,$ids)
- Parameters:
- Returns: boolean.
true on success
isComponentized()
static function to determine if a form is componentized
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 273
- Signature: static public function isComponentized($form)
- Parameters:
- string $form
- Returns: boolean
isComponentizedForm()
Fuzzy method to check if a form instance is componentized
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 909
- Signature: public function isComponentizedForm($formClass)
- Parameters:
- I2CE_Form $formClass
- Returns: boolean
isWritable()
Check to see if this form is considered to be writable.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1435
- Signature: static public function isWritable($form)
- Parameters:
- mixed $form
string, I2CE_Form or I2CE_FormField
- mixed $form
listDisplayFields()
Lists the display values for a field
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 881
- Signature: static 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 Can include the special field 'last_modified' to get the last modification time for any of the fields of that form which is returned in the format "Y-m-d H:i:s" - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.- Default Value: false
- mixed $where_data
Either I2CE_MagicDataNode or array. 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()
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 854
- Signature: static 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. Can include the special field 'last_modified' to get the last modification time for any of the fields of that form which is returned in the format "Y-m-d H:i:s" - boolean $parent
Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.- Default Value: false
- mixed $where_data
Either I2CE_MagicDataNode or array. 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 value of the item based on the code. This is the default method that most implementations of lookup () use. It finds the description of the object based on the code and saves it in the cache and returns it.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 825
- Signature: static public function lookupDisplayField($form,$id,$fields,$delim)
- Parameters:
- string $form
The name of the form in the database. - integer $id
The code of the entry to lookup. - mixed $fields
A field or an array of fields to look up and return. Defaults to 'name'- Default Value: array('name')
- string $delim
The delimiter to put between returned fields if there are more than one. If false , then we return as an array. Defaults to '-'- Default Value: '-'
- string $form
- Returns: string
or false on failure
lookupField()
Looks up the dbvalue of the item based on the code. This is the default method that most implementations of lookup () use. It finds the description of the object based on the code and saves it in the cache and returns it.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 798
- Signature: static public function lookupField($form,$id,$fields,$delim)
- Parameters:
- string $form
The name of the form in the database. - integer $id
The code of the entry to lookup. - mixed $fields
A field or an array of fields to look up and return. Defaults to 'name'- Default Value: array('name')
- string $delim
The delimiter to put between returned fields if there are more than one. If false , then we return as an array. Defaults to '-'- Default Value: '-'
- string $form
- Returns: string
or false on failure
migrateField()
Migrate field data from an old setMap reference to a new MAP form field type. The old data should have been saved in a migrate_data magic data (see storeMigrateData ).
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 688
- Signature: static public function migrateField($form_name,$field_list,$migrate_path,$user)
- Parameters:
- string $form_name
- array $field_list
The list of fields that need to be changed as an array of field => map_form. Optionally the field list can be: array( "field" => array( "prev_field" => "prev_map_form" ) ) The field will get the old value from the list of fields (with mapped forms) for when the field name was changed. - string $migrate_path
Where the migrate data has been saved. - I2CE_User $user
The user to save the new form field.
- Returns: boolean
migrateForm()
Migrate a given form from one storage method to the current storage method. This should only be used when upgrading a module that moved a form storage from one type to another.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 525
- Signature: static public function migrateForm($form_name,$storage,$user,$migrate_path,$id_field,$skip_fields,$migrate_fields,$callback)
- Parameters:
- string $form_name
- string $storage
The old storage mechanism - I2CE_User $user
The user object to use to save the new forms. - string $migrate_path
The full path in MagicData to save the old to new mappings.- Default Value: false
- string $id_field
The old field name to use the value of for the new form id.- Default Value: false
- array $skip_fields
A list of fields to not migrate to the new form.- Default Value: array()
- array $migrate_fields
A list of fields that have already been migrated and need to use the migrate path to convert the data. Format is array( "field" => "map_form" ) These forms and fields should have already been passed to storeMigrateData so the data can be retrieved from there.- Default Value: array()
- $callback
- Default Value: null
- Returns: boolean
moveData()
Move data for a form from one storage mechansim to another
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 194
- Signature: static public function moveData($form,$source,$target,$user,$ids)
- Parameters:
- string $form
The form - I2CE_FormStorage_Mechansim $source
- I2CE_FormStorage_Mechansim $target
- I2CE_User $user
The user object used to save the data to the target storage mechanism - mixed $ids
An id or an array of the ids we wish to move. Defaults to null, in which case all id's are moved- Default Value: null
- string $form
- Returns: boolean.
true on success
populate()
Use method to populate a form object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 930
- Signature: public function populate($form)
- Parameters:
- I2CE_Form $form
- Returns: boolean
populateChild()
Populate all instances of the given child form for this object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1109
- Signature: public function populateChild($form,$form_name,$order_by,$where,$type)
- Parameters:
- I2CE_Form $form
- string $form_name
The form name to populate - mixed $order_by
A field or array of fields to sort by. Preceded by "-" to sort in reverse order. - array( "-start_date", "name" ). Defaults to null in which case if get the default sort order that is registered for the type (which defaults to none) @param mixed @where an aarray of where information to limit getting the child id's by. If null, we get the default limits for the type (which defaults to none)- Default Value: null
- $where
- Default Value: null
- string $type
Defaults to 'default'- Default Value: 'default'
populateChildren()
Populate the given child form for this object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1152
- Signature: public function populateChildren($form,$forms,$orderBy)
- Parameters:
- I2CE_Form $form
- mixed $forms
A string or an array such, the form names (the child forms to populate) - array( "demographic", "contact" ) - array $orderBy
An associative array of form names with an array of either string, field to sort by or an array of the fields Defaults to empty array - array( "contact" => "contact_type" )- Default Value: array()
populateFirst()
Populate the first child of a form object based on the given field
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1026
- Signature: public function populateFirst($form,$forms)
- Parameters:
populateHistory()
Populate Last of a form object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 965
- Signature: public function populateHistory($form)
- Parameters:
- I2CE_Form $form
populateLast()
Populate the last child of a form object based on the given field
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 979
- Signature: public function populateLast($form,$forms)
- Parameters:
save()
User method to save a form object.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1207
- Signature: public function save($form,$user,$transact)
- Parameters:
- Returns: boolean.
true on success
search()
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 757
- Signature: static 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()
- mixed $ordering
An field or 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.
setChangeType()
Set the change type for the given form. If this method isn't called then the change type will be I2CE_FormStorage::CHANGE_UPDATE
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1185
- Signature: public function setChangeType($form,$change_type,$field)
- Parameters:
setLastListCount()
Add the last results from a search query for a form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 1466
- Signature: static public function setLastListCount($form,$count)
- Parameters:
- string $form
The form name - integer $count
The number of results.
- string $form
storeMigrateData()
Save the given fields to the given magic data node so it can later be referenced when migrating the form.
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 392
- Signature: static public function storeMigrateData($forms,$migrate_path)
- Parameters:
validate_formfield()
Hooked Function to check if a field is unique or unique restricted to a certain field
- Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage.php on line 94
- Signature: public function validate_formfield($field_obj)
- Parameters:
- I2CE_FormField $field_obj
- Returns: boolean
Inherited Methods
__construct()
This public method is inherited from I2CE_Module->__construct()
action_configure()
This public method is inherited from I2CE_Module->action_configure()
action_disable()
This public method is inherited from I2CE_Module->action_disable()
action_enable()
This public method is inherited from I2CE_Module->action_enable()
action_initialize()
This public method is inherited from I2CE_Module->action_initialize()
getCLIHooks()
This public method is inherited from I2CE_Module->getCLIHooks()
getCLIMethods()
This public method is inherited from I2CE_Module->getCLIMethods()
getConfig()
This public method is inherited from I2CE_Module->getConfig()
post_update()
This public method is inherited from I2CE_Module->post_update()
pre_upgrade()
This public method is inherited from I2CE_Module->pre_upgrade()
upgrade()
This public method is inherited from I2CE_Module->upgrade()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Fuzzy Methods
launchBackgroundProcess()
This method is inherited from I2CE_Module->launchBackgroundProcess()
launchBackgroundPHPScript()
This method is inherited from I2CE_Module->launchBackgroundPHPScript()
launchBackgroundPage()
This method is inherited from I2CE_Module->launchBackgroundPage()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()