Class: I2CE FormStorage Flat (4.1.7)

From IHRIS Wiki
Revision as of 08:39, 23 August 2013 by Litlfred (talk | contribs) (Created page with "{{otherversions|Class: I2CE_FormStorage_Flat}} This article describes the class ''I2CE_FormStorage_Flat'' . *Extends the class: [[Class: I2CE_FormStorage_DB (4.1.7) | I2CE_FormSt...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE_FormStorage_Flat (versions) .


This article describes the class I2CE_FormStorage_Flat .

@filesource Class I2CE_FormStorage_Flat

Variables

$saveStmts

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

$saveCols

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

$fieldSaves

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

$formObjs

. Keys are form names, values are instanceof I2CE_Form

Methods

FF_save()

Save the FormField to the database.

__construct()

The constructor for the storage mechanism

ensureFormId()

Ensures that a row exists in the given tablet

fieldIsColumn()

Check if the given data is the data for a column

getFieldData()

Get how the given data should be queried from the db

getFieldSave()

Get/prepare the prepared statement for the given field obj

getFormObj()

Get a (cached) form object for the given form

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

getTable()

Gets the table for the specified form

isWritable()

Checks to see if this storage mechansim is writable

save()

Save a form object into entry tables.

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

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_FormStorage_Flat_(4.1.7)&oldid=50003"