Class: I2CE FormRelationship Template: Difference between revisions

From IHRIS Wiki
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article describes the class ''I2CE_FormRelationship_Template''.
#REDIRECT [[Class: I2CE_FormRelationship_Template (4.1.7)]]
*Extends the class: [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]].
*Location: Part of the module [[I2CE Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L29 modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 29
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_FormRelationship_Template
==Variables==
===$templates===
An array of requested relationships templates I2CE_CustomReport_Template  indexed by the type and then by  name @protected static array $templates
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L35 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 35
*Type: static protected $templates
 
===$types===
An array index by configTypes.  the values are arrays whose keys are fields with values the config types the fields are supposed to have array $types
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L88 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 88
*Type: static protected static $types
 
===$blanket===
An array with keys config types such that all sub-nodes of a node with this configType will have the configType specified by the value associated to the key array $blanket
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L110 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 110
*Type: static protected static $blanket
 
===$required===
an array with keys configTypes with values the required fields for that config type. will cause a failure if not present $var protecected static $required
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L126 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 126
*Type: static protected $required
 
===$ensure===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L132 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 132
*Type: static protected $ensure
 
===$permissions===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L139 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 139
*Type: static protected $permissions
 
==Methods==
===createExport()===
Create an export node by appending on to the given configurationGroup node the values stored in the magic data.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L187 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 187
*Signature: public function createExport($configNode,$config,$pipe,$configType,$status)
*Parameters:
** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode <br/>A configurationGroup node.
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config <br/>The data we wish to store at this node
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $pipe <br/>A path component or an array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists.  Otherwise, if the pipe is empty or null, we export all keys.  Defaults to empty array
***Default Value: null
** [http://www.php.net/manual/en/language.types.string.php string ] $configType <br/>Defaults to the empty string.  The configuration type to give the configuration node.
***Default Value: ''
** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>An array of status options we should set for this configuration node.  Defaults to the empty array
***Default Value: array()
===createExportNodeConfigurationGroup()===
Create an configurationGroup node by appending on to the given configurationGroup node the values stored in the magic data at the specified $key.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L158 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 158
*Signature: public function createExportNodeConfigurationGroup($configNode,$config,$pipe,$key,$configType,$status)
*Parameters:
** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode <br/>A configurationGroup node.
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config <br/>The data we wish to store at this node
** [http://www.php.net/manual/en/language.types.array.php array ] $pipe <br/>An array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists.  Otherwise, if the pipe is empty, we export all keys
** [http://www.php.net/manual/en/language.types.string.php string ] $key <br/>The key.  (Warning.  It assumes it exists in the magic data!)
** [http://www.php.net/manual/en/language.types.string.php string ] $configType <br/>Defaults to the empty string.  The configuration type to give the configuration node.
** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>An array of status options we should set for this configuration node.  Defaults to the empty array
===getReportForm()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L263 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 263
*Signature: static public function getReportForm($configNode)
*Parameters:
**$configNode
===getReportFormNode()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L241 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 241
*Signature: static public function getReportFormNode($configNode)
*Parameters:
**$configNode
===getTemplate()===
Gets a  template.  Also caches the results
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php#L45 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship_Template.php] on line 45
*Signature: static public function getTemplate($type,$name)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $type <br/>one of report, relationship or reportView.  Defaults to null meaning we get everything under /modules/CustomReports
***Default Value: null
** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>Defaults to null meaning we get all the <$type>s of the specified name
***Default Value: null
*Returns: I2CE_CustomReportTemplate<br/>on sucess
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#__construct() | I2CE_MagicDataTemplate->__construct()]]
 
===getConfigMetaData()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#getConfigMetaData() | I2CE_MagicDataTemplate->getConfigMetaData()]]
 
===getConfigurationTextContent()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#getConfigurationTextContent() | I2CE_MagicDataTemplate->getConfigurationTextContent()]]
 
===getDefaultStatus()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#getDefaultStatus() | I2CE_MagicDataTemplate->getDefaultStatus()]]
 
===getMerges()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#getMerges() | I2CE_MagicDataTemplate->getMerges()]]
 
===getTextContent()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#getTextContent() | I2CE_MagicDataTemplate->getTextContent()]]
 
===processStatus()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#processStatus() | I2CE_MagicDataTemplate->processStatus()]]
 
===processValues()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#processValues() | I2CE_MagicDataTemplate->processValues()]]
 
===setConfigValues()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#setConfigValues() | I2CE_MagicDataTemplate->setConfigValues()]]
 
===validate()===
This public method is inherited from [[Class: I2CE_MagicDataTemplate#validate() | I2CE_MagicDataTemplate->validate()]]
 
===getConfigPath()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#getConfigPath() | I2CE_MagicDataTemplate->getConfigPath()]]
 
===processValues_boolean_single()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_boolean_single() | I2CE_MagicDataTemplate->processValues_boolean_single()]]
 
===processValues_delimited_many()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_delimited_many() | I2CE_MagicDataTemplate->processValues_delimited_many()]]
 
===processValues_delimited_single()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_delimited_single() | I2CE_MagicDataTemplate->processValues_delimited_single()]]
 
===processValues_list_many()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_list_many() | I2CE_MagicDataTemplate->processValues_list_many()]]
 
===processValues_list_single()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_list_single() | I2CE_MagicDataTemplate->processValues_list_single()]]
 
===processValues_string_many()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_string_many() | I2CE_MagicDataTemplate->processValues_string_many()]]
 
===processValues_string_single()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_string_single() | I2CE_MagicDataTemplate->processValues_string_single()]]
 
===traversePaths()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#traversePaths() | I2CE_MagicDataTemplate->traversePaths()]]
 
===updateClassPath()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#updateClassPath() | I2CE_MagicDataTemplate->updateClassPath()]]
 
===updatePaths()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#updatePaths() | I2CE_MagicDataTemplate->updatePaths()]]
 
===validateValues_string_single()===
This protected method is inherited from [[Class: I2CE_MagicDataTemplate#validateValues_string_single() | I2CE_MagicDataTemplate->validateValues_string_single()]]
 
===addFile()===
This public method is inherited from [[Class: I2CE_TemplateMeister#addFile() | I2CE_TemplateMeister->addFile()]]
 
===addHeader()===
This public method is inherited from [[Class: I2CE_TemplateMeister#addHeader() | I2CE_TemplateMeister->addHeader()]]
 
===addText()===
This public method is inherited from [[Class: I2CE_TemplateMeister#addText() | I2CE_TemplateMeister->addText()]]
 
===addTextNode()===
This public method is inherited from [[Class: I2CE_TemplateMeister#addTextNode() | I2CE_TemplateMeister->addTextNode()]]
 
===appendElementById()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendElementById() | I2CE_TemplateMeister->appendElementById()]]
 
===appendElementByNode()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendElementByNode() | I2CE_TemplateMeister->appendElementByNode()]]
 
===appendFileById()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendFileById() | I2CE_TemplateMeister->appendFileById()]]
 
===appendFileByName()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendFileByName() | I2CE_TemplateMeister->appendFileByName()]]
 
===appendFileByNode()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendFileByNode() | I2CE_TemplateMeister->appendFileByNode()]]
 
===appendNode()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendNode() | I2CE_TemplateMeister->appendNode()]]
 
===appendNodeById()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendNodeById() | I2CE_TemplateMeister->appendNodeById()]]
 
===appendNodeByName()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendNodeByName() | I2CE_TemplateMeister->appendNodeByName()]]
 
===appendNodesByName()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendNodesByName() | I2CE_TemplateMeister->appendNodesByName()]]
 
===appendTextById()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendTextById() | I2CE_TemplateMeister->appendTextById()]]
 
===appendTextByName()===
This public method is inherited from [[Class: I2CE_TemplateMeister#appendTextByName() | I2CE_TemplateMeister->appendTextByName()]]
 
===changeAttributesOnNodes()===
This public method is inherited from [[Class: I2CE_TemplateMeister#changeAttributesOnNodes() | I2CE_TemplateMeister->changeAttributesOnNodes()]]
 
===clearHeaders()===
This public method is inherited from [[Class: I2CE_TemplateMeister#clearHeaders() | I2CE_TemplateMeister->clearHeaders()]]
 
===createElement()===
This public method is inherited from [[Class: I2CE_TemplateMeister#createElement() | I2CE_TemplateMeister->createElement()]]
 
===createTextNode()===
This public method is inherited from [[Class: I2CE_TemplateMeister#createTextNode() | I2CE_TemplateMeister->createTextNode()]]
 
===evaluate()===
This public method is inherited from [[Class: I2CE_TemplateMeister#evaluate() | I2CE_TemplateMeister->evaluate()]]
 
===findAndRemoveNodes()===
This public method is inherited from [[Class: I2CE_TemplateMeister#findAndRemoveNodes() | I2CE_TemplateMeister->findAndRemoveNodes()]]
 
===findTemplate()===
This public method is inherited from [[Class: I2CE_TemplateMeister#findTemplate() | I2CE_TemplateMeister->findTemplate()]]
 
===getDisplay()===
This public method is inherited from [[Class: I2CE_TemplateMeister#getDisplay() | I2CE_TemplateMeister->getDisplay()]]
 
===getDoc()===
This public method is inherited from [[Class: I2CE_TemplateMeister#getDoc() | I2CE_TemplateMeister->getDoc()]]
 
===getElementById()===
This public method is inherited from [[Class: I2CE_TemplateMeister#getElementById() | I2CE_TemplateMeister->getElementById()]]
 
===getElementByName()===
This public method is inherited from [[Class: I2CE_TemplateMeister#getElementByName() | I2CE_TemplateMeister->getElementByName()]]
 
===getElementByTagName()===
This public method is inherited from [[Class: I2CE_TemplateMeister#getElementByTagName() | I2CE_TemplateMeister->getElementByTagName()]]
 
===getHeaders()===
This public method is inherited from [[Class: I2CE_TemplateMeister#getHeaders() | I2CE_TemplateMeister->getHeaders()]]
 
===getUser()===
This public method is inherited from [[Class: I2CE_TemplateMeister#getUser() | I2CE_TemplateMeister->getUser()]]
 
===importText()===
This public method is inherited from [[Class: I2CE_TemplateMeister#importText() | I2CE_TemplateMeister->importText()]]
 
===loadFile()===
This public method is inherited from [[Class: I2CE_TemplateMeister#loadFile() | I2CE_TemplateMeister->loadFile()]]
 
===loadRootFile()===
This public method is inherited from [[Class: I2CE_TemplateMeister#loadRootFile() | I2CE_TemplateMeister->loadRootFile()]]
 
===loadRootText()===
This public method is inherited from [[Class: I2CE_TemplateMeister#loadRootText() | I2CE_TemplateMeister->loadRootText()]]
 
===prepareDisplay()===
This public method is inherited from [[Class: I2CE_TemplateMeister#prepareDisplay() | I2CE_TemplateMeister->prepareDisplay()]]
 
===processArgs()===
This public method is inherited from [[Class: I2CE_TemplateMeister#processArgs() | I2CE_TemplateMeister->processArgs()]]
 
===query()===
This public method is inherited from [[Class: I2CE_TemplateMeister#query() | I2CE_TemplateMeister->query()]]
 
===reIdNodes()===
This public method is inherited from [[Class: I2CE_TemplateMeister#reIdNodes() | I2CE_TemplateMeister->reIdNodes()]]
 
===removeNode()===
This public method is inherited from [[Class: I2CE_TemplateMeister#removeNode() | I2CE_TemplateMeister->removeNode()]]
 
===removeNodeById()===
This public method is inherited from [[Class: I2CE_TemplateMeister#removeNodeById() | I2CE_TemplateMeister->removeNodeById()]]
 
===renameNodes()===
This public method is inherited from [[Class: I2CE_TemplateMeister#renameNodes() | I2CE_TemplateMeister->renameNodes()]]
 
===replaceNode()===
This public method is inherited from [[Class: I2CE_TemplateMeister#replaceNode() | I2CE_TemplateMeister->replaceNode()]]
 
===setAttribute()===
This public method is inherited from [[Class: I2CE_TemplateMeister#setAttribute() | I2CE_TemplateMeister->setAttribute()]]
 
===setLoadOptions()===
This public method is inherited from [[Class: I2CE_TemplateMeister#setLoadOptions() | I2CE_TemplateMeister->setLoadOptions()]]
 
===setNodeAttribute()===
This public method is inherited from [[Class: I2CE_TemplateMeister#setNodeAttribute() | I2CE_TemplateMeister->setNodeAttribute()]]
 
===setUser()===
This public method is inherited from [[Class: I2CE_TemplateMeister#setUser() | I2CE_TemplateMeister->setUser()]]
 
===setVerboseErrors()===
This public method is inherited from [[Class: I2CE_TemplateMeister#setVerboseErrors() | I2CE_TemplateMeister->setVerboseErrors()]]
 
===setWorkingDir()===
This public method is inherited from [[Class: I2CE_TemplateMeister#setWorkingDir() | I2CE_TemplateMeister->setWorkingDir()]]
 
===xmlError()===
This public method is inherited from [[Class: I2CE_TemplateMeister#xmlError() | I2CE_TemplateMeister->xmlError()]]
 
===_loadFile()===
This protected method is inherited from [[Class: I2CE_TemplateMeister#_loadFile() | I2CE_TemplateMeister->_loadFile()]]
 
===_loadText()===
This protected method is inherited from [[Class: I2CE_TemplateMeister#_loadText() | I2CE_TemplateMeister->_loadText()]]
 
===raiseError()===
This protected method is inherited from [[Class: I2CE_TemplateMeister#raiseError() | I2CE_TemplateMeister->raiseError()]]
 
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Variables==
===$merges===
Theis protected variable is inherited from [[Class: I2CE_MagicDataTemplate#$merges | I2CE_MagicDataTemplate->$merges]]
 
===$doc===
Theis public variable is inherited from [[Class: I2CE_TemplateMeister#$doc | I2CE_TemplateMeister->$doc]]
 
===$xpath===
Theis protected variable is inherited from [[Class: I2CE_TemplateMeister#$xpath | I2CE_TemplateMeister->$xpath]]
 
===$user===
Theis protected variable is inherited from [[Class: I2CE_TemplateMeister#$user | I2CE_TemplateMeister->$user]]
 
===$working_dir===
Theis protected variable is inherited from [[Class: I2CE_TemplateMeister#$working_dir | I2CE_TemplateMeister->$working_dir]]
 
===$loadOptions===
Theis protected variable is inherited from [[Class: I2CE_TemplateMeister#$loadOptions | I2CE_TemplateMeister->$loadOptions]]
 
===$headers===
Theis protected variable is inherited from [[Class: I2CE_TemplateMeister#$headers | I2CE_TemplateMeister->$headers]]
 
===$verboseErrors===
Theis protected variable is inherited from [[Class: I2CE_TemplateMeister#$verboseErrors | I2CE_TemplateMeister->$verboseErrors]]
==Inherited Fuzzy Methods==
===processValues_color_triple_hex_single()===
This method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_color_triple_hex_single() | I2CE_MagicDataTemplate->processValues_color_triple_hex_single()]]
 
===processValues_color_triple_hex_many()===
This method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_color_triple_hex_many() | I2CE_MagicDataTemplate->processValues_color_triple_hex_many()]]
 
===processValues_color_triple_rgb_single()===
This method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_color_triple_rgb_single() | I2CE_MagicDataTemplate->processValues_color_triple_rgb_single()]]
 
===processValues_color_triple_rgb_many()===
This method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_color_triple_rgb_many() | I2CE_MagicDataTemplate->processValues_color_triple_rgb_many()]]
 
===processValues_color_hex_single()===
This method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_color_hex_single() | I2CE_MagicDataTemplate->processValues_color_hex_single()]]
 
===processValues_color_hex_many()===
This method is inherited from [[Class: I2CE_MagicDataTemplate#processValues_color_hex_many() | I2CE_MagicDataTemplate->processValues_color_hex_many()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:39, 23 August 2013