|
|
| (15 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_MagicDataTemplate''.
| | #REDIRECT [[Class: I2CE_MagicDataTemplate (4.1.7)]] |
| *Extends the class: [[Class: I2CE_TemplateMeister | I2CE_TemplateMeister]].
| |
| *Parent Classses: [[Class: I2CE_TemplateMeister | I2CE_TemplateMeister]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *Child Classes:
| |
| ** [[Class: I2CE_CustomReport_Template | I2CE_CustomReport_Template]]
| |
| ** [[Class: I2CE_MagicDataTemplate_YAML | I2CE_MagicDataTemplate_YAML]]
| |
| ** [[Class: I2CE_FormRelationship_Template | I2CE_FormRelationship_Template]]
| |
| ** [[Class: I2CE_MagicDataExport_Template | I2CE_MagicDataExport_Template]]
| |
| *Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/lib/I2CE_MagicDataTemplate.php lib/I2CE_MagicDataTemplate.php]
| |
| I2CE_MagicDataTemplate @todo Better documentation.
| |
| ==Variables==
| |
| ===$merges===
| |
| $var protected array $merges;
| |
| *Type: protected $merges
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| I2CE_Template constructor method. This constructor sets up the basic variables for all I2CE_Template objects.
| |
| *Signature: public function __construct()
| |
| ===getConfigMetaData()===
| |
| Gets the metadata of this config file in storage
| |
| *Signature: public function getConfigMetaData($storage)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $storage
| |
| ***Default Value: NULL
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess
| |
| ===getConfigPath()===
| |
| Get the path to the current node in the configuration file. Used for error reporting. @param $node DOMElement
| |
| *Signature: protected function getConfigPath($node)
| |
| *Parameters:
| |
| **$node
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The full configuration path
| |
| ===getConfigurationTextContent()===
| |
| Get the value in the <value> tag of a subnode specfiied by the name attribute
| |
| *Signature: public function getConfigurationTextContent($nodeName,$node,$which)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $nodeName
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>The node we wish to search under. Defaults to null meaning we search from the top node.
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $which <br/>Which result we want. Defaults to zero
| |
| ***Default Value: 0
| |
| *Returns: mixed.<br/>Null on failure, a string (the content) on sucess
| |
| ===getDefaultStatus()===
| |
| Get the default status variables.
| |
| *Signature: public function getDefaultStatus()
| |
| ===getMerges()===
| |
| Get the magic data paths whose status we are tracking. $retrurns array. Keys are paths values are the mergetype
| |
| *Signature: public function getMerges()
| |
| ===getTextContent()===
| |
| Get the text content of a node specified by its tag name
| |
| *Signature: public function getTextContent($name,$node,$which)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>the name of the node we wish to find the text content for
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>The node we wish to search under. Defaults to null meaning we search from the top node.
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $which <br/>Which result we want. Defaults to zero.
| |
| ***Default Value: 0
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>string on sucess, null on failure
| |
| ===processStatus()===
| |
| Assumes that the template is valid. Set the status variables according to this node
| |
| *Signature: public function processStatus($configNode,$currentStatus,$vers)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode <br/>A configuration or conigurationGroup node
| |
| **$currentStatus
| |
| ***Default Value: null
| |
| **$vers
| |
| ***Default Value: '0'
| |
| ===processValues()===
| |
| Process values for a config node @param I2CE_MagicDataNode $data @param string $version . Defaults to '0' . The version of the currently loaded data in $storage responsible for this XML @param array of string $paths -- the current path into the $storage that we are using. Defaults to the empty array().
| |
| *Signature: public function processValues($configNode,$storage,$status,$vers,$paths)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode
| |
| **$storage
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>If null, it defaults to the array set by getDefaultStatus(). The current status (of parent node)
| |
| ***Default Value: null
| |
| **$vers
| |
| **$paths
| |
| *Returns: boolean.<br/>true on sucess
| |
| ===processValues_boolean_single()===
| |
| Process the value of a configuration of type boolean and single valued
| |
| *Signature: protected function processValues_boolean_single($value,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===processValues_delimited_many()===
| |
| Process the value of a configuration of type delimited and many valued
| |
| *Signature: protected function processValues_delimited_many($valueList,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $valueList
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===processValues_delimited_single()===
| |
| Process the value of a configuration of type delimited and single valued
| |
| *Signature: protected function processValues_delimited_single($value,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===processValues_list_many()===
| |
| Process the value of a configuration of type list and many valued @param array $valueList
| |
| *Signature: protected function processValues_list_many($value,$status)
| |
| *Parameters:
| |
| **$value
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===processValues_list_single()===
| |
| Process the value of a configuration of type list and single valued
| |
| *Signature: protected function processValues_list_single($value,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===processValues_string_many()===
| |
| Process the value of a configuration of type string and many valued
| |
| *Signature: protected function processValues_string_many($valueList,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $valueList <br/>of string
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===processValues_string_single()===
| |
| Process the value of a configuration of type string and single valued
| |
| *Signature: protected function processValues_string_single($value,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===setConfigValues()===
| |
| Sets the config values from the magic data template @param string $version . Defaults to '0' . The version of the currently loaded data in $storage responsible for this XML @param array of string $paths -- the current path into the $storage that we are using. Defaults to the empty array().
| |
| *Signature: public function setConfigValues($config_group,$storage,$status,$vers,$paths)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $config_group <br/>DomNode of <configurationGroup>
| |
| ** [[Class: I2CE_MagicData | I2CE_MagicData]] $storage
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| **$vers
| |
| ***Default Value: '0'
| |
| **$paths
| |
| ***Default Value: array()
| |
| *Returns: boolean.<br/>Returns true on sucess. False if there was some data that needs to be set in the administration/configuration page.
| |
| ===traversePaths()===
| |
| *Signature: protected function traversePaths($storage,$paths)
| |
| *Parameters:
| |
| **$storage
| |
| **$paths
| |
| ===updateClassPath()===
| |
| Update the storage object with the classfile and default classpath. @param $storage I2CE_MagicDataNode @param $module string containing the short module name.
| |
| *Signature: protected function updateClassPath($storage,$module)
| |
| *Parameters:
| |
| **$storage
| |
| ***Default Value: NULL
| |
| **$module
| |
| ***Default Value: NULL
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>TRUE for success
| |
| ===updatePaths()===
| |
| Update the list of path elements in MagicData based on attributes of the element passed in: path Contents of this attribute specify an explicit path name If no path element is used then the contents of the name attribute are added to the path. @param $node DOMElement @param $paths array of strings
| |
| *Signature: protected function updatePaths($node,$paths)
| |
| *Parameters:
| |
| **$node
| |
| ***Default Value: NULL
| |
| **&$paths
| |
| ***Default Value: NULL
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>TRUE if no error.
| |
| ===validate()===
| |
| *Signature: public function validate()
| |
| ===validateValues_string_single()===
| |
| Valiedates the value of a configuration of type string and single valued
| |
| *Signature: protected function validateValues_string_single($value,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ==Fuzzy Methods==
| |
| ===processValues_color_triple_hex_single()===
| |
| This method is implemented by [[Class: I2CE_Module_ColorPicker#processValues_color_triple_hex_single() | I2CE_Module_ColorPicker->processValues_color_triple_hex_single() ]]
| |
| ===processValues_color_triple_hex_many()===
| |
| This method is implemented by [[Class: I2CE_Module_ColorPicker#processValues_color_triple_hex_many() | I2CE_Module_ColorPicker->processValues_color_triple_hex_many() ]]
| |
| ===processValues_color_triple_rgb_single()===
| |
| This method is implemented by [[Class: I2CE_Module_ColorPicker#processValues_color_triple_rgb_single() | I2CE_Module_ColorPicker->processValues_color_triple_rgb_single() ]]
| |
| ===processValues_color_triple_rgb_many()===
| |
| This method is implemented by [[Class: I2CE_Module_ColorPicker#processValues_color_triple_rgb_many() | I2CE_Module_ColorPicker->processValues_color_triple_rgb_many() ]]
| |
| ===processValues_color_hex_single()===
| |
| This method is implemented by [[Class: I2CE_Module_ColorPicker#processValues_color_hex_single() | I2CE_Module_ColorPicker->processValues_color_hex_single() ]]
| |
| ===processValues_color_hex_many()===
| |
| This method is implemented by [[Class: I2CE_Module_ColorPicker#processValues_color_hex_many() | I2CE_Module_ColorPicker->processValues_color_hex_many() ]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
