|
|
| (16 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_MagicDataTemplate_YAML''.
| | #REDIRECT [[Class: I2CE_MagicDataTemplate_YAML (4.1.7)]] |
| *Extends the class: [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]].
| |
| *Parent Classses: [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]] [[Class: I2CE_TemplateMeister | I2CE_TemplateMeister]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *Location: Part of the module [[iHRIS Module List#YAML_spyc|YAML_spyc]] 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:/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_MagicDataTemplate_YAML
| |
| ==Variables==
| |
| ===$attributeConversion===
| |
| an array to conver attribbutes for yaml keys in a config data to DOMElement attributes
| |
| *Type: static protected static $attributeConversion
| |
| | |
| ===$optionalNodes===
| |
| an array to convert attribbutes for yaml keys in a config data to optional subnode of a DOMNode
| |
| *Type: static protected static $optionalNodes
| |
| | |
| ==Methods==
| |
| ===convertConfigDataArray()===
| |
| Converts configurationGroup data in an array to its DOM representation.
| |
| *Signature: protected function convertConfigDataArray($data,$name,$node,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $data <br/>The data for the current node
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name for the current node.
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>The parent node we wish to add onto node
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>The status of the parent node.
| |
| *Returns: booolean<br/>true on success
| |
| ===convertMetaDataArray()===
| |
| Converts the a metadata array to the metadata DOM node.
| |
| *Signature: protected function convertMetaDataArray($data)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $data <br/>for netadata
| |
| *Returns: boolean.<br/>true on sucess
| |
| ===loadFromYAMLArray()===
| |
| Load an array loaded from a YAML config file to the DOM Example of YAML config portion is in sample.yaml
| |
| *Signature: public function loadFromYAMLArray($data)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $data <br/>An array containing configuration data from a YAML config file
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>True on success
| |
| ===processYAML_status()===
| |
| Default processor for a YAML status key,value pair
| |
| *Signature: protected function processYAML_status($key,$val)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $key
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $val $returns mixed. string on success, the text content of the <status> node that should be created. false on failure
| |
| ===processYAML_status_list()===
| |
| Processor for a YAML status key,value pair where $key='list'
| |
| *Signature: protected function processYAML_status_list($key,$val)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $key
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $val $returns mixed. string on success, the text content of the <status> node that should be created. false on failure
| |
| ===processYAML_values_boolean()===
| |
| Process YAML config data where __type ='boolean'
| |
| *Signature: protected function processYAML_values_boolean($values,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $values <br/>The configdata for the key '__values'
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>The status of the configuration node
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>array on success containing each value of which will be the content of a <value> node, or false on failure
| |
| ===processYAML_values_delimited()===
| |
| Process YAML config data where __type ='delimited'
| |
| *Signature: protected function processYAML_values_delimited($values,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $values <br/>The configdata for the key '__values'
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>The status of the configuration node
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>array on success containing each value of which will be the content of a <value> node, or false on failure
| |
| ===processYAML_values_list()===
| |
| Process YAML config data where __type ='list'
| |
| *Signature: protected function processYAML_values_list($values,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $values <br/>The configdata for the key '__values'
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>The status of the configuration node
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>array on success containing each value of which will be the content of a <value> node, or false on failure
| |
| ===processYAML_values_string()===
| |
| Process YAML config data where __type ='string' or is not set
| |
| *Signature: protected function processYAML_values_string($values,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $values <br/>The configdata for the key '__values'
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>The status of the configuration node
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>array on success containing each value of which will be the content of a <value> node, or false on failure
| |
| ==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]]
| |
