Class: I2CE FormStorage CSV (4.0.3)

From IHRIS Wiki


This article describes the class I2CE_FormStorage_CSV .

@filesource Class I2CE_FormStorage_CSV

Variables

$closeCSV

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

$resources

. An array indexed by form names of file pointers.

$locations

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

$lastread_locations

Array of file last read offets for a given form.

$field_indices

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

Methods

__construct()

Construct this module class

closeCSV()

Tries to get the filepointer for the CSV file

ensureIndices()

Ensures that the column indices for the fields are set.

getCSV()

Tries to get the filepointer for the CSV file

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'

getFileLocation()

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

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

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'

getRecords()

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

isWritable()

populate()

Populate the member variables of the object from the database.

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

listDisplayFields()

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

listFields()

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

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