Class: I2CE Module TemplateData (4.0.12)

From IHRIS Wiki
Revision as of 10:42, 10 March 2011 by Litlfred (talk | contribs) (Created page with '{{otherversions|Class: I2CE_Module_TemplateData}} This article describes the class ''I2CE_Module_TemplateData'' . *Extends the class: [[Class: I2CE_Module (4.0.12) | I2CE_Module]…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE_Module_TemplateData (versions) .


This article describes the class I2CE_Module_TemplateData .

I2CE_Module_TemplateData

Variables

$data

An array which holds all data that is set realtive to a node. The key of the arrays are integers (counters) greater than or equal to -1. -1 holds the default values. for each type in: $data[-1][$type] For example, the default form is held at $data[-1]['FORM']
The indexing is as follows for counters >= 0 $data[$counter][$type][$name]['data'] $data[$counter][$type][$name]['nodes'] $type is the type of data, such as 'FORM' $name is the name of the data at 'data' we hold the actual data and at 'nodes' we hold an array of nodes at which the data is relative to.

$data_priorities

An array that holds information about optional propities for the data types

Methods

__construct()

Constructor

_ensureNode()

Ensure that a node is really a node. If it is not, hopes that it is an ID and then makes it the corresponding node

cleanupDataNodes()

ensureNode()

Ensure that a node is really a node. If it is not, hopes that it is an ID and then makes it the corresponding node

ensureNodeArray()

Ensure that a node is really a node. If it is not, hopes that it is an ID and then makes it the corresponding node

getData()

Get the data of the specified type and name that sits at or above the specifed node.

  • Defined in i2ce/modules/TemplateData/I2CE_Module_TemplateData.php on line 514
  • Signature: public function getData($template,$type,$name,$node,$all,$use_default)
  • Parameters:
    • $template
    • string $type
      The type of the data. E.g. 'FORM'
    • string $name
      The name of the data.
    • mixed $node
      Specfies the node at which the data is set. If $node is a DOMNode then it is the node. If null (default) then we search for data that applies to the whole. Otherwise $node should specify the ID of some node in the DOM.
    • boolean $all
      Defaults to false. Set to true to get all data of the specified type and name at the selected node. If false it gets the next unread piece of data on the list.
      • Default Value: false
    • boolean $use_default
      Set to true(default) if we should return the default data of the specified type if we did not find data of the specified type
      • Default Value: false

getDataByCounter()

getDataByNodeID()

getDataNames()

Returns the list of names registered for the specified data type

getDataWalkUpNodes()

getDefaultData()

returns the default data of the specified type

getHooks()

getMethods()

processDisplayData()

processPostponed()

Looks through the list of postponed nodes IDs to see if there is now a corresponding node in the DOM. If so, we clear the node ID from our list of postponed nodes and set the node to have the attribute I2CEDataNode with the appropripate counter value

removeData()

Remove the specified data

  • Defined in i2ce/modules/TemplateData/I2CE_Module_TemplateData.php on line 264
  • Signature: public function removeData($template,$type,$name,$nodes,$above_nodes)
  • Parameters:
    • $template
    • string $type
      the type of data
    • string $name
      the name of the data. if null it removes all the data of the specifed type
    • mixed $nodes
      Specfies the node(s) at which the data is removed. If $node is a DOMNode then it is the node. If null (default) then we search for data that applies to the whole. Otherwise $node should specify the ID of some node in the DOM. We will remove the data at all nodes that lie at or below the given node. Setting to false, means we dont check below any nodes. $param mixed $above_nodes. Defaults to null in which case no action is taken. Otherwise, if it is a DOMNode, or an id of one, or an arra of such things. we start check at that node and move up the DOM until we find the data we are looking for and then remove it. It can also be a DOMNodeList or an array of DOMNodes.
      • Default Value: null
    • $above_nodes
      • Default Value: null

setData()

Sets data relative to a node(s)

  • Defined in i2ce/modules/TemplateData/I2CE_Module_TemplateData.php on line 420
  • Signature: public function setData($template,$obj,$nodes,$type,$name,$overwrite)
  • Parameters:
    • $template
    • mixed $obj
      The data to set
    • mixed $nodes
      Specfies the node at which the data is set. If $node is a DOMNode then it is the node. If null then the data applies to the whole. Otherwise $node should specify the ID of some node in the DOM or a DOMNode. Also can be an array of string or DOMNode
    • string $type
      The type of the data. E.g. 'FORM'. For a form it defaults to $form->getName(), otherwise it defaults to null and throws an error if not set.
    • string $name
      The name of the data. Defaults to
      • Default Value:
    • boolean $overwrite
      Defaults to false. Set to true to overwrite any data of this particular name and type at the specifed node.
      Before where you would use addOption($selectID,$id,$value) you can now use setData(array('value'=>$id,'text'=>$value),$selectID,'OPTION') -- this should probably be a fuzzy method
      • Default Value: false

setDataTypePriority()

Set an optional priority for process data types

templateData()

Inherited Methods

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

action_initialize()

This public method is inherited from I2CE_Module->action_initialize()

getCLIHooks()

This public method is inherited from I2CE_Module->getCLIHooks()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

post_update()

This public method is inherited from I2CE_Module->post_update()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

upgrade()

This public method is inherited from I2CE_Module->upgrade()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Module->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Module->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Module->launchBackgroundPage()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Module_TemplateData_(4.0.12)&oldid=37269"