Class: I2CE MessageHandler: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''I2CE_MessageHandler''' | This article desrcibes the class '''I2CE_MessageHandler'''. | ||
*Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | |||
It is contained in the module [[iHRIS Module List#messageHandler|messageHandler]] in the package [https://launchpad.net/i2ce I2CE] | It is contained in the module [[iHRIS Module List#messageHandler|messageHandler]] in the package [https://launchpad.net/i2ce I2CE] | ||
| Line 19: | Line 20: | ||
*Signature: public function addUserMessage($obj,$msg,$class,$delayed) | *Signature: public function addUserMessage($obj,$msg,$class,$delayed) | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed] $obj<br/>The calling object. | * [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $obj<br/>The calling object. | ||
* [http://www.php.net/manual/en/language.types.string.php string] $msg<br/>The message | * [http://www.php.net/manual/en/language.types.string.php string ] $msg<br/>The message | ||
* [http://www.php.net/manual/en/language.types.string.php string] $class<br/>The message handler. Defaults to 'default' | * [http://www.php.net/manual/en/language.types.string.php string ] $class<br/>The message handler. Defaults to 'default' | ||
**Default Value: 'default' | **Default Value: 'default' | ||
*$delayed | *$delayed | ||
Revision as of 21:27, 16 October 2009
This article desrcibes the class I2CE_MessageHandler.
- Extends the class: I2CE_Module.
It is contained in the module messageHandler in the package I2CE
The class is defined in the file: modules/MessageHandler/I2CE_MessageHandler.php
- The module that is a basic message handler
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: Demo-v1.a
Variables
$immediate_messages
An array of arrays of strings index by the message class of messages that should be displayed on the current page.
- Type: protected y $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.
- Signature: public function addUserMessage($obj,$msg,$class,$delayed)
Parameters:
- mixed $obj
The calling object. - string $msg
The message - string $class
The message handler. Defaults to 'default'- Default Value: 'default'
- $delayed
- Default Value: true
getHooks()
- Signature: static public function getHooks()
getMethods()
- Signature: static public function getMethods()
handleMessages()
- Signature: public function handleMessages($page)
Parameters:
- $page
rollOverMessages()
- Signature: public function rollOverMessages()
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()
