Class: I2CE FormStorage CSV (Development)

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

This article describes the class I2CE_FormStorage_CSV .

• Extends the class: I2CE_FormStorage_Mechanism.
• Location: Part of the module forms-storage-CSV in the package I2CE 4.0-dev
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.0

@filesource Class I2CE_FormStorage_CSV

Variables

$mod_time

of int, the unix style mod time of the sdmx file associated to the form which is the index.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 39
• Type: protected array $mod_time

$closeCSV

whether or not to close the file pointer for a CSV between access.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 60
• Type: protected boolean $closeCSV

$resources

. An array indexed by form names of file pointers.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 68
• Type: protected array $resources

$locations

Array of file offesset for an id for a given form.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 126
• Type: protected $locations

$lastread_locations

Array of file last read offets for a given form.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 132
• Type: protected $lastread_locations

$field_indices

The column indices for the fields . Arrays indexed by form names of pairs $field=>$index

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 320
• Type: protected array $field_indices

Methods

__construct()

Construct this module class

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

closeCSV()

Tries to get the filepointer for the CSV file

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 115
• Signature: protected function closeCSV($form)
• Parameters:
  • string $form
• Returns: resource

ensureIndices()

Ensures that the column indices for the fields are set.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 328
• Signature: protected function ensureIndices($fp,$form)
• Parameters:
  • resource $fp
  • string $form
• Returns: true
  on success

getCSV()

Tries to get the filepointer for the CSV file

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 75
• Signature: protected function getCSV($form)
• Parameters:
  • string $form
• Returns: resource

getCSVData()

Reads a line of data from ta CSV file pointer and returns it as an array of readable and enabled datavalues from the CSV indexed by the field names, 'id' and 'parent'

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 268
• Signature: protected function getCSVData($fp,$form)
• Parameters:
  • resource $fp
  • string $form
• Returns: mixed
  array on success, false on failure

getFileLocation()

Get the offset in the CSV file for the specified form object

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 143
• Signature: protected function getFileLocation($formName,$id)
• Parameters:
  • string $formName @params string $id
  • $id
• Returns: int
  on success, false on failure.

getFileLocations()

Worker moethod to the offset in the CSV file for the specified form id and store it into the {$locations} cache. Reads through the file until the specified is found. @param resource $p

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 161
• Signature: protected function getFileLocations($fp,$form,$id)
• Parameters:
  • $fp
  • string $form
  • string $id
    If false we get all of the file locations
• Returns: int
  on success, false on failure.

getFormData()

Gets the form data for a specified form as an array of readable and enabled datavalues from the CSV indexed by the field names, 'id' and 'parent'

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 240
• Signature: protected function getFormData($form,$id)
• Parameters:
  • string $form
  • string $id
• Returns: array
  or false on failure

getRecords()

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

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

isWritable()

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 432
• Signature: public function isWritable()

listDisplayFields()

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

@param array $fieldes 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"

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 501
• Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
• Parameters:
  • string $form
    THe form name
  • $fields
  • 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.

populate()

Populate the member variables of the object from the database.

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

Inherited Methods

FF_IG_setSequence()

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

FF_populateHistory()

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

FF_save()

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

delete()

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

getFormsById()

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

getIdsAsChild()

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

lookupDisplayField()

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

lookupField()

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

populateHistory()

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

save()

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

search()

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

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