Class: I2CE MagicDataExport Template

From IHRIS Wiki
Revision as of 16:17, 16 October 2009 by Litlfred (talk | contribs)

This article desrcibes the class I2CE_MagicDataExport_Templatewhich extends the class I2CE_MagicDataTemplate It is contained in the module magicDataExport in the package I2CE The class is defined in the file: modules/MagicDataExport/I2CE_MagicDataExport_Template.php I2CE_MagicData_Export @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org> @version 2.1 @access public

Variables

$mainNode

The top level configurationGroup node

$metaNode

The metadata node

Methods

addTextToNode()

  • Signature: protected function addTextToNode($node,$nodeName,$text)

Parameters:

  • $node
  • $nodeName
  • $text

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

  • 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
    • 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. keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty, we export all keys

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

  • 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. keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty, we export all keys

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

  • Signature: public function createMetaDataNode($options)

Parameters:

  • array $options
    Has the following keys used to set the metadata: 'description','displayName', 'creator','email','link','version'.

humanText()

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

  • Signature: static public function humanText($text)
  • Returns: string

Parameters:

  • $text

setModule()

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

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

$merges

Theis protected variable is inherited from I2CE_MagicDataTemplate->$merges

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_MagicDataExport_Template&oldid=5223"