Class: I2CE DisplayData (4.0.3)

For other versions, see Class: I2CE_DisplayData (versions) .

This article describes the class I2CE_DisplayData .

• Extends the class: I2CE_Module.
• Location: Part of the module DisplayData in the package I2CE 4.0.3-release
• Source: Defined in the file modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 31
• Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_DisplayData @todo Better documentation

Methods

getHooks()

• Defined in i2ce/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 33
• Signature: static public function getHooks()

getMethods()

• Defined in i2ce/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 39
• Signature: static public function getMethods()

processDisplay()

Process all display elements This will go through the entire displayData array to replace any elements on the page that match the given name. Multiple matches will cycle through the values in the displayData array. If the element is an anchor tag then the value will be appended as name/value pairs to the href attribute.

• Defined in i2ce/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 298
• Signature: public function processDisplay($page)
• Parameters:
  • $page

processDisplayValue()

• Defined in i2ce/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 139
• Signature: static public function processDisplayValue($template,$node,$value,$name_set)
• Parameters:
  • $template
  • $node
  • $value
  • $name_set
    • Default Value: true

selectOptions()

• Defined in i2ce/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 125
• Signature: static public function selectOptions($template,$node,$selected)
• Parameters:
  • $template
  • $node
  • $selected

selectOptionsImmediate()

Selects options

• Defined in i2ce/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 100
• Signature: public function selectOptionsImmediate($template,$name,$selected,$node)
• Parameters:
  • $template
  • string $name
    The name we are looking for
  • mixed $selected
    String or array of string, The selected values.
  • DOMNOde $node
    Defaults to null meaning the whole page. Data is relative to this node
    • Default Value: null

setDisplayData()

Add a display element to the page. Mutiple entries with the same field name will be appended to an array so that multiple matches can be handled in order.

• Defined in i2ce/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 61
• Signature: public function setDisplayData($template,$field,$value,$node)
• Parameters:
  • $template
  • string $field
    The name attribute to match.
  • string $value
    The value to replace the element with.
  • DOMNOde $node
    Defaults to null meaning the whole page. Data is relative to this node
    • Default Value: null

setDisplayDataImmediate()

Process processes display data immediately. Mutiple entries with the same field name will be appended to an array so that multiple matches can be handled in order.

• Defined in i2ce/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php on line 78
• Signature: public function setDisplayDataImmediate($template,$name,$value,$node)
• Parameters:
  • $template
  • string $name
    The name attribute to match.
  • string $value
    The value to replace the element with.
  • DOMNOde $node
    Defaults to null meaning the whole page. Data is relative to this node
    • Default Value: null

Inherited Methods

__construct()

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

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