Class: I2CE MagicDataExport Template (4.1.7)

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_MagicDataExport_Template (versions) .

This article describes the class I2CE_MagicDataExport_Template .

Extends the class: I2CE_MagicDataTemplate.
Location: Part of the module magicDataExport in the package I2CE 4.1.7-release
Source: Defined in the file modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 30
Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_MagicData_Export

Variables

$mainNode

The top level configurationGroup node

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 37
Type: protected DOMNode $mainNode

$metaNode

The metadata node

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 43
Type: protected DOMNode $metaNode

Methods

addTextToNode()

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 67
Signature: protected function addTextToNode($node,$nodeName,$text,$binary,$encoding)
Parameters:
- $node
- $nodeName
- $text
- $binary
  - Default Value: false
- $encoding
  - Default Value: false

createExport()

Create an export node by appending on to the given configurationGroup node the values stored in the magic data. @param I2CE_MagicDataNode $conig. The data we wish to store at this node

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 262
Signature: public function createExport($configNode,$config,$pipe,$configType,$status)
Parameters:
- DOMNode $configNode
  A configurationGroup node.
- $config
- mixed $pipe
  A path component or an array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty or null, we export all keys. Defaults to empty array
  - Default Value: null
- string $configType
  Defaults to the empty string. The configuration type to give the configuration node.
  - Default Value:
- array $status
  An array of status options we should set for this configuration node. Defaults to the empty array
  - Default Value: array()

createExportNode()

Create an export node by appending on to the given configurationGroup node the values stored in the magic data at the specified $key.

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 237
Signature: public function createExportNode($configNode,$config,$pipe,$key,$configType,$status)
Parameters:
- DOMNode $configNode
  A configurationGroup node.
- I2CE_MagicDataNode $config
  The data we wish to store at this node
- array $pipe
  An array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty, we export all keys
- string $key
  The key. (Warning. It assumes it exists in the magic data!)
- string $configType
  Defaults to the empty string. The configuration type to give the configuration node.
- array $status
  An array of status options we should set for this configuration node. Defaults to the empty array

createExportNodeConfiguration()

Create an configuration node by appending on to the given configurationGroup node the values stored in the magic data at the specified $key. @param I2CE_MagicDataNode $conig. The data we wish to store at this node

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 184
Signature: public function createExportNodeConfiguration($configNode,$config,$key,$configType,$status)
Parameters:
- DOMNode $configNode
  A configurationGroup node.
- $config
- string $key
  The key. (Warning. It assumes it exists in the magic data!)
- string $configType
  Defaults to the empty string. The configuration type to give the configuration node.
- array $status
  An array of status options we should set for this configuration node. Defaults to the empty array

createExportNodeConfigurationGroup()

Create an configurationGroup node by appending on to the given configurationGroup node the values stored in the magic data at the specified $key.

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 154
Signature: public function createExportNodeConfigurationGroup($configNode,$config,$pipe,$key,$configType,$status)
Parameters:
- DOMNode $configNode
  A configurationGroup node.
- I2CE_MagicDataNode $config
  The data we wish to store at this node
- array $pipe
  An array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty, we export all keys
- string $key
  The key. (Warning. It assumes it exists in the magic data!)
- string $configType
  Defaults to the empty string. The configuration type to give the configuration node.
- array $status
  An array of status options we should set for this configuration node. Defaults to the empty array

createMetaDataNode()

Create the meta data node

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 106
Signature: public function createMetaDataNode($options)
Parameters:
- array $options
  Has the following keys used to set the metadata: 'description','displayName', 'creator','email','link','version'. We also have keys which 'requirement','enable','conflict','path' are themselves arrays containing the data needed to define them. Each entry of this array corresponds to a sepearte instnce of a node with the given name. This data is as in the following examples: 'requirement'=>array('I2CE'=>array('atLeast'=>4.3,'lessThan'=>2.2),'blah'=>array('greaterThan'=>4)), 'paths'=>array('templates'=>array('value'=>'./templates')), 'enable'=>array('brower'=>array(),'blah_module'=>array())

humanText()

Tries to turn a string (such as a magic data key) into human text @param $text

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 294
Signature: static public function humanText($text)
Parameters:
- $text
Returns: string

setModule()

Set the name of the module to be used for export.

Defined in i2ce/modules/MagicDataExport/I2CE_MagicDataExport_Template.php on line 51
Signature: public function setModule($module,$path)
Parameters:
- string $module
- string $path
  Defaults to null. If set, sets the path for the top level configuration group
  - Default Value: null