Class: I2CE Template Options: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
*Definition in [[#modules/TemplateData/modules/Options/I2CE_Template_Options.php|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]] | ||
=modules/TemplateData/modules/Options/I2CE_Template_Options.php= | =modules/TemplateData/modules/Options/I2CE_Template_Options.php= | ||
This article desrcibes the class '''I2CE_Template_Options''' | This article desrcibes the class '''I2CE_Template_Options'''. | ||
*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] | It is contained in the module [[iHRIS Module List#template-data|template-data]] in the package [https://launchpad.net/i2ce I2CE] | ||
| Line 18: | Line 19: | ||
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 | * [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node | ||
**Default Value: null | **Default Value: null | ||
===addOptions()=== | ===addOptions()=== | ||
| Line 28: | Line 29: | ||
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 | ||
| Line 55: | Line 56: | ||
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]] | This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]] | ||
=modules/TemplateData/modules/Options/I2CE_Template_Options.php= | =modules/TemplateData/modules/Options/I2CE_Template_Options.php= | ||
This article desrcibes the class '''I2CE_Template_Options''' | This article desrcibes the class '''I2CE_Template_Options'''. | ||
*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] | It is contained in the module [[iHRIS Module List#template-data|template-data]] in the package [https://launchpad.net/i2ce I2CE] | ||
| Line 70: | Line 72: | ||
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 | * [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node | ||
**Default Value: null | **Default Value: null | ||
===addOptions()=== | ===addOptions()=== | ||
| Line 80: | Line 82: | ||
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 | ||
Revision as of 22:25, 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.
It is contained in the module template-data in the package I2CE
The class is defined in the file: modules/TemplateData/modules/Options/I2CE_Template_Options.php
@subpackage Core I2CE_Template_Options @todo Better Documentation
- Author: Carl Leitner <litlfred@ibiblio.org>
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
- mixed $selectID
a string, the node id, or a DOMNode - string $id
The code that will be the submitted value of the form element if selected. - string $value
The display text that will be seen on the page. - DOMNode $node
- Default Value: null
addOptions()
Add options elements to the select node with the given id attribute.
- Signature: public function addOptions($template,$selectID,$options,$value,$node)
Parameters:
- $template
- mixed $selectID
a string, the node id, or a DOMNode - array $options
An array where key will be the select id and values will be the select value. - string $value
The display text that will be seen on the page. - $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.
It is contained in the module template-data in the package I2CE
The class is defined in the file: modules/TemplateData/modules/Options/I2CE_Template_Options.php
@subpackage Core I2CE_Template_Options @todo Better Documentation
- Author: Carl Leitner <litlfred@ibiblio.org>
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
- mixed $selectID
a string, the node id, or a DOMNode - string $id
The code that will be the submitted value of the form element if selected. - string $value
The display text that will be seen on the page. - DOMNode $node
- Default Value: null
addOptions()
Add options elements to the select node with the given id attribute.
- Signature: public function addOptions($template,$selectID,$options,$value,$node)
Parameters:
- $template
- mixed $selectID
a string, the node id, or a DOMNode - array $options
An array where key will be the select id and values will be the select value. - string $value
The display text that will be seen on the page. - $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()
