Class: I2CE DisplayData: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 15: | Line 15: | ||
*Signature: static public function getMethods() | *Signature: static public function getMethods() | ||
===processDisplay()=== | ===processDisplay()=== | ||
Process all display elements | 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. | ||
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) | *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 | ||
| Line 41: | Line 36: | ||
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. | ||
* [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 | ** [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 | ***Default Value: null | ||
===setDisplayData()=== | ===setDisplayData()=== | ||
Add a display element to the page. | 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. | ||
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) | *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. | ||
* [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 | ** [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 | ***Default Value: null | ||
===setDisplayDataImmediate()=== | ===setDisplayDataImmediate()=== | ||
Process processes display data immediately. | 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. | ||
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) | *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. | ||
* [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 | ** [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 | ***Default Value: null | ||
==Inherited Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
| Line 97: | Line 86: | ||
*Signature: static public function getMethods() | *Signature: static public function getMethods() | ||
===processDisplay()=== | ===processDisplay()=== | ||
Process all display elements | 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. | ||
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) | *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 | ||
| Line 123: | Line 107: | ||
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. | ||
* [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 | ** [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 | ***Default Value: null | ||
===setDisplayData()=== | ===setDisplayData()=== | ||
Add a display element to the page. | 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. | ||
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) | *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. | ||
* [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 | ** [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 | ***Default Value: null | ||
===setDisplayDataImmediate()=== | ===setDisplayDataImmediate()=== | ||
Process processes display data immediately. | 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. | ||
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) | *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. | ||
* [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 | ** [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 | ***Default Value: null | ||
==Inherited Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
Revision as of 22:40, 16 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:
- $template
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
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
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:
- $template
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
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
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()
