Class: I2CE MagicDataTemplate YAML (4.1.6)

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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.6-release
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