Class: I2CE FormStorage Mechanism (4.1.4)

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

This article describes the abstract class I2CE_FormStorage_Mechanism .

• Extends the class: I2CE_Fuzzy.
• Child Classes:
  • I2CE_FormStorage_userform
  • I2CE_FormStorage_DB
    • I2CE_FormStorage_entry
    • I2CE_FormStorage_Flat
    • I2CE_FormStorage_magicdata
    • I2CE_FormStorage_multi_flat
  • I2CE_FormStorage_LDAP
  • I2CE_FormStorage_eval
  • I2CE_FormStorage_File_Base
    • I2CE_FormStorage_CSV
    • I2CE_FormStorage_XML_BASE
      • I2CE_FormStorage_SDMXHD
      • I2CE_FormStorage_SDMX_CrossSectional
      • I2CE_FormStorage_XML
  • I2CE_FormStorage_magicdata
• Location: Part of the module forms-storage in the package I2CE 4.1.4-release
• Source: Defined in the file modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v3.2.0

@filesource Class I2CE_Module_FormStorage_Mechanism

Constants

I2CE_FormStorage_Mechanism::CHANGE_INITIAL

Constant signifying an initial entry. Defined as: 1

I2CE_FormStorage_Mechanism::CHANGE_VERIFY

Constant signifying a verified entry. Defined as: 2

I2CE_FormStorage_Mechanism::CHANGE_CORRECTION

Constant signifying a corrected entry. Defined as: 3

I2CE_FormStorage_Mechanism::CHANGE_UPDATE

Constant signifying an updated entry. Defined as: 4

Variables

$name

The short name for this storage mechanism

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 58
• Type: protected string $name

$global_options

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 64
• Type: protected $global_options

$storage_options_cache

of I2CE_MagicDataNodes. The keys are the names of forms which have flat storage.

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 149
• Type: protected array $storage_options_cache

$ordering

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 396
• Type: protected $ordering

Methods

FF_IG_setSequence()

Set FormField_INT_GENERATE sequence

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 745
• Signature: public function FF_IG_setSequence($form_field)
• Parameters:
  • I2CE_FormField_INT_GENERATE $form_field
• 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_Mechanism.php on line 757
• 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_Mechanism.php on line 735
• 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.
  • I2CE_User $user
    The user saving this data.
• Returns: boolean

__construct()

The constructor for the storage mechanism

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 71
• 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()

changeID()

Change the id of the given form

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 673
• Signature: public function changeID($form,$oldid,$newid)
• Parameters:
  • string $form
  • mixed $oldid
  • mixed $newid
• Returns: boolean.
  true on success

compareFormsByFields()

Compares two forms to see which is greater based on the field ordering set in $this->ordering @param $form1 @param $form2

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 403
• Signature: protected function compareFormsByFields($form1,$form2)
• Parameters:
  • $form1
  • $form2
• Returns: int

delete()

Deletes a form from the entry tables.

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 782
• Signature: public function delete($form,$transact)
• Parameters:
  • I2CE_Form $form
  • boolean $transact
    a flag to use transactions or not. default: true
• Returns: boolean

getFormsById()

Gets the required fields. @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/lib/I2CE_FormStorage_Mechanism.php on line 335
• Signature: public function getFormsById($form,$parent,$where_data,$ordering,$limit)
• Parameters:
  • string $form
    The form we are select from
  • 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.
  • 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. 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
  with keys id's and values the I2CE_Form instance.

getIdsAsChild()

Gets the id's for the given child for this form.

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 460
• Signature: public function getIdsAsChild($form_name,$parent_form_id,$order_by,$where,$limit)
• Parameters:
  • string $form_name
  • mixed $parent_form_id
    the prent form id @param array/string: an optional orderBy array of fields @param array where @param integer: A limit of the number of children ids to return
  • $order_by
  • $where
  • $limit
• Returns: array

getLimitedFields()

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 578
• Signature: protected function getLimitedFields($expr)
• Parameters:
  • $expr

getRecords()

Return an array of all the record ids for a given form.

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 200
• Signature: abstract public function getRecords($form)
• Parameters:
  • string $form
• Returns: array

getStorageOptions()

Gets the storage options for the given form.

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 118
• Signature: protected function getStorageOptions($form)
• Parameters:
  • string $form
• Returns: mixed
  I2CE_MagicDataNode of flat storage options on success, false on failure.

globalFieldUpdateByFunction()

update value of each instanceo of a given form field by a pho function call

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 83
• Signature: public function globalFieldUpdateByFunction($form_field,$where,$set_func)
• Parameters:
  • I2CE_FormField $form_field
  • array $where
    Array of where data
  • callable $set_func

hasRecord()

Checks if the given record exists.

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 224
• Signature: public function hasRecord($form_name,$form_id)
• Parameters:
  • string $form_name
  • string $form_id
• Returns: array

isWritable()

Checks to see if this storage mechansim implements the writing methods. You need to override this in a subclass that implements writable

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 207
• Signature: abstract public function isWritable()
• Returns: boolean

listDisplayFields()

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 538
• Signature: public function listDisplayFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time,$user)
• 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. If true, we return the parent as one of the fields.
    • 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. 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
  • 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: 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_Mechanism.php on line 488
• Signature: 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. If true, we return the parent as one of the fields.
    • 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. 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
• 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 description 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_Mechanism.php on line 279
• Signature: 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.
  • array $fields
    A list of fields to look up and return.
  • string $delim
    The delimiter to put between returned fields if there are more than one. If false, returns the values as an array.
• Returns: string
  false on failure

lookupField()

Looks up the description 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_Mechanism.php on line 240
• Signature: 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.
  • array $fields
    A list of fields to look up and return.
  • string $delim
    The delimiter to put between returned fields if there are more than one. If false, returns the values as an array.
• Returns: string
  false on failure

populate()

Populate the member variables of the object from the database.

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 191
• Signature: abstract public function populate($form)
• Parameters:
  • I2CE_Form $form

populateHistory()

Populate the member variables of the object from the database.

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 309
• Signature: public function populateHistory($form)
• Parameters:
  • I2CE_Form $form

save()

Save a form object into entry tables. If this functio is over-written, it should include the fuzzy method call foreach ($form as $field) { $field->save(true/false, $user) }

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

search()

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 617
• Signature: 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()
  • 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
• 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.

setStorageOptions()

Public set the more storage options for a given form

• Defined in i2ce/modules/Forms/modules/FormStorage/lib/I2CE_FormStorage_Mechanism.php on line 157
• Signature: public function setStorageOptions($form,$storageOptions)
• Parameters:
  • string $form
  • mixed $storageOptions
    Either a I2CE_MagicDataNode or an array.

Inherited Methods

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()