Class: I2CE FormStorage CSV (4.0.6)

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

This article describes the class I2CE_FormStorage_CSV .

• Extends the class: I2CE_FormStorage_File_Base.
• Location: Part of the module forms-storage-CSV in the package I2CE 4.0.6-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

$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 88
• Type: protected array $field_indices

Methods

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 170
• Signature: protected function ensureIndices($form,$header_line)
• Parameters:
  • string $form
  • $header_line
• Returns: true
  on success

ensureLocations()

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.

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

getFormData()

Reads a line of data from ta CSV filestring an array of readable and enabled datavalues from the CSV indexed by the field names, 'id' and 'parent' @param resource $fp

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

getLocationId()

Get the id associated to the given location data object

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageCSV/lib/I2CE_FormStorage_CSV.php on line 131
• Signature: protected function getLocationId($form,$line,$count)
• Parameters:
  • string $form
  • string $line @param int count
  • $count
• Returns: string.
  '0' or null on failure a string on success.

getSearchCategory()

Get the search category

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

Inherited Methods

getFile()

This public method is inherited from I2CE_FormStorage_File_Base->getFile()

getFileData()

This public method is inherited from I2CE_FormStorage_File_Base->getFileData()

getFileModTime()

This public method is inherited from I2CE_FormStorage_File_Base->getFileModTime()

getRecords()

This public method is inherited from I2CE_FormStorage_File_Base->getRecords()

isWritable()

This public method is inherited from I2CE_FormStorage_File_Base->isWritable()

listDisplayFields()

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

listFields()

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

populate()

This public method is inherited from I2CE_FormStorage_File_Base->populate()

_getFile()

This protected method is inherited from I2CE_FormStorage_File_Base->_getFile()

getFileData_mdn()

This protected method is inherited from I2CE_FormStorage_File_Base->getFileData_mdn()

getFileData_stream()

This protected method is inherited from I2CE_FormStorage_File_Base->getFileData_stream()

getFileURIType()

This protected method is inherited from I2CE_FormStorage_File_Base->getFileURIType()

getLocation()

This protected method is inherited from I2CE_FormStorage_File_Base->getLocation()

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

__construct()

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

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

$locations

Theis protected variable is inherited from I2CE_FormStorage_File_Base->$locations

$mod_time

Theis protected variable is inherited from I2CE_FormStorage_File_Base->$mod_time

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