Class: I2CE FormStorage multi flat (Development)
This article describes the class I2CE_FormStorage_multi_flat .
- Extends the class: I2CE_FormStorage_DB.
- Location: Part of the module forms-storage-multiflat in the package I2CE 4.1-dev
- Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 33
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v4.0.1
@filesource Class I2CE_FormStorage_multi_flat
Variables
$columnList
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 54
- Type: static protected $columnList
$databases
sting. Keys are componentities and values are the assoicated database
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 123
- Type: protected array $databases
$componentized_forms
componentized_forms. The array of componentized forms
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 128
- Type: protected array $componentized_forms
$formObjs
. Keys are form names, values are instanceof I2CE_Form
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 158
- Type: protected array $formObjs
Methods
__construct()
The constructor for the storage mechanism
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 138
- Signature: public function __construct($name,$global_options)
- Parameters:
fieldIsColumn()
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 46
- Signature: protected function fieldIsColumn($data)
- Parameters:
- $data
getFieldData()
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 82
- Signature: protected function getFieldData($data,$database,$table)
- Parameters:
- $data
- $database
- Default Value: null
- $table
- Default Value: null
getFormObj()
Get a (cached) form object for the given form
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 165
- Signature: protected function getFormObj($form)
- Parameters:
- string $form
- Returns: I2CE_Form
or false on failure.
getRequiredFieldsQuery()
Construct a query (to be used as a sub-select) to view the fields of the given form. It always will return the id of the form as well @param callback $field_refernece_callback. A callback function whose first arguement is the form, the second arguements is the field and which returns the way the field value should be references as a field. If the callback is null (the default) then the reference used is "$form+$field"
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 192
- Signature: public function getRequiredFieldsQuery($form,$fields,$id,$parent,$field_reference_callback,$mod_time,$user)
- Parameters:
- string $form
- mixed $fields
Either a string, the field, or an array of string, the fields. - mixed $id
Defaults to null. If non-null it is the id that we wish to limit to.- Default Value: null
- boolean $parent
Defaults to false. If true, we include the parent id as a referenced field 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
- $field_reference_callback
- Default Value: null
- 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
- mixed $user
The user id of the user to limit the results to so it only returns results limited to that user. This can be a single value or an array- Default Value: false
- Returns: string
the query or false on failed.
hasColumn()
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 56
- Signature: protected function hasColumn($col,$database,$table)
- Parameters:
- $col
- $database
- $table
isWritable()
Checks to see if this storage mechansim is writable
- Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMultiFlat/lib/I2CE_FormStorage_multi_flat.php on line 39
- Signature: public function isWritable()
- Returns: boolean.
false
Inherited Methods
FF_populateHistory()
This public method is inherited from I2CE_FormStorage_DB->FF_populateHistory()
getFields()
This public method is inherited from I2CE_FormStorage_DB->getFields()
getIdsAsChild()
This public method is inherited from I2CE_FormStorage_DB->getIdsAsChild()
getRecords()
This public method is inherited from I2CE_FormStorage_DB->getRecords()
globalFieldUpdateBySQL()
This public method is inherited from I2CE_FormStorage_DB->globalFieldUpdateBySQL()
hasGlobalFieldUpdateBySql()
This public method is inherited from I2CE_FormStorage_DB->hasGlobalFieldUpdateBySql()
listDisplayFields()
This public method is inherited from I2CE_FormStorage_DB->listDisplayFields()
listFields()
This public method is inherited from I2CE_FormStorage_DB->listFields()
lookupDisplayField()
This public method is inherited from I2CE_FormStorage_DB->lookupDisplayField()
lookupField()
This public method is inherited from I2CE_FormStorage_DB->lookupField()
populate()
This public method is inherited from I2CE_FormStorage_DB->populate()
search()
This public method is inherited from I2CE_FormStorage_DB->search()
queryLastListCount()
This protected method is inherited from I2CE_FormStorage_DB->queryLastListCount()
FF_IG_setSequence()
This public method is inherited from I2CE_FormStorage_Mechanism->FF_IG_setSequence()
FF_save()
This public method is inherited from I2CE_FormStorage_Mechanism->FF_save()
changeID()
This public method is inherited from I2CE_FormStorage_Mechanism->changeID()
delete()
This public method is inherited from I2CE_FormStorage_Mechanism->delete()
getFormsById()
This public method is inherited from I2CE_FormStorage_Mechanism->getFormsById()
globalFieldUpdateByFunction()
This public method is inherited from I2CE_FormStorage_Mechanism->globalFieldUpdateByFunction()
hasRecord()
This public method is inherited from I2CE_FormStorage_Mechanism->hasRecord()
populateHistory()
This public method is inherited from I2CE_FormStorage_Mechanism->populateHistory()
release()
This public method is inherited from I2CE_FormStorage_Mechanism->release()
save()
This public method is inherited from I2CE_FormStorage_Mechanism->save()
setStorageOptions()
This public method is inherited from I2CE_FormStorage_Mechanism->setStorageOptions()
compareFormsByFields()
This protected method is inherited from I2CE_FormStorage_Mechanism->compareFormsByFields()
getLimitedFields()
This protected method is inherited from I2CE_FormStorage_Mechanism->getLimitedFields()
getStorageOptions()
This protected method is inherited from I2CE_FormStorage_Mechanism->getStorageOptions()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Variables
$db
Theis protected variable is inherited from I2CE_FormStorage_DB->$db
$name
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$name
$global_options
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$global_options
$storage_options_cache
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$storage_options_cache
$ordering
Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$ordering
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()