Class: I2CE MagicDataExport Template (Development)

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

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()