Class: I2CE FormStorage magicdata (Development)

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

The class I2CE_FormStorage_magicdata contains 3 definitions:

• Definition in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php of the package I2CE
• Definition in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php of the package I2CE
• Definition in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php of the package I2CE

i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php

This article describes the class I2CE_FormStorage_magicdata .

• Extends the class: I2CE_FormStorage_DB.
• Location: Part of the module forms-storage-magicdata in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.0

@filesource Class I2CE_FormStorage_magicdata

Methods

FF_save()

Save the FormField to the database.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php on line 365
• 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()

Construct this module class

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php on line 42
• Signature: public function __construct($name,$options)
• Parameters:
  • string $name
    The name of this storage mechanism
  • array $options
    • Default Value: array()

changeID()

Change the id of the given form

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

delete()

Deletes a form from the entry tables.

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

getFormConfig()

Return the magic data node for the given form.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php on line 229
• Signature: protected function getFormConfig($form,$create_id)
• Parameters:
  • mixed $form
    I2CE_Form or I2CE_FormField
  • boolean $create_id
    Defaults to false
    • Default Value: false
• Returns: I2CE_MagicDataNode

getFormConfigById()

Return the magic data node for the given form name and id

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php on line 246
• Signature: protected function getFormConfigById($form_name,$id,$create_id)
• Parameters:
  • string $form_name
  • string $id
  • boolean $create_id
    Defaults to false.
    • Default Value: false

getNextAvailableId()

Gets the next unused integer id for the form. At least 1

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php on line 333
• Signature: protected function getNextAvailableId($form_name)
• Parameters:
  • string $form_name
• Returns: int.
  0 on failure. An integer > 0 on success.

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/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php on line 66
• 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.

hasRecord()

Checks if the given record exists.

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

isWritable()

Checks to see if this is writalbe

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php on line 287
• Signature: public function isWritable()
• Returns: boolean

save()

Save a form object into magicdata

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

Inherited Methods

getFields()

This public method is inherited from I2CE_FormStorage_DB->getFields()

getIdsAsChild()

This public method is inherited from I2CE_FormStorage_DB->getIdsAsChild()

hasGlobalFieldUpdateBySql()

This public method is inherited from I2CE_FormStorage_DB->hasGlobalFieldUpdateBySql()

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

getFormsById()

This public method is inherited from I2CE_FormStorage_Mechanism->getFormsById()

globalFieldUpdateByFunction()

This public method is inherited from I2CE_FormStorage_Mechanism->globalFieldUpdateByFunction()

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

i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php

This article describes the class I2CE_FormStorage_magicdata .

• Extends the class: I2CE_FormStorage_DB.
• Location: Part of the module forms-storage-magicdata in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.0

@filesource Class I2CE_FormStorage_magicdata

Methods

FF_populateHistory()

Populate the history of entries for the form field if the storage module handles history.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 251
• 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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 466
• 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()

Construct this module class

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 42
• Signature: public function __construct($name,$options)
• Parameters:
  • string $name
    The name of this storage mechanism
  • array $options
    • Default Value: array()

changeID()

Change the id of the given form

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

delete()

Deletes a form from the entry tables.

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

getFormConfig()

Return the magic data node for the given form.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 302
• Signature: protected function getFormConfig($form,$create_id)
• Parameters:
  • mixed $form
    I2CE_Form or I2CE_FormField
  • boolean $create_id
    Defaults to false
    • Default Value: false
• Returns: I2CE_MagicDataNode

getFormConfigById()

Return the magic data node for the given form name and id

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 319
• Signature: protected function getFormConfigById($form_name,$id,$create_id)
• Parameters:
  • string $form_name
  • string $id
  • boolean $create_id
    Defaults to false.
    • Default Value: false

getFormPath()

Get the form path.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 52
• Signature: protected function getFormPath($form,$id)
• Parameters:
  • string $form
    Defaults to null. The optional name of the form we want
    • Default Value: null
  • string $id
    Defaults to null. The oprional id of the form we want
    • Default Value: null

getNextAvailableId()

Gets the next unused integer id for the form. At least 1

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 435
• Signature: protected function getNextAvailableId($form_name)
• Parameters:
  • string $form_name
• Returns: int.
  0 on failure. An integer > 0 on success.

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/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 100
• 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.

globalFieldUpdateBySQL()

update value of each instance of a given form field by a sql function call

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 516
• Signature: public function globalFieldUpdateBySQL($form_field,$where,$set_sql)
• Parameters:
  • I2CE_FormField $form_field
  • array $where
    Array of where data
  • string $set_sql
    sql used to update the field

hasGlobalFieldUpdateBySQL()

Check to see if there is a quick field update implemented

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 505
• Signature: public function hasGlobalFieldUpdateBySQL()
• Returns: true
  if there is a method to quickly update all instances of a given field via SQL

hasRecord()

Checks if the given record exists.

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

isWritable()

Checks to see if this is writalbe

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 360
• Signature: public function isWritable()
• Returns: boolean

populate()

Populate the member variables of the object from the database.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 207
• Signature: public function populate($form)
• Parameters:
  • I2CE_Form $form

release()

Release any resourced held by this form storage mechanism for the indicated form

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db_alt.php on line 73
• Signature: public function release($form)
• Parameters:
  • string $form

save()

Save a form object into magicdata

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

Inherited Methods

getFields()

This public method is inherited from I2CE_FormStorage_DB->getFields()

getIdsAsChild()

This public method is inherited from I2CE_FormStorage_DB->getIdsAsChild()

hasGlobalFieldUpdateBySql()

This public method is inherited from I2CE_FormStorage_DB->hasGlobalFieldUpdateBySql()

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

getFormsById()

This public method is inherited from I2CE_FormStorage_Mechanism->getFormsById()

globalFieldUpdateByFunction()

This public method is inherited from I2CE_FormStorage_Mechanism->globalFieldUpdateByFunction()

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

i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php

This article describes the class I2CE_FormStorage_magicdata .

• Extends the class: I2CE_FormStorage_Mechanism.
• Location: Part of the module forms-storage-magicdata in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 38
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: 3.2

I2CE_Module_FormStorageEntry

Methods

FF_populateHistory()

Populate the history of entries for the form field if the storage module handles history.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 143
• 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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 852
• 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()

Construct this module class

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 53
• Signature: public function __construct($name,$options)
• Parameters:
  • string $name
    The name of this storage mechanism
  • array $options
    • Default Value: array()

changeID()

Change the id of the given form

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

delete()

Deletes a form from the entry tables.

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

getFormConfig()

Return the magic data node for the given form.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 64
• Signature: protected function getFormConfig($form,$create_id)
• Parameters:
  • mixed $form
    I2CE_Form or I2CE_FormField
  • boolean $create_id
    Defaults to false
    • Default Value: false
• Returns: I2CE_MagicDataNode

getFormConfigById()

Return the magic data node for the given form name and id

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 81
• Signature: protected function getFormConfigById($form_name,$id,$create_id)
• Parameters:
  • string $form_name
  • string $id
  • boolean $create_id
    Defaults to false.
    • Default Value: false

getNextAvailableId()

Gets the next unused integer id for the form. At least 1

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 820
• Signature: protected function getNextAvailableId($form_name)
• Parameters:
  • string $form_name
• Returns: int.
  0 on failure. An integer > 0 on success.

getRecords()

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

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 164
• Signature: public function getRecords($form_name)
• Parameters:
  • string $form_name
• Returns: array

hasRecord()

Checks if the given record exists.

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

isWritable()

Checks to see if this is writalbe

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 44
• Signature: public function isWritable()
• Returns: boolean

listDisplayFields()

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 592
• Signature: 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. 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.

listFields()

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 427
• 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 display vlaue 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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 263
• 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 db 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/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 219
• 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

orderByFields()

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 751
• Signature: static public function orderByFields($vals,$ordering)
• Parameters:
  • $vals
  • $ordering

populate()

Populate the member variables of the object from the database.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 104
• Signature: public function populate($form)
• Parameters:
  • I2CE_Form $form

quickSearch()

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 347
• Signature: protected function quickSearch($form,$parent,$where_data,$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 $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.

save()

Save a form object into magicdata

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

search()

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php on line 318
• 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.

Inherited Methods

FF_IG_setSequence()

This public method is inherited from I2CE_FormStorage_Mechanism->FF_IG_setSequence()

getFormsById()

This public method is inherited from I2CE_FormStorage_Mechanism->getFormsById()

getIdsAsChild()

This public method is inherited from I2CE_FormStorage_Mechanism->getIdsAsChild()

globalFieldUpdateByFunction()

This public method is inherited from I2CE_FormStorage_Mechanism->globalFieldUpdateByFunction()

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

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