Class: I2CE Template Options (Development): Difference between revisions
(Created page with '{{otherversions|Class: I2CE_Template_Options}} This article describes the class ''I2CE_Template_Options'' . *Extends the class: I2CE_Module…') |
No edit summary |
||
(One intermediate revision by one other user not shown) | |||
Line 2: | Line 2: | ||
This article describes the class ''I2CE_Template_Options'' . | This article describes the class ''I2CE_Template_Options'' . | ||
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]]. | *Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]]. | ||
*Location: Part of the module [[I2CE Module List (Development)#Options|Options]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#Options|Options]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Options/I2CE_Template_Options.php#L30 modules/TemplateData/modules/Options/I2CE_Template_Options.php] on line 30 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
I2CE_Template_Options @todo Better Documentation | I2CE_Template_Options @todo Better Documentation | ||
Line 9: | Line 9: | ||
===addOption()=== | ===addOption()=== | ||
Add option elements to the select node with the given id attribute. | Add option elements to the select node with the given id attribute. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Options/I2CE_Template_Options.php#L56 i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php] on line 56 | ||
*Signature: public function addOption($template,$selectID,$id,$value,$node) | *Signature: public function addOption($template,$selectID,$id,$value,$node) | ||
*Parameters: | *Parameters: | ||
Line 19: | Line 19: | ||
***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. @param string $value The display text that will be seen on the page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Options/I2CE_Template_Options.php#L74 i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php] on line 74 | ||
*Signature: public function addOptions($template,$selectID,$options | *Signature: public function addOptions($template,$selectID,$options,$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. | ||
**$node | **$node | ||
***Default Value: null | ***Default Value: null | ||
===getHooks()=== | ===getHooks()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Options/I2CE_Template_Options.php#L32 i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php] on line 32 | ||
*Signature: static public function getHooks() | *Signature: static public function getHooks() | ||
===getMethods()=== | ===getMethods()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Options/I2CE_Template_Options.php#L39 i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php] on line 39 | ||
*Signature: static public function getMethods() | *Signature: static public function getMethods() | ||
===processOptions()=== | ===processOptions()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/TemplateData/modules/Options/I2CE_Template_Options.php#L87 i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php] on line 87 | ||
*Signature: public function processOptions($page) | *Signature: public function processOptions($page) | ||
*Parameters: | *Parameters: | ||
Line 55: | Line 54: | ||
===action_initialize()=== | ===action_initialize()=== | ||
This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]] | This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]] | ||
===getCLIMethods()=== | ===getCLIMethods()=== |
Latest revision as of 08:20, 6 May 2015
This article describes the class I2CE_Template_Options .
- Extends the class: I2CE_Module.
- Location: Part of the module Options in the package I2CE 4.1-dev
- Source: Defined in the file modules/TemplateData/modules/Options/I2CE_Template_Options.php on line 30
- 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.
- Defined in i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php on line 56
- Signature: public function addOption($template,$selectID,$id,$value,$node)
- Parameters:
addOptions()
Add options elements to the select node with the given id attribute. @param string $value The display text that will be seen on the page.
- Defined in i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php on line 74
- Signature: public function addOptions($template,$selectID,$options,$node)
- Parameters:
getHooks()
- Defined in i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php on line 32
- Signature: static public function getHooks()
getMethods()
- Defined in i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php on line 39
- Signature: static public function getMethods()
processOptions()
- Defined in i2ce/modules/TemplateData/modules/Options/I2CE_Template_Options.php on line 87
- Signature: public function processOptions($page)
- Parameters:
- $page
Inherited Methods
__construct()
This public method is inherited from I2CE_Module->__construct()
action_configure()
This public method is inherited from I2CE_Module->action_configure()
action_disable()
This public method is inherited from I2CE_Module->action_disable()
action_enable()
This public method is inherited from I2CE_Module->action_enable()
action_initialize()
This public method is inherited from I2CE_Module->action_initialize()
getCLIMethods()
This public method is inherited from I2CE_Module->getCLIMethods()
getConfig()
This public method is inherited from I2CE_Module->getConfig()
post_update()
This public method is inherited from I2CE_Module->post_update()
pre_upgrade()
This public method is inherited from I2CE_Module->pre_upgrade()
upgrade()
This public method is inherited from I2CE_Module->upgrade()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
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()