Class: I2CE Template Options: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 13: | Line 13: | ||
Add option elements to the select node with the given id attribute. | Add option elements to the select node with the given id attribute. | ||
*Signature: public function addOption($template,$selectID,$id,$value,$node) | *Signature: public function addOption($template,$selectID,$id,$value,$node) | ||
Parameters: | *Parameters: | ||
*$template | *$template | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selectID<br/>a string, the node id, or a DOMNode | ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selectID <br/>a string, the node id, or a DOMNode | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $id<br/>The code that will be the submitted value of the form element if selected. | ** [http://www.php.net/manual/en/language.types.string.php string ] $id <br/>The code that will be the submitted value of the form element if selected. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $value<br/>The display text that will be seen on the page. | ** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The display text that will be seen on the page. | ||
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node | ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node | ||
**Default Value: null | ***Default Value: null | ||
===addOptions()=== | ===addOptions()=== | ||
Add options elements to the select node with the given id attribute. | Add options elements to the select node with the given id attribute. | ||
*Signature: public function addOptions($template,$selectID,$options,$value,$node) | *Signature: public function addOptions($template,$selectID,$options,$value,$node) | ||
Parameters: | *Parameters: | ||
*$template | *$template | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selectID<br/>a string, the node id, or a DOMNode | ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selectID <br/>a string, the node id, or a DOMNode | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $options<br/>An array where key will be the select id and values will be the select value. | ** [http://www.php.net/manual/en/language.types.array.php array ] $options <br/>An array where key will be the select id and values will be the select value. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $value<br/>The display text that will be seen on the page. | ** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The display text that will be seen on the page. | ||
*$node | *$node | ||
**Default Value: null | ***Default Value: null | ||
===getHooks()=== | ===getHooks()=== | ||
*Signature: static public function getHooks() | *Signature: static public function getHooks() | ||
| Line 36: | Line 36: | ||
===processOptions()=== | ===processOptions()=== | ||
*Signature: public function processOptions($page) | *Signature: public function processOptions($page) | ||
Parameters: | *Parameters: | ||
*$page | *$page | ||
| Line 62: | Line 62: | ||
Add option elements to the select node with the given id attribute. | Add option elements to the select node with the given id attribute. | ||
*Signature: public function addOption($template,$selectID,$id,$value,$node) | *Signature: public function addOption($template,$selectID,$id,$value,$node) | ||
Parameters: | *Parameters: | ||
*$template | *$template | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selectID<br/>a string, the node id, or a DOMNode | ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selectID <br/>a string, the node id, or a DOMNode | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $id<br/>The code that will be the submitted value of the form element if selected. | ** [http://www.php.net/manual/en/language.types.string.php string ] $id <br/>The code that will be the submitted value of the form element if selected. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $value<br/>The display text that will be seen on the page. | ** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The display text that will be seen on the page. | ||
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node | ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node | ||
**Default Value: null | ***Default Value: null | ||
===addOptions()=== | ===addOptions()=== | ||
Add options elements to the select node with the given id attribute. | Add options elements to the select node with the given id attribute. | ||
*Signature: public function addOptions($template,$selectID,$options,$value,$node) | *Signature: public function addOptions($template,$selectID,$options,$value,$node) | ||
Parameters: | *Parameters: | ||
*$template | *$template | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selectID<br/>a string, the node id, or a DOMNode | ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $selectID <br/>a string, the node id, or a DOMNode | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $options<br/>An array where key will be the select id and values will be the select value. | ** [http://www.php.net/manual/en/language.types.array.php array ] $options <br/>An array where key will be the select id and values will be the select value. | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $value<br/>The display text that will be seen on the page. | ** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The display text that will be seen on the page. | ||
*$node | *$node | ||
**Default Value: null | ***Default Value: null | ||
===getHooks()=== | ===getHooks()=== | ||
*Signature: static public function getHooks() | *Signature: static public function getHooks() | ||
| Line 85: | Line 85: | ||
===processOptions()=== | ===processOptions()=== | ||
*Signature: public function processOptions($page) | *Signature: public function processOptions($page) | ||
Parameters: | *Parameters: | ||
*$page | *$page | ||
Revision as of 23:40, 16 October 2009
The class I2CE_Template_Options contains 2 definitions:
- Definition in modules/TemplateData/modules/Options/I2CE_Template_Options.php
- Definition in modules/TemplateData/modules/Options/I2CE_Template_Options.php
modules/TemplateData/modules/Options/I2CE_Template_Options.php
This article desrcibes the class I2CE_Template_Options.
- Extends the class: I2CE_Module.
- Location: Part of the module template-data in the package I2CE
- Source: Defined in the file modules/TemplateData/modules/Options/I2CE_Template_Options.php
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Template_Options @todo Better Documentation
Methods
addOption()
Add option elements to the select node with the given id attribute.
- Signature: public function addOption($template,$selectID,$id,$value,$node)
- Parameters:
- $template
addOptions()
Add options elements to the select node with the given id attribute.
- Signature: public function addOptions($template,$selectID,$options,$value,$node)
- Parameters:
- $template
- $node
- Default Value: null
getHooks()
- Signature: static public function getHooks()
getMethods()
- Signature: static public function getMethods()
processOptions()
- Signature: public function processOptions($page)
- Parameters:
- $page
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/Options/I2CE_Template_Options.php
This article desrcibes the class I2CE_Template_Options.
- Extends the class: I2CE_Module.
- Location: Part of the module template-data in the package I2CE
- Source: Defined in the file modules/TemplateData/modules/Options/I2CE_Template_Options.php
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Template_Options @todo Better Documentation
Methods
addOption()
Add option elements to the select node with the given id attribute.
- Signature: public function addOption($template,$selectID,$id,$value,$node)
- Parameters:
- $template
addOptions()
Add options elements to the select node with the given id attribute.
- Signature: public function addOptions($template,$selectID,$options,$value,$node)
- Parameters:
- $template
- $node
- Default Value: null
getHooks()
- Signature: static public function getHooks()
getMethods()
- Signature: static public function getMethods()
processOptions()
- Signature: public function processOptions($page)
- Parameters:
- $page
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()
