Class: I2CE MagicDataTemplate YAML

This article describes the class I2CE_MagicDataTemplate_YAML.

• Extends the class: I2CE_MagicDataTemplate.
• Parent Classses: I2CE_MagicDataTemplate I2CE_TemplateMeister I2CE_Fuzzy
• Location: Part of the module YAML_spyc in the package I2CE
• Source: Defined in the file 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:
  • 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.

• 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

• 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

• 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'

• 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'

• 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'

• 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'

• 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

• 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