Class: I2CE MessageHandler: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 14: | Line 14: | ||
==Methods== | ==Methods== | ||
===addUserMessage()=== | ===addUserMessage()=== | ||
Adds a user message to the message handeler | 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. | ||
@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) | *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 | ||
**Default Value: true | ***Default Value: true | ||
===getHooks()=== | ===getHooks()=== | ||
*Signature: static public function getHooks() | *Signature: static public function getHooks() | ||
| Line 30: | Line 29: | ||
===handleMessages()=== | ===handleMessages()=== | ||
*Signature: public function handleMessages($page) | *Signature: public function handleMessages($page) | ||
Parameters: | *Parameters: | ||
*$page | *$page | ||
===rollOverMessages()=== | ===rollOverMessages()=== | ||
Revision as of 22:42, 16 October 2009
This article desrcibes the class I2CE_MessageHandler.
- Extends the class: I2CE_Module.
- Location: Part of the module messageHandler in the package I2CE
- Source: Defined in the file modules/MessageHandler/I2CE_MessageHandler.php
- 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.
- 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:
- $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()
