Class: I2CE FormStorage SDMX CrossSectional (Development)

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

This article describes the class I2CE_FormStorage_SDMX_CrossSectional .

• Extends the class: I2CE_FormStorage_XML_BASE.
• 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_SDMX_CrossSectional.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

$namespace

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

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMX_CrossSectional.php on line 40
• Type: protected $namespace

$mapping_data

. An array, indexed by form names, of an array of mapping data.

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMX_CrossSectional.php on line 104
• Type: protected array $mapping_data

Methods

getBaseQuery()

Get the xpath query for the base node containing the data

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMX_CrossSectional.php on line 46
• 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/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMX_CrossSectional.php on line 75
• 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/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMX_CrossSectional.php on line 56
• Signature: protected function getDataNodesQuery($form)
• Parameters:
  • string $form
• Returns: string

getMappedCodeLists()

Gets any code lists that are already mapped in the system

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMX_CrossSectional.php on line 111
• Signature: protected function getMappedCodeLists($form)
• Parameters:
  • string $form
• Returns: boolean

getSearchCategory()

Get the search category

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

hasMappedCodeLists()

Checks to see if the indicated form has any code lists that are mapped in the system

• Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageSDMXHD/lib/I2CE_FormStorage_SDMX_CrossSectional.php on line 96
• Signature: protected function hasMappedCodeLists($form)
• Parameters:
  • string $form
• Returns: boolean

populate()

Populate the member variables of the object from the Cross Sectional Data Set

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

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

ensureNodeLocations()

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

getFieldDataDesc()

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

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

getNodeIdDescription()

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

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