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

From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_FormStorage_SDMXHD}} This article describes the class ''I2CE_FormStorage_SDMXHD'' . *Extends the class: [[Class: I2CE_FormStorage_Mechanism (Developme…')
 
No edit summary
Line 1: Line 1:
{{otherversions|Class: I2CE_FormStorage_SDMXHD}}
{{otherversions|Class: I2CE_FormStorage_SDMXHD}}
This article describes the class ''I2CE_FormStorage_SDMXHD'' .
This article describes the class ''I2CE_FormStorage_SDMXHD'' .
*Extends the class: [[Class: I2CE_FormStorage_Mechanism (Development) | I2CE_FormStorage_Mechanism]].
*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.0-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.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
Line 10: Line 10:
@filesource Class I2CE_FormStorage_SDMXHD Storage mechanism for reading SDMX-HD code lists.
@filesource Class I2CE_FormStorage_SDMXHD Storage mechanism for reading SDMX-HD code lists.
==Variables==
==Variables==
===$closeFile===
===$codelist===
whether or not to close the file pointer between access.
$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#L54 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 54
*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
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $closeFile
*Type: protected $codelist
 
===$dom_data===
.  An array indexed by form names of arrays.  array( 'doc' => DOMDocument, 'xpath' => DOMXPath, 'cl_node' => DOMNode )
*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#L63 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 63
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $dom_data


==Methods==
==Methods==
===__construct()===
===getBaseQuery()===
Construct this module class
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#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.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
*Signature: public function __construct($name,$options)
*Signature: protected function getBaseQuery($form)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $form
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getDOMData()===
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
*Signature: protected function getDOMData($form)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $form
*Returns: [http://www.php.net/manual/en/class.domdocument.php DOMDocument ]
===getDataNodesQuery()===
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
*Signature: protected function getDataNodesQuery($form)
*Parameters:
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name of this storage mechanism
** [http://www.php.net/manual/en/language.types.string.php string ] $form
** [http://www.php.net/manual/en/language.types.array.php array ] $options
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
***Default Value: array()
===getFieldDataDesc()===
===closeFile()===
Get the field data description for the given form.
Unset the data associated with the form if it exists.
*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.0-dev/annotate/head:/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php#L122 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 122
*Signature: protected function getFieldDataDesc($form)
*Signature: protected function closeFile($form)
*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
===getFile()===
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>indexed by field name.
Tries to get the filepointer for the SDMX-HD file
===getNodeIdDescription()===
*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#L70 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 70
Get the id associated to the given node @param DOMNode $node @param int count
*Signature: protected function getFile($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#L103 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 103
*Signature: protected function getNodeIdDescription($form)
*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/class.domdocument.php DOMDocument ]
*Returns: string.<br/>'0' or null  on failure a string on success.
===getRecords()===
===getSearchCategory()===
Return an array of all the record ids for a given form.
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#L153 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 153
*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
*Signature: public function getRecords($form)
*Signature: protected function getSearchCategory($form)
*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 ]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
==Inherited Methods==
===getRecords()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getRecords() | I2CE_FormStorage_XML_BASE->getRecords()]]
 
===isWritable()===
===isWritable()===
*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#L142 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 142
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#isWritable() | I2CE_FormStorage_XML_BASE->isWritable()]]
*Signature: public function isWritable()
 
===listDisplayFields()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#listDisplayFields() | I2CE_FormStorage_XML_BASE->listDisplayFields()]]
 
===listFields()===
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#listFields() | I2CE_FormStorage_XML_BASE->listFields()]]
 
===populate()===
===populate()===
Populate the member variables of the object from the database. SDMX-HD will only work as a SimpleList
This public method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#populate() | I2CE_FormStorage_XML_BASE->populate()]]
*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#L177 i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMXHD.php] on line 177
 
*Signature: public function populate($form)
===ensureNodeLocations()===
*Parameters:
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#ensureNodeLocations() | I2CE_FormStorage_XML_BASE->ensureNodeLocations()]]
** [[Class: I2CE_SimpleList (Development) | I2CE_SimpleList]] $form
 
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===getFile()===
==Inherited Methods==
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getFile() | I2CE_FormStorage_XML_BASE->getFile()]]
 
===getFormData()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getFormData() | I2CE_FormStorage_XML_BASE->getFormData()]]
 
===getNodeId()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getNodeId() | I2CE_FormStorage_XML_BASE->getNodeId()]]
 
===getNodeLocation()===
This protected method is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#getNodeLocation() | I2CE_FormStorage_XML_BASE->getNodeLocation()]]
 
===FF_IG_setSequence()===
===FF_IG_setSequence()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#FF_IG_setSequence() | I2CE_FormStorage_Mechanism->FF_IG_setSequence()]]
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#FF_IG_setSequence() | I2CE_FormStorage_Mechanism->FF_IG_setSequence()]]
Line 68: Line 97:
===FF_save()===
===FF_save()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#FF_save() | I2CE_FormStorage_Mechanism->FF_save()]]
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#FF_save() | I2CE_FormStorage_Mechanism->FF_save()]]
===__construct()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#__construct() | I2CE_FormStorage_Mechanism->__construct()]]


===delete()===
===delete()===
Line 77: Line 109:
===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()]]
===listDisplayFields()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#listDisplayFields() | I2CE_FormStorage_Mechanism->listDisplayFields()]]
===listFields()===
This public method is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#listFields() | I2CE_FormStorage_Mechanism->listFields()]]


===lookupDisplayField()===
===lookupDisplayField()===
Line 114: Line 140:
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===
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===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#$id_def | I2CE_FormStorage_XML_BASE->$id_def]]
===$fieldData===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_XML_BASE (Development)#$fieldData | I2CE_FormStorage_XML_BASE->$fieldData]]
===$name===
===$name===
Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#$name | I2CE_FormStorage_Mechanism->$name]]
Theis protected variable is inherited from [[Class: I2CE_FormStorage_Mechanism (Development)#$name | I2CE_FormStorage_Mechanism->$name]]

Revision as of 08:56, 3 August 2010

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


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

getRecords()

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

isWritable()

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

listDisplayFields()

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

listFields()

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

populate()

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

ensureNodeLocations()

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

getFile()

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

getFormData()

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

getNodeId()

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

getNodeLocation()

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

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

$mod_time

Theis protected variable is inherited from I2CE_FormStorage_XML_BASE->$mod_time

$dom_data

Theis protected variable is inherited from I2CE_FormStorage_XML_BASE->$dom_data

$locations

Theis protected variable is inherited from I2CE_FormStorage_XML_BASE->$locations

$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

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_FormStorage_SDMXHD_(Development)&oldid=33059"