Class: I2CE MagicDataTemplate YAML (Development)

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

This article describes the class I2CE_MagicDataTemplate_YAML .

• Extends the class: I2CE_MagicDataTemplate.
• Location: Part of the module YAML_spyc in the package I2CE 4.1-dev
• Source: Defined in the file modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 29
• 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

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 79
• Type: static protected static $attributeConversion

$optionalNodes

an array to convert attribbutes for yaml keys in a config data to optional subnode of a DOMNode

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 84
• Type: static protected static $optionalNodes

Methods

convertConfigDataArray()

Converts configurationGroup data in an array to its DOM representation.

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 93
• Signature: protected function convertConfigDataArray($data,$name,$node,$status)
• Parameters:
  • array $data
    The data for the current node
  • string $name
    The name for the current node.
  • DOMNode $node
    The parent node we wish to add onto node
  • array $status
    The status of the parent node.
• Returns: booolean
  true on success

convertMetaDataArray()

Converts the a metadata array to the metadata DOM node.

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 374
• Signature: protected function convertMetaDataArray($data)
• Parameters:
  • array $data
    for netadata
• Returns: boolean.
  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

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 41
• Signature: public function loadFromYAMLArray($data)
• Parameters:
  • array $data
    An array containing configuration data from a YAML config file
• Returns: boolean
  True on success

processYAML_status()

Default processor for a YAML status key,value pair

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 228
• Signature: protected function processYAML_status($key,$val)
• Parameters:
  • string $key
  • 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'

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 206
• Signature: protected function processYAML_status_list($key,$val)
• Parameters:
  • string $key
  • 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'

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 322
• Signature: protected function processYAML_values_boolean($values,$status)
• Parameters:
  • mixed $values
    The configdata for the key '__values'
  • array $status
    The status of the configuration node
• Returns: mixed
  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'

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 280
• Signature: protected function processYAML_values_delimited($values,$status)
• Parameters:
  • mixed $values
    The configdata for the key '__values'
  • array $status
    The status of the configuration node
• Returns: mixed
  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'

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 299
• Signature: protected function processYAML_values_list($values,$status)
• Parameters:
  • mixed $values
    The configdata for the key '__values'
  • array $status
    The status of the configuration node
• Returns: mixed
  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

• Defined in i2ce/modules/YAML/lib/I2CE_MagicDataTemplate_YAML.php on line 250
• Signature: protected function processYAML_values_string($values,$status)
• Parameters:
  • mixed $values
    The configdata for the key '__values'
  • array $status
    The status of the configuration node
• Returns: mixed
  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 I2CE_MagicDataTemplate->__construct()

getConfigMetaData()

This public method is inherited from I2CE_MagicDataTemplate->getConfigMetaData()

getConfigurationTextContent()

This public method is inherited from I2CE_MagicDataTemplate->getConfigurationTextContent()

getDefaultStatus()

This public method is inherited from I2CE_MagicDataTemplate->getDefaultStatus()

getMerges()

This public method is inherited from I2CE_MagicDataTemplate->getMerges()

getTextContent()

This public method is inherited from I2CE_MagicDataTemplate->getTextContent()

processStatus()

This public method is inherited from I2CE_MagicDataTemplate->processStatus()

processValues()

This public method is inherited from I2CE_MagicDataTemplate->processValues()

setConfigValues()

This public method is inherited from I2CE_MagicDataTemplate->setConfigValues()

validate()

This public method is inherited from I2CE_MagicDataTemplate->validate()

getConfigPath()

This protected method is inherited from I2CE_MagicDataTemplate->getConfigPath()

processErasers()

This protected method is inherited from I2CE_MagicDataTemplate->processErasers()

processValues_boolean_single()

This protected method is inherited from I2CE_MagicDataTemplate->processValues_boolean_single()

processValues_delimited_many()

This protected method is inherited from I2CE_MagicDataTemplate->processValues_delimited_many()

processValues_delimited_single()

This protected method is inherited from I2CE_MagicDataTemplate->processValues_delimited_single()

processValues_list_many()

This protected method is inherited from I2CE_MagicDataTemplate->processValues_list_many()

processValues_list_single()

This protected method is inherited from I2CE_MagicDataTemplate->processValues_list_single()

processValues_string_many()

This protected method is inherited from I2CE_MagicDataTemplate->processValues_string_many()

processValues_string_single()

This protected method is inherited from I2CE_MagicDataTemplate->processValues_string_single()

setAttributeOnChildren()

This protected method is inherited from I2CE_MagicDataTemplate->setAttributeOnChildren()

traversePaths()

This protected method is inherited from I2CE_MagicDataTemplate->traversePaths()

updateMetaDataPaths()

This protected method is inherited from I2CE_MagicDataTemplate->updateMetaDataPaths()

updatePaths()

This protected method is inherited from I2CE_MagicDataTemplate->updatePaths()

validateValues_string_single()

This protected method is inherited from I2CE_MagicDataTemplate->validateValues_string_single()

addAnchorIdByName()

This public method is inherited from I2CE_TemplateMeister->addAnchorIdByName()

addFile()

This public method is inherited from I2CE_TemplateMeister->addFile()

addHeader()

This public method is inherited from I2CE_TemplateMeister->addHeader()

addText()

This public method is inherited from I2CE_TemplateMeister->addText()

addTextNode()

This public method is inherited from I2CE_TemplateMeister->addTextNode()

appendElementById()

This public method is inherited from I2CE_TemplateMeister->appendElementById()

appendElementByNode()

This public method is inherited from I2CE_TemplateMeister->appendElementByNode()

appendFileById()

This public method is inherited from I2CE_TemplateMeister->appendFileById()

appendFileByName()

This public method is inherited from I2CE_TemplateMeister->appendFileByName()

appendFileByNode()

This public method is inherited from I2CE_TemplateMeister->appendFileByNode()

appendNode()

This public method is inherited from I2CE_TemplateMeister->appendNode()

appendNodeById()

This public method is inherited from I2CE_TemplateMeister->appendNodeById()

appendNodeByName()

This public method is inherited from I2CE_TemplateMeister->appendNodeByName()

appendNodesByName()

This public method is inherited from I2CE_TemplateMeister->appendNodesByName()

appendTextById()

This public method is inherited from I2CE_TemplateMeister->appendTextById()

appendTextByName()

This public method is inherited from I2CE_TemplateMeister->appendTextByName()

changeAttributesOnNodes()

This public method is inherited from I2CE_TemplateMeister->changeAttributesOnNodes()

clearHeaders()

This public method is inherited from I2CE_TemplateMeister->clearHeaders()

createElement()

This public method is inherited from I2CE_TemplateMeister->createElement()

createTextNode()

This public method is inherited from I2CE_TemplateMeister->createTextNode()

evaluate()

This public method is inherited from I2CE_TemplateMeister->evaluate()

findAndRemoveNodes()

This public method is inherited from I2CE_TemplateMeister->findAndRemoveNodes()

findTemplate()

This public method is inherited from I2CE_TemplateMeister->findTemplate()

getDisplay()

This public method is inherited from I2CE_TemplateMeister->getDisplay()

getDoc()

This public method is inherited from I2CE_TemplateMeister->getDoc()

getElementById()

This public method is inherited from I2CE_TemplateMeister->getElementById()

getElementByName()

This public method is inherited from I2CE_TemplateMeister->getElementByName()

getElementByTagName()

This public method is inherited from I2CE_TemplateMeister->getElementByTagName()

getHeaders()

This public method is inherited from I2CE_TemplateMeister->getHeaders()

getUser()

This public method is inherited from I2CE_TemplateMeister->getUser()

importText()

This public method is inherited from I2CE_TemplateMeister->importText()

loadFile()

This public method is inherited from I2CE_TemplateMeister->loadFile()

loadRootFile()

This public method is inherited from I2CE_TemplateMeister->loadRootFile()

loadRootText()

This public method is inherited from I2CE_TemplateMeister->loadRootText()

prepareDisplay()

This public method is inherited from I2CE_TemplateMeister->prepareDisplay()

processArgs()

This public method is inherited from I2CE_TemplateMeister->processArgs()

query()

This public method is inherited from I2CE_TemplateMeister->query()

reIdNodes()

This public method is inherited from I2CE_TemplateMeister->reIdNodes()

removeNode()

This public method is inherited from I2CE_TemplateMeister->removeNode()

removeNodeById()

This public method is inherited from I2CE_TemplateMeister->removeNodeById()

renameNodes()

This public method is inherited from I2CE_TemplateMeister->renameNodes()

replaceNode()

This public method is inherited from I2CE_TemplateMeister->replaceNode()

setAttribute()

This public method is inherited from I2CE_TemplateMeister->setAttribute()

setLoadOptions()

This public method is inherited from I2CE_TemplateMeister->setLoadOptions()

setNodeAttribute()

This public method is inherited from I2CE_TemplateMeister->setNodeAttribute()

setUser()

This public method is inherited from I2CE_TemplateMeister->setUser()

setVerboseErrors()

This public method is inherited from I2CE_TemplateMeister->setVerboseErrors()

setWorkingDir()

This public method is inherited from I2CE_TemplateMeister->setWorkingDir()

xmlError()

This public method is inherited from I2CE_TemplateMeister->xmlError()

_loadFile()

This protected method is inherited from I2CE_TemplateMeister->_loadFile()

_loadText()

This protected method is inherited from I2CE_TemplateMeister->_loadText()

raiseError()

This protected method is inherited from I2CE_TemplateMeister->raiseError()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$merges

Theis protected variable is inherited from I2CE_MagicDataTemplate->$merges

$meta_config

Theis protected variable is inherited from I2CE_MagicDataTemplate->$meta_config

$doc

Theis public variable is inherited from I2CE_TemplateMeister->$doc

$xpath

Theis protected variable is inherited from I2CE_TemplateMeister->$xpath

$user

Theis protected variable is inherited from I2CE_TemplateMeister->$user

$working_dir

Theis protected variable is inherited from I2CE_TemplateMeister->$working_dir

$loadOptions

Theis protected variable is inherited from I2CE_TemplateMeister->$loadOptions

$headers

Theis protected variable is inherited from I2CE_TemplateMeister->$headers

$verboseErrors

Theis protected variable is inherited from I2CE_TemplateMeister->$verboseErrors

Inherited Fuzzy Methods

processValues_color_triple_hex_single()

This method is inherited from I2CE_MagicDataTemplate->processValues_color_triple_hex_single()

processValues_color_triple_hex_many()

This method is inherited from I2CE_MagicDataTemplate->processValues_color_triple_hex_many()

processValues_color_triple_rgb_single()

This method is inherited from I2CE_MagicDataTemplate->processValues_color_triple_rgb_single()

processValues_color_triple_rgb_many()

This method is inherited from I2CE_MagicDataTemplate->processValues_color_triple_rgb_many()

processValues_color_hex_single()

This method is inherited from I2CE_MagicDataTemplate->processValues_color_hex_single()

processValues_color_hex_many()

This method is inherited from I2CE_MagicDataTemplate->processValues_color_hex_many()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()