|
|
| (20 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| The class I2CE_DisplayData contains 2 definitions:
| | #REDIRECT [[Class: I2CE_DisplayData (4.1.12)]] |
| *Definition in [[#modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php|modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php]]
| |
| *Definition in [[#modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php|modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php]]
| |
| =modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php=
| |
| This article desrcibes the class ''I2CE_DisplayData''.
| |
| *Extends the class: [[Class: I2CE_Module | I2CE_Module]].
| |
| *Location: Part of the module [[iHRIS Module List#template-data|template-data]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_DisplayData @todo Better documentation
| |
| ==Methods==
| |
| ===getHooks()===
| |
| *Signature: static public function getHooks()
| |
| ===getMethods()===
| |
| *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.
| |
| *Signature: public function processDisplay($page)
| |
| *Parameters:
| |
| **$page
| |
| ===processDisplayValue()===
| |
| *Signature: static public function processDisplayValue($template,$node,$value,$name_set)
| |
| *Parameters:
| |
| **$template
| |
| **$node
| |
| **$value
| |
| **$name_set
| |
| ***Default Value: true
| |
| ===selectOptions()===
| |
| *Signature: static public function selectOptions($template,$node,$selected)
| |
| *Parameters:
| |
| **$template
| |
| **$node
| |
| **$selected
| |
| ===selectOptionsImmediate()===
| |
| Selects options
| |
| *Signature: public function selectOptionsImmediate($template,$name,$selected,$node)
| |
| *Parameters:
| |
| **$template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name we are looking for
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selected <br/>String or array of string, The selected values.
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNOde ] $node <br/>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.
| |
| *Signature: public function setDisplayData($template,$field,$value,$node)
| |
| *Parameters:
| |
| **$template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $field <br/>The name attribute to match.
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The value to replace the element with.
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNOde ] $node <br/>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.
| |
| *Signature: public function setDisplayDataImmediate($template,$name,$value,$node)
| |
| *Parameters:
| |
| **$template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name attribute to match.
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The value to replace the element with.
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNOde ] $node <br/>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 [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
| |
| | |
| ===action_configure()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
| |
| | |
| ===action_disable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
| |
| | |
| ===action_enable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
| |
| | |
| ===action_initialize()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_initialize() | I2CE_Module->action_initialize()]]
| |
| | |
| ===conflict_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
| |
| | |
| ===getCLIHooks()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
| |
| | |
| ===getCLIMethods()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
| |
| | |
| ===getConfig()===
| |
| This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
| |
| | |
| ===post_update()===
| |
| This public method is inherited from [[Class: I2CE_Module#post_update() | I2CE_Module->post_update()]]
| |
| | |
| ===pre_upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#pre_upgrade() | I2CE_Module->pre_upgrade()]]
| |
| | |
| ===requirement_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
| |
| | |
| ===upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#upgrade() | I2CE_Module->upgrade()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===launchBackgroundProcess()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
| |
| | |
| ===launchBackgroundPHPScript()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
| |
| | |
| ===launchBackgroundPage()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
| |
| | |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| =modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php=
| |
| This article desrcibes the class ''I2CE_DisplayData''.
| |
| *Extends the class: [[Class: I2CE_Module | I2CE_Module]].
| |
| *Location: Part of the module [[iHRIS Module List#template-data|template-data]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_DisplayData @todo Better documentation
| |
| ==Methods==
| |
| ===getHooks()===
| |
| *Signature: static public function getHooks()
| |
| ===getMethods()===
| |
| *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.
| |
| *Signature: public function processDisplay($page)
| |
| *Parameters:
| |
| **$page
| |
| ===processDisplayValue()===
| |
| *Signature: static public function processDisplayValue($template,$node,$value,$name_set)
| |
| *Parameters:
| |
| **$template
| |
| **$node
| |
| **$value
| |
| **$name_set
| |
| ***Default Value: true
| |
| ===selectOptions()===
| |
| *Signature: static public function selectOptions($template,$node,$selected)
| |
| *Parameters:
| |
| **$template
| |
| **$node
| |
| **$selected
| |
| ===selectOptionsImmediate()===
| |
| Selects options
| |
| *Signature: public function selectOptionsImmediate($template,$name,$selected,$node)
| |
| *Parameters:
| |
| **$template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name we are looking for
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selected <br/>String or array of string, The selected values.
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNOde ] $node <br/>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.
| |
| *Signature: public function setDisplayData($template,$field,$value,$node)
| |
| *Parameters:
| |
| **$template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $field <br/>The name attribute to match.
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The value to replace the element with.
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNOde ] $node <br/>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.
| |
| *Signature: public function setDisplayDataImmediate($template,$name,$value,$node)
| |
| *Parameters:
| |
| **$template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name attribute to match.
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The value to replace the element with.
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNOde ] $node <br/>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 [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
| |
| | |
| ===action_configure()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
| |
| | |
| ===action_disable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
| |
| | |
| ===action_enable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
| |
| | |
| ===action_initialize()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_initialize() | I2CE_Module->action_initialize()]]
| |
| | |
| ===conflict_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
| |
| | |
| ===getCLIHooks()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
| |
| | |
| ===getCLIMethods()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
| |
| | |
| ===getConfig()===
| |
| This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
| |
| | |
| ===post_update()===
| |
| This public method is inherited from [[Class: I2CE_Module#post_update() | I2CE_Module->post_update()]]
| |
| | |
| ===pre_upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#pre_upgrade() | I2CE_Module->pre_upgrade()]]
| |
| | |
| ===requirement_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
| |
| | |
| ===upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#upgrade() | I2CE_Module->upgrade()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===launchBackgroundProcess()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
| |
| | |
| ===launchBackgroundPHPScript()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
| |
| | |
| ===launchBackgroundPage()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
| |
| | |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
