Class: I2CE MagicDataTemplate (4.1.7)

From IHRIS Wiki
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 (versions) .


This article describes the class I2CE_MagicDataTemplate .

I2CE_MagicDataTemplate @todo Better documentation.

Variables

$merges

$var protected array $merges;

$meta_config

. The magic data node for the meta configuration. Gets set in the {@see getConfigMetaData()} call *

Methods

__construct()

I2CE_Template constructor method. This constructor sets up the basic variables for all I2CE_Template objects.

getConfigMetaData()

Gets the metadata of this config file in storage

getConfigPath()

Get the path to the current node in the configuration file. Used for error reporting. @param $node DOMElement

getConfigurationTextContent()

Get the value in the <value> tag of a subnode specfiied by the name attribute

  • Defined in i2ce/lib/I2CE_MagicDataTemplate.php on line 69
  • Signature: public function getConfigurationTextContent($nodeName,$node,$which)
  • Parameters:
    • string $nodeName
    • DOMNode $node
      The node we wish to search under. Defaults to null meaning we search from the top node.
      • Default Value: null
    • int $which
      Which result we want. Defaults to zero
      • Default Value: 0
  • Returns: mixed.
    Null on failure, a string (the content) on sucess

getDefaultStatus()

Get the default status variables.

getMerges()

Get the magic data paths whose status we are tracking. $retrurns array. Keys are paths values are the mergetype

getTextContent()

Get the text content of a node specified by its tag name

  • Defined in i2ce/lib/I2CE_MagicDataTemplate.php on line 49
  • Signature: public function getTextContent($name,$node,$which)
  • Parameters:
    • string $name
      the name of the node we wish to find the text content for
    • DOMNode $node
      The node we wish to search under. Defaults to null meaning we search from the top node.
      • Default Value: null
    • int $which
      Which result we want. Defaults to zero.
      • Default Value: 0
  • Returns: mixed
    string on sucess, null on failure

processErasers()

  • Defined in i2ce/lib/I2CE_MagicDataTemplate.php on line 832
  • Signature: protected function processErasers($node,$current_path)
  • Parameters:
    • $node
    • $current_path
      • Default Value: array()

processStatus()

Assumes that the template is valid. Set the status variables according to this node

  • Defined in i2ce/lib/I2CE_MagicDataTemplate.php on line 122
  • Signature: public function processStatus($configNode,$currentStatus,$vers)
  • Parameters:
    • DOMNode $configNode
      A configuration or conigurationGroup node
    • $currentStatus
      • Default Value: null
    • $vers
      • Default Value: '0'

processValues()

Process values for a config node @param I2CE_MagicDataNode $data @param string $version . Defaults to '0' . The version of the currently loaded data in $storage responsible for this XML @param array of string $paths -- the current path into the $storage that we are using. Defaults to the empty array().

  • Defined in i2ce/lib/I2CE_MagicDataTemplate.php on line 353
  • Signature: public function processValues($configNode,$storage,$status,$vers,$paths)
  • Parameters:
    • DOMNode $configNode
    • $storage
    • array $status
      If null, it defaults to the array set by getDefaultStatus(). The current status (of parent node)
      • Default Value: null
    • $vers
    • $paths
  • Returns: boolean.
    true on sucess

processValues_boolean_single()

Process the value of a configuration of type boolean and single valued

processValues_delimited_many()

Process the value of a configuration of type delimited and many valued

processValues_delimited_single()

Process the value of a configuration of type delimited and single valued

processValues_list_many()

Process the value of a configuration of type list and many valued @param array $valueList

processValues_list_single()

Process the value of a configuration of type list and single valued

processValues_string_many()

Process the value of a configuration of type string and many valued

processValues_string_single()

Process the value of a configuration of type string and single valued

setAttributeOnChildren()

  • Defined in i2ce/lib/I2CE_MagicDataTemplate.php on line 539
  • Signature: protected function setAttributeOnChildren($attr,$attr_val,$storage,$children)
  • Parameters:
    • $attr
    • $attr_val
    • $storage
    • $children

setConfigValues()

Sets the config values from the magic data template @param string $version . Defaults to '0' . The version of the currently loaded data in $storage responsible for this XML @param array of string $paths -- the current path into the $storage that we are using. Defaults to the empty array().

  • Defined in i2ce/lib/I2CE_MagicDataTemplate.php on line 253
  • Signature: public function setConfigValues($config_group,$storage,$status,$vers,$paths)
  • Parameters:
    • DOMNode $config_group
      DomNode of <configurationGroup>
    • I2CE_MagicData $storage
    • array $status
    • $vers
      • Default Value: '0'
    • $paths
      • Default Value: array()
  • Returns: boolean.
    Returns true on sucess. False if there was some data that needs to be set in the administration/configuration page.

traversePaths()

updateMetaDataPaths()

Update the storage object with the classfile and default classpath. @param $storage I2CE_MagicDataNode @param $module string containing the short module name.

updatePaths()

Update the list of path elements in MagicData based on attributes of the element passed in: path Contents of this attribute specify an explicit path name If no path element is used then the contents of the name attribute are added to the path. @param $node DOMElement @param $paths array of strings

  • Defined in i2ce/lib/I2CE_MagicDataTemplate.php on line 291
  • Signature: protected function updatePaths($node,$paths)
  • Parameters:
    • $node
      • Default Value: NULL
    • &$paths
      • Default Value: NULL
  • Returns: boolean
    TRUE if no error.

validate()

validateValues_string_single()

Valiedates the value of a configuration of type string and single valued

Inherited Methods

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

$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

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Fuzzy Methods

processValues_color_triple_hex_single()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_triple_hex_single()

processValues_color_triple_hex_many()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_triple_hex_many()

processValues_color_triple_rgb_single()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_triple_rgb_single()

processValues_color_triple_rgb_many()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_triple_rgb_many()

processValues_color_hex_single()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_hex_single()

processValues_color_hex_many()

This method is implemented by I2CE_Module_ColorPicker->processValues_color_hex_many()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_MagicDataTemplate_(4.1.7)&oldid=50105"