Class: I2CE MessageHandler (Development): Difference between revisions
(Created page with '{{otherversions|Class: I2CE_MessageHandler}} This article describes the class ''I2CE_MessageHandler'' . *Extends the class: I2CE_Module. *L…') |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''I2CE_MessageHandler'' . | This article describes the class ''I2CE_MessageHandler'' . | ||
*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)#messageHandler|messageHandler]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#messageHandler|messageHandler]] 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/MessageHandler/I2CE_MessageHandler.php#L29 modules/MessageHandler/I2CE_MessageHandler.php] on line 29 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
*Since: Demo-v1.a | *Since: Demo-v1.a | ||
Line 10: | Line 10: | ||
===$immediate_messages=== | ===$immediate_messages=== | ||
An array of arrays of strings index by the message class of messages that should be displayed on the current page. | An array of arrays of strings index by the message class of messages that should be displayed on the current 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/MessageHandler/I2CE_MessageHandler.php#L108 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 108 | ||
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $immediate_messages | *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $immediate_messages | ||
Line 16: | Line 16: | ||
===addUserMessage()=== | ===addUserMessage()=== | ||
Adds a user message to the message handeler @param boolean $delated. Defaults to true. If falwe then we add it to the current page rather than wait for the next request. | Adds a user message to the message handeler @param boolean $delated. Defaults to true. If falwe then we add it to the current page rather than wait for the next request. | ||
*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/MessageHandler/I2CE_MessageHandler.php#L89 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 89 | ||
*Signature: public function addUserMessage($obj,$msg,$class,$delayed) | *Signature: public function addUserMessage($obj,$msg,$class,$delayed) | ||
*Parameters: | *Parameters: | ||
Line 26: | Line 26: | ||
***Default Value: true | ***Default Value: true | ||
===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/MessageHandler/I2CE_MessageHandler.php#L31 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 31 | ||
*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/MessageHandler/I2CE_MessageHandler.php#L40 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 40 | ||
*Signature: static public function getMethods() | *Signature: static public function getMethods() | ||
===handleMessages()=== | ===handleMessages()=== | ||
*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/MessageHandler/I2CE_MessageHandler.php#L44 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 44 | ||
*Signature: public function handleMessages($page) | *Signature: public function handleMessages($page) | ||
*Parameters: | *Parameters: | ||
**$page | **$page | ||
===rollOverMessages()=== | ===rollOverMessages()=== | ||
*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/MessageHandler/I2CE_MessageHandler.php#L70 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 70 | ||
*Signature: public function rollOverMessages() | *Signature: public function rollOverMessages() | ||
==Inherited Methods== | ==Inherited Methods== | ||
Line 54: | 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:15, 6 May 2015
This article describes the class I2CE_MessageHandler .
- Extends the class: I2CE_Module.
- Location: Part of the module messageHandler in the package I2CE 4.1-dev
- Source: Defined in the file modules/MessageHandler/I2CE_MessageHandler.php on line 29
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: Demo-v1.a
- The module that is a basic message handler
Variables
$immediate_messages
An array of arrays of strings index by the message class of messages that should be displayed on the current page.
- Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 108
- Type: protected array $immediate_messages
Methods
addUserMessage()
Adds a user message to the message handeler @param boolean $delated. Defaults to true. If falwe then we add it to the current page rather than wait for the next request.
- Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 89
- Signature: public function addUserMessage($obj,$msg,$class,$delayed)
- Parameters:
getHooks()
- Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 31
- Signature: static public function getHooks()
getMethods()
- Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 40
- Signature: static public function getMethods()
handleMessages()
- Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 44
- Signature: public function handleMessages($page)
- Parameters:
- $page
rollOverMessages()
- Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 70
- Signature: public function rollOverMessages()
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()