Class: I2CE FormStorage CSV (4.0.5)

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

$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 51
• 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 59
• 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 115
• 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 121
• 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 309
• 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 39
• 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 104
• 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 317
• 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 66
• 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 257
• 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 132
• 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 150
• 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 229
• 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 432
• 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 421
• Signature: public function isWritable()

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

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