Class: I2CE DisplayData: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 18: | Line 18: | ||
*Signature: public function processDisplay($page) | *Signature: public function processDisplay($page) | ||
*Parameters: | *Parameters: | ||
*$page | **$page | ||
===processDisplayValue()=== | ===processDisplayValue()=== | ||
*Signature: static public function processDisplayValue($template,$node,$value,$name_set) | *Signature: static public function processDisplayValue($template,$node,$value,$name_set) | ||
*Parameters: | *Parameters: | ||
*$template | **$template | ||
*$node | **$node | ||
*$value | **$value | ||
*$name_set | **$name_set | ||
***Default Value: true | ***Default Value: true | ||
===selectOptions()=== | ===selectOptions()=== | ||
*Signature: static public function selectOptions($template,$node,$selected) | *Signature: static public function selectOptions($template,$node,$selected) | ||
*Parameters: | *Parameters: | ||
*$template | **$template | ||
*$node | **$node | ||
*$selected | **$selected | ||
===selectOptionsImmediate()=== | ===selectOptionsImmediate()=== | ||
Selects options | Selects options | ||
*Signature: public function selectOptionsImmediate($template,$name,$selected,$node) | *Signature: public function selectOptionsImmediate($template,$name,$selected,$node) | ||
*Parameters: | *Parameters: | ||
*$template | **$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.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/language.pseudo-types.php mixed ] $selected <br/>String or array of string, The selected values. | ||
| Line 46: | Line 46: | ||
*Signature: public function setDisplayData($template,$field,$value,$node) | *Signature: public function setDisplayData($template,$field,$value,$node) | ||
*Parameters: | *Parameters: | ||
*$template | **$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 ] $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/language.types.string.php string ] $value <br/>The value to replace the element with. | ||
| Line 55: | Line 55: | ||
*Signature: public function setDisplayDataImmediate($template,$name,$value,$node) | *Signature: public function setDisplayDataImmediate($template,$name,$value,$node) | ||
*Parameters: | *Parameters: | ||
*$template | **$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 ] $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/language.types.string.php string ] $value <br/>The value to replace the element with. | ||
| Line 89: | Line 89: | ||
*Signature: public function processDisplay($page) | *Signature: public function processDisplay($page) | ||
*Parameters: | *Parameters: | ||
*$page | **$page | ||
===processDisplayValue()=== | ===processDisplayValue()=== | ||
*Signature: static public function processDisplayValue($template,$node,$value,$name_set) | *Signature: static public function processDisplayValue($template,$node,$value,$name_set) | ||
*Parameters: | *Parameters: | ||
*$template | **$template | ||
*$node | **$node | ||
*$value | **$value | ||
*$name_set | **$name_set | ||
***Default Value: true | ***Default Value: true | ||
===selectOptions()=== | ===selectOptions()=== | ||
*Signature: static public function selectOptions($template,$node,$selected) | *Signature: static public function selectOptions($template,$node,$selected) | ||
*Parameters: | *Parameters: | ||
*$template | **$template | ||
*$node | **$node | ||
*$selected | **$selected | ||
===selectOptionsImmediate()=== | ===selectOptionsImmediate()=== | ||
Selects options | Selects options | ||
*Signature: public function selectOptionsImmediate($template,$name,$selected,$node) | *Signature: public function selectOptionsImmediate($template,$name,$selected,$node) | ||
*Parameters: | *Parameters: | ||
*$template | **$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.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/language.pseudo-types.php mixed ] $selected <br/>String or array of string, The selected values. | ||
| Line 117: | Line 117: | ||
*Signature: public function setDisplayData($template,$field,$value,$node) | *Signature: public function setDisplayData($template,$field,$value,$node) | ||
*Parameters: | *Parameters: | ||
*$template | **$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 ] $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/language.types.string.php string ] $value <br/>The value to replace the element with. | ||
| Line 126: | Line 126: | ||
*Signature: public function setDisplayDataImmediate($template,$name,$value,$node) | *Signature: public function setDisplayDataImmediate($template,$name,$value,$node) | ||
*Parameters: | *Parameters: | ||
*$template | **$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 ] $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/language.types.string.php string ] $value <br/>The value to replace the element with. | ||
Revision as of 13:07, 17 October 2009
The class I2CE_DisplayData contains 2 definitions:
- Definition in modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php
- Definition in modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php
modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php
This article desrcibes the class I2CE_DisplayData.
- Extends the class: I2CE_Module.
- Location: Part of the module template-data in the package I2CE
- Source: Defined in the file 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:
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:
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:
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()
modules/TemplateData/modules/DisplayData/I2CE_DisplayData.php
This article desrcibes the class I2CE_DisplayData.
- Extends the class: I2CE_Module.
- Location: Part of the module template-data in the package I2CE
- Source: Defined in the file 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:
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:
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:
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()
