Class: I2CE FormStorage SDMXHD (Development): Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
 
Line 2: Line 2:
This article describes the class ''I2CE_FormStorage_SDMXHD'' .
This article describes the class ''I2CE_FormStorage_SDMXHD'' .
*Extends the class: [[Class: I2CE_FormStorage_XML_BASE (Development) | I2CE_FormStorage_XML_BASE]].
*Extends the class: [[Class: I2CE_FormStorage_XML_BASE (Development) | I2CE_FormStorage_XML_BASE]].
*Location: Part of the module [[I2CE Module List (Development)#forms-storage-SDMXHD|forms-storage-SDMXHD]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#forms-storage-SDMXHD|forms-storage-SDMXHD]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L35 modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 35
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L35 modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 35
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>


Line 12: Line 12:
===$codelist===
===$codelist===
$var protected array $codelist array of the codelists used index by the form name
$var protected array $codelist array of the codelists used index by the form name
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L42 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 42
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L42 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 42
*Type: protected $codelist
*Type: protected $codelist


Line 18: Line 18:
===getBaseQuery()===
===getBaseQuery()===
Get the xpath query for the base node containing the data
Get the xpath query for the base node containing the data
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L73 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 73
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L73 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 73
*Signature: protected function getBaseQuery($form)
*Signature: protected function getBaseQuery($form)
*Parameters:
*Parameters:
Line 25: Line 25:
===getDOMData()===
===getDOMData()===
Tries to get the DOM Data for the SDMX-HD file
Tries to get the DOM Data for the SDMX-HD file
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L50 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 50
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L50 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 50
*Signature: protected function getDOMData($form)
*Signature: protected function getDOMData($form)
*Parameters:
*Parameters:
Line 32: Line 32:
===getDataNodesQuery()===
===getDataNodesQuery()===
Get the xpath query for the data nodes relative to the  the containing data
Get the xpath query for the data nodes relative to the  the containing data
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L83 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 83
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L83 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 83
*Signature: protected function getDataNodesQuery($form)
*Signature: protected function getDataNodesQuery($form)
*Parameters:
*Parameters:
Line 39: Line 39:
===getFieldDataDesc()===
===getFieldDataDesc()===
Get the field data description for the given form.
Get the field data description for the given form.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L114 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 114
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L115 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 115
*Signature: protected function getFieldDataDesc($form)
*Signature: protected function getFieldDataDesc($form,$field)
*Parameters:
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $form
** [http://www.php.net/manual/en/language.types.string.php string ] $form
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>indexed by field name.
** [http://www.php.net/manual/en/language.types.string.php string ] $field <br/>Defaults to null in which case we get all the fields for the given form
***Default Value: null
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>indexed by field name or an array of the field data.
===getNodeIdDescription()===
===getNodeIdDescription()===
Get the id associated to the given node @param DOMNode $node @param int count
Get the id associated to the given node @param DOMNode $node @param int count
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L103 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 103
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L103 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 103
*Signature: protected function getNodeIdDescription($form)
*Signature: protected function getNodeIdDescription($form)
*Parameters:
*Parameters:
Line 53: Line 55:
===getSearchCategory()===
===getSearchCategory()===
Get the search category
Get the search category
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L92 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 92
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L92 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 92
*Signature: protected function getSearchCategory($form)
*Signature: protected function getSearchCategory($form)
*Parameters:
*Parameters:
Line 59: Line 61:
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
==Inherited Methods==
==Inherited Methods==
===release()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#release() | I2CE_FormStorage_XML_BASE->release()]]
===ensureLocations()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#ensureLocations() | I2CE_FormStorage_XML_BASE->ensureLocations()]]
===getFieldValue()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getFieldValue() | I2CE_FormStorage_XML_BASE->getFieldValue()]]
===getFormData()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getFormData() | I2CE_FormStorage_XML_BASE->getFormData()]]
===getLocationId()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getLocationId() | I2CE_FormStorage_XML_BASE->getLocationId()]]
===getNamespaces()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getNamespaces() | I2CE_FormStorage_XML_BASE->getNamespaces()]]
===getFile()===
This public method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#getFile() | I2CE_FormStorage_File_Base->getFile()]]
===getFileData()===
This public method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#getFileData() | I2CE_FormStorage_File_Base->getFileData()]]
===getFileModTime()===
This public method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#getFileModTime() | I2CE_FormStorage_File_Base->getFileModTime()]]
===getRecords()===
===getRecords()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getRecords() | I2CE_FormStorage_XML_BASE->getRecords()]]
This public method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#getRecords() | I2CE_FormStorage_File_Base->getRecords()]]


===isWritable()===
===isWritable()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#isWritable() | I2CE_FormStorage_XML_BASE->isWritable()]]
This public method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#isWritable() | I2CE_FormStorage_File_Base->isWritable()]]


===listDisplayFields()===
===listDisplayFields()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#listDisplayFields() | I2CE_FormStorage_XML_BASE->listDisplayFields()]]
This public method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#listDisplayFields() | I2CE_FormStorage_File_Base->listDisplayFields()]]


===listFields()===
===listFields()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#listFields() | I2CE_FormStorage_XML_BASE->listFields()]]
This public method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#listFields() | I2CE_FormStorage_File_Base->listFields()]]


===populate()===
===populate()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#populate() | I2CE_FormStorage_XML_BASE->populate()]]
This public method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#populate() | I2CE_FormStorage_File_Base->populate()]]


===ensureNodeLocations()===
===_getFile()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#ensureNodeLocations() | I2CE_FormStorage_XML_BASE->ensureNodeLocations()]]
This protected method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#_getFile() | I2CE_FormStorage_File_Base->_getFile()]]


===getFile()===
===getFileData_mdn()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getFile() | I2CE_FormStorage_XML_BASE->getFile()]]
This protected method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#getFileData_mdn() | I2CE_FormStorage_File_Base->getFileData_mdn()]]


===getFormData()===
===getFileData_stream()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getFormData() | I2CE_FormStorage_XML_BASE->getFormData()]]
This protected method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#getFileData_stream() | I2CE_FormStorage_File_Base->getFileData_stream()]]


===getNodeId()===
===getFileURIType()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getNodeId() | I2CE_FormStorage_XML_BASE->getNodeId()]]
This protected method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#getFileURIType() | I2CE_FormStorage_File_Base->getFileURIType()]]


===getNodeLocation()===
===getLocation()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getNodeLocation() | I2CE_FormStorage_XML_BASE->getNodeLocation()]]
This protected method is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#getLocation() | I2CE_FormStorage_File_Base->getLocation()]]


===FF_IG_setSequence()===
===FF_IG_setSequence()===
Line 100: Line 129:
===__construct()===
===__construct()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#__construct() | I2CE_FormStorage_Mechanism->__construct()]]
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#__construct() | I2CE_FormStorage_Mechanism->__construct()]]
===changeID()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#changeID() | I2CE_FormStorage_Mechanism->changeID()]]


===delete()===
===delete()===
Line 109: Line 141:
===getIdsAsChild()===
===getIdsAsChild()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#getIdsAsChild() | I2CE_FormStorage_Mechanism->getIdsAsChild()]]
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#getIdsAsChild() | I2CE_FormStorage_Mechanism->getIdsAsChild()]]
===globalFieldUpdateByFunction()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#globalFieldUpdateByFunction() | I2CE_FormStorage_Mechanism->globalFieldUpdateByFunction()]]
===hasRecord()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#hasRecord() | I2CE_FormStorage_Mechanism->hasRecord()]]


===lookupDisplayField()===
===lookupDisplayField()===
Line 140: Line 178:
This public method is inherited from [[Class: I2CE_Fuzzy (Development)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
This public method is inherited from [[Class: I2CE_Fuzzy (Development)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Variables==
==Inherited Variables==
===$mod_time===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#$mod_time | I2CE_FormStorage_XML_BASE->$mod_time]]
===$dom_data===
===$dom_data===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#$dom_data | I2CE_FormStorage_XML_BASE->$dom_data]]
Theis protected variable is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#$dom_data | I2CE_FormStorage_XML_BASE->$dom_data]]
===$locations===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#$locations | I2CE_FormStorage_XML_BASE->$locations]]


===$id_def===
===$id_def===
Line 154: Line 186:
===$fieldData===
===$fieldData===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#$fieldData | I2CE_FormStorage_XML_BASE->$fieldData]]
Theis protected variable is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#$fieldData | I2CE_FormStorage_XML_BASE->$fieldData]]
===$locations===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#$locations | I2CE_FormStorage_File_Base->$locations]]
===$mod_time===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_File_Base (Development)#$mod_time | I2CE_FormStorage_File_Base->$mod_time]]


===$name===
===$name===

Latest revision as of 08:14, 6 May 2015


This article describes the class I2CE_FormStorage_SDMXHD .

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

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

Variables

$codelist

$var protected array $codelist array of the codelists used index by the form name

Methods

getBaseQuery()

Get the xpath query for the base node containing the data

getDOMData()

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

getDataNodesQuery()

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

getFieldDataDesc()

Get the field data description for the given form.

getNodeIdDescription()

Get the id associated to the given node @param DOMNode $node @param int count

getSearchCategory()

Get the search category

Inherited Methods

release()

This public method is inherited from I2CE_FormStorage_XML_BASE->release()

ensureLocations()

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

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

getNamespaces()

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

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