Class: I2CE FormStorage Flat (Development)

For other versions, see Class: I2CE_FormStorage_Flat (versions) .

This article describes the class I2CE_FormStorage_Flat .

• Extends the class: I2CE_FormStorage_DB.
• Location: Part of the module forms-storage-flat in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v3.2.0

@filesource Class I2CE_FormStorage_Flat

Variables

$saveStmts

@protected array $saveStmts An array of prepared statements for saving indexed by the form name

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 50
• Type: protected $saveStmts

$saveCols

. An array, indexed by form name, of arrays of pairs fieldnames=>column names

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 55
• Type: protected $saveCols

$fieldSaves

. Array indexed by form name of array, indexed by field name, of prepared save statements for a field

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 320
• Type: protected $fieldSaves

$formObjs

. Keys are form names, values are instanceof I2CE_Form

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 387
• Type: protected array $formObjs

Methods

FF_save()

Save the FormField to the database.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 302
• Signature: public function FF_save($fieldObj,$do_check,$user)
• Parameters:
  • I2CE_FormField $fieldObj
  • 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()

The constructor for the storage mechanism

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 412
• Signature: public function __construct($name,$global_options)
• Parameters:
  • string $name
  • array $global_options
    Default to empty array. The array of options that are the same across all all forms which share a commone storage mechanisms
    • Default Value: array()

ensureFormId()

Ensures that a row exists in the given tablet

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 193
• Signature: protected function ensureFormId($form,$col,$parent_col)
• Parameters:
  • I2CE_Form $form
  • string $col
  • mixed $parent_col
    If a string it is the parent col to save the parent id in

fieldIsColumn()

Check if the given data is the data for a column

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 355
• Signature: protected function fieldIsColumn($data)
• Parameters:
  • I2CE_MagicDataNode $data
• Returns: boolean

getFieldData()

Get how the given data should be queried from the db

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 368
• Signature: protected function getFieldData($data)
• Parameters:
  • I2CE_MagicDataNode $data
• Returns: mixed.
  fasle on failture. string on success

getFieldSave()

Get/prepare the prepared statement for the given field obj

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 327
• Signature: protected function getFieldSave($fieldObj)
• Parameters:
  • I2CE_FormField $fieldObj
• Returns: mixed.
  false om failure. a mdb2 preapred statement object on success

getFormObj()

Get a (cached) form object for the given form

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 394
• 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/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 432
• 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.

getSaveColumns()

Get the columsn which can save for the specidied form

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 62
• Signature: protected function getSaveColumns($form)
• Parameters:
  • I2CE_Form $form
• Returns: array
  keys are the field names and values are the column names

getTable()

Gets the table for the specified form

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 160
• Signature: protected function getTable($form)
• Parameters:
  • string $form
• Returns: string

isWritable()

Checks to see if this storage mechansim is writable

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 43
• Signature: public function isWritable()
• Returns: boolean.
  false

save()

Save a form object into entry tables.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageFlat/lib/I2CE_FormStorage_flat.php on line 234
• Signature: public function save($form,$user,$transact)
• Parameters:
  • I2CE_Form $form
  • I2CE_User $user
  • boolean $transact

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()

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()

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()