Class: I2CE FormStorage magicdata

The class I2CE_FormStorage_magicdata contains 2 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.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.
• Parent Classses: I2CE_FormStorage_DB I2CE_FormStorage_Mechanism I2CE_Fuzzy
• Location: Part of the module forms-storage-magicdata in the package I2CE
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.db.php
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.0

@filesource Class I2CE_FormStorage_magicdata

Methods

FF_save()

Save the FormField to the database.

• 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

• Signature: public function __construct($name,$options)
• Parameters:
  • string $name
    The name of this storage mechanism
  • array $options
    • Default Value: array()

delete()

Deletes a form from the entry tables. @param boolean $deleted_records: a flag to determine if the record should not go to the deleted_records table. default: false

• Signature: public function delete($form,$transact,$complete,$no_history)
• Parameters:
  • I2CE_Form $form
  • boolean $transact
    a flag to use transactions or not. default: true
  • boolean $complete
    a flag to determine if a complete delete should happen. default: false
  • $no_history
• Returns: boolean

getFormConfig()

Return the magic data node for the given form.

• 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

• 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

• 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"

• Signature: public function getRequiredFieldsQuery($form,$fields,$id,$parent,$field_reference_callback,$mod_time)
• 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
• Returns: string
  the query or false on failed.

isWritable()

Checks to see if this is writalbe

• Signature: public function isWritable()
• Returns: boolean

save()

Save a form object into magicdata

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

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

populateHistory()

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

compareFormsByFields()

This protected method is inherited from I2CE_FormStorage_Mechanism->compareFormsByFields()

getLimitedFields()

This protected method is inherited from I2CE_FormStorage_Mechanism->getLimitedFields()

_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

$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.
• Parent Classses: I2CE_FormStorage_Mechanism I2CE_Fuzzy
• Location: Part of the module forms-storage-magicdata in the package I2CE
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageMagicData/lib/classDef/I2CE_FormStorage_magicdata.no_db.php
• 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.

• Signature: public function FF_populateHistory($form_field)
• Parameters:
  • I2CE_FormField $form_field
• Returns: boolean

FF_save()

Save the FormField to the database.

• 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

• Signature: public function __construct($name,$options)
• Parameters:
  • string $name
    The name of this storage mechanism
  • array $options
    • Default Value: array()

delete()

Deletes a form from the entry tables. @param boolean $deleted_records: a flag to determine if the record should not go to the deleted_records table. default: false

• Signature: public function delete($form,$transact,$complete,$no_history)
• Parameters:
  • I2CE_Form $form
  • boolean $transact
    a flag to use transactions or not. default: true
  • boolean $complete
    a flag to determine if a complete delete should happen. default: false
  • $no_history
• Returns: boolean

getFormConfig()

Return the magic data node for the given form.

• 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

• 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

• 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.

• Signature: public function getRecords($form_name)
• Parameters:
  • string $form_name
• Returns: array

isWritable()

Checks to see if this is writalbe

• Signature: public function isWritable()
• Returns: boolean

listDisplayFields()

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

• 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
  • 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.

• 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.

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

• Signature: static public function orderByFields($vals,$ordering)
• Parameters:
  • $vals
  • $ordering

populate()

Populate the member variables of the object from the database.

• Signature: public function populate($form)
• Parameters:
  • I2CE_Form $form

quickSearch()

• 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

• Signature: public function save($form,$user,$transact)
• Parameters:
  • I2CE_Form $form
  • I2CE_User $user
  • boolean $transact

search()

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

populateHistory()

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

compareFormsByFields()

This protected method is inherited from I2CE_FormStorage_Mechanism->compareFormsByFields()

getLimitedFields()

This protected method is inherited from I2CE_FormStorage_Mechanism->getLimitedFields()

_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

$ordering

Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$ordering

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()