|
|
| (33 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'''which extends the class [[Class: I2CE_Module | I2CE_Module]]
| |
| It is contained in the module [[iHRIS Module List#template-data|template-data]] in the package [https://launchpad.net/i2ce I2CE]
| |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php]
| |
| @subpackage Core
| |
| @author Carl Leitner <litlfred@ibiblio.org>
| |
| @version 2.1
| |
| @access public
| |
| I2CE_DisplayData
| |
| @todo Better documentation
| |
| @package I2CE
| |
| ==Methods==
| |
| ===getHooks()===
| |
| *Signature: static public function getHooks()
| |
| ===getMethods()===
| |
| *Signature: static public function getMethods()
| |
| ===processDisplay()===
| |
| Process all display elements
| |
| | |
| This will go through the entire {@link 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 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'''which extends the class [[Class: I2CE_Module | I2CE_Module]]
| |
| It is contained in the module [[iHRIS Module List#template-data|template-data]] in the package [https://launchpad.net/i2ce I2CE]
| |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php]
| |
| @subpackage Core
| |
| @author Carl Leitner <litlfred@ibiblio.org>
| |
| @version 2.1
| |
| @access public
| |
| I2CE_DisplayData
| |
| @todo Better documentation
| |
| @package I2CE
| |
| ==Methods==
| |
| ===getHooks()===
| |
| *Signature: static public function getHooks()
| |
| ===getMethods()===
| |
| *Signature: static public function getMethods()
| |
| ===processDisplay()===
| |
| Process all display elements
| |
| | |
| This will go through the entire {@link 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 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]]
| |
