Class: I2CE FormStorage XML BASE (Development)

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

This article describes the abstract class I2CE_FormStorage_XML_BASE .

• Extends the class: I2CE_FormStorage_File_Base.
• Child Classes:
  • I2CE_FormStorage_SDMXHD
  • I2CE_FormStorage_SDMX_CrossSectional
  • I2CE_FormStorage_XML
• 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_BASE.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

$dom_data

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

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML_BASE.php on line 69
• Type: protected array $dom_data

$id_def

array, indexed by form,with detisl details to pull out id from a node

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML_BASE.php on line 215
• Type: protected array $id_def

$fieldData

An array of arrays, indexed by form name, containing the data defining the field

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML_BASE.php on line 311
• Type: protected array $fieldData

Methods

ensureLocations()

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

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_BASE.php on line 50
• Signature: abstract protected function getBaseQuery($form)
• Parameters:
  • string $form
• Returns: string

getDOMData()

Tries to get the DOM for the file

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML_BASE.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_BASE.php on line 42
• Signature: abstract protected function getDataNodesQuery($form)
• Parameters:
  • string $form
• Returns: string

getFieldDataDesc()

Get the field data description for the given form.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML_BASE.php on line 320
• Signature: protected function getFieldDataDesc($form,$field)
• Parameters:
  • string $form
  • string $field
    Defaults to null in which case we get all the fields for the given form
    • Default Value: null
• Returns: array
  indexed by field name or an array of the field data.

getFieldValue()

Get the value based on the given field data @param array $fieldData @param array $dom_data

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML_BASE.php on line 269
• Signature: protected function getFieldValue($form,$field,$node)
• Parameters:
  • string $form
  • string $field
  • DOMNode $node
• Returns: mixed.
  null if no data was found. otherwise it is a string

getFormData()

Process the given node for form data

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML_BASE.php on line 292
• Signature: protected function getFormData($form,$node)
• Parameters:
  • string $form
  • DOMNode $node
• Returns: array
  indexed by field name (including 'parent') and values the DB value

getLocationId()

Get the id associated to the given node

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

getNamespaces()

Get the namespaces we should register with xpath

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

getNodeIdDescription()

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageXML/lib/I2CE_FormStorage_XML_BASE.php on line 185
• Signature: protected function getNodeIdDescription($form)
• Parameters:
  • $form

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_BASE.php on line 76
• Signature: public function release($form)
• Parameters:
  • string $form

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

getSearchCategory()

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

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

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