Class: I2CE FormStorage SDMXHD (Development)

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

This article describes the class I2CE_FormStorage_SDMXHD .

• Extends the class: I2CE_FormStorage_Mechanism.
• Location: Part of the module forms-storage-SDMXHD in the package I2CE 4.0-dev
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php on line 35
• Author: Luke Duncan <lduncan@intrahealth.org>

• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.0

@filesource Class I2CE_FormStorage_SDMXHD Storage mechanism for reading SDMX-HD code lists.

Variables

$closeFile

whether or not to close the file pointer between access.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php on line 54
• Type: protected boolean $closeFile

$dom_data

. An array indexed by form names of arrays. array( 'doc' => DOMDocument, 'xpath' => DOMXPath, 'cl_node' => DOMNode )

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php on line 63
• Type: protected array $dom_data

Methods

__construct()

Construct this module class

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

closeFile()

Unset the data associated with the form if it exists.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php on line 122
• Signature: protected function closeFile($form)
• Parameters:
  • string $form

getFile()

Tries to get the filepointer for the SDMX-HD file

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php on line 70
• Signature: protected function getFile($form)
• Parameters:
  • string $form
• Returns: DOMDocument

getRecords()

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

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

isWritable()

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php on line 142
• Signature: public function isWritable()

populate()

Populate the member variables of the object from the database. SDMX-HD will only work as a SimpleList

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php on line 177
• Signature: public function populate($form)
• Parameters:
  • I2CE_SimpleList $form
• Returns: boolean

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