Class: I2CE FormStorage XML (Development)

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

This article describes the class I2CE_FormStorage_XML .

• Extends the class: I2CE_FormStorage_XML_BASE.
• Location: Part of the module forms-storage-xml in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 35
• Author: Luke Duncan <lduncan@intrahealth.org>

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

@filesource Class I2CE_FormStorage_XML Storage mechanism for reading XML code lists.

Variables

$basequery

$var protected array $basequery array of the basequerys used index by the form name

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 42
• Type: protected $basequery

$dataquery

$var protected array $dataquery array of the dataquerys used index by the form name

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 49
• Type: protected $dataquery

$searchcat

$var protected array $searchcat array of the searchcats used index by the form name

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 56
• Type: protected $searchcat

$namespaces

$var protected array $namespaces array of the name spaces used index by the form name

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 61
• Type: protected $namespaces

Methods

getBaseQuery()

Get the xpath query for the base node containing the data

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 149
• Signature: protected function getBaseQuery($form)
• Parameters:
  • string $form
• Returns: string

getDOMData()

Tries to get the DOM Data for the SDMX-HD file

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 109
• Signature: protected function getDOMData($form)
• Parameters:
  • string $form
• Returns: DOMDocument

getDataNodesQuery()

Get the xpath query for the data nodes relative to the the containing data

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 158
• Signature: protected function getDataNodesQuery($form)
• Parameters:
  • string $form
• Returns: string

getNamespaces()

Get the namespaces we should register with xpath

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 69
• Signature: protected function getNamespaces($form)
• Parameters:
  • string $form
• Returns: array
  keys are namespace prefixes values are the URIS

getSearchCategory()

Get the search category

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

release()

Release any resourced held by this form storage mechanism for the indicated form

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML.php on line 82
• Signature: public function release($form)
• Parameters:
  • string $form

Inherited Methods

ensureLocations()

This protected method is inherited from I2CE_FormStorage_XML_BASE->ensureLocations()

getFieldDataDesc()

This protected method is inherited from I2CE_FormStorage_XML_BASE->getFieldDataDesc()

getFieldValue()

This protected method is inherited from I2CE_FormStorage_XML_BASE->getFieldValue()

getFormData()

This protected method is inherited from I2CE_FormStorage_XML_BASE->getFormData()

getLocationId()

This protected method is inherited from I2CE_FormStorage_XML_BASE->getLocationId()

getNodeIdDescription()

This protected method is inherited from I2CE_FormStorage_XML_BASE->getNodeIdDescription()

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

changeID()

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

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

globalFieldUpdateByFunction()

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

hasRecord()

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

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

$dom_data

Theis protected variable is inherited from I2CE_FormStorage_XML_BASE->$dom_data

$id_def

Theis protected variable is inherited from I2CE_FormStorage_XML_BASE->$id_def

$fieldData

Theis protected variable is inherited from I2CE_FormStorage_XML_BASE->$fieldData

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