|
|
| (24 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''I2CE_MessageHandler'''.
| | #REDIRECT [[Class: I2CE_MessageHandler (4.1.7)]] |
| *Extends the class: [[Class: I2CE_Module | I2CE_Module]].
| |
| *Location: Part of the module [[iHRIS Module List#messageHandler|messageHandler]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/MessageHandler/I2CE_MessageHandler.php 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:
| |
| * [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 ] $class<br/>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 [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
| |
| | |
| ===launchBackgroundPHPScript()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
| |
| | |
| ===launchBackgroundPage()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
| |
| | |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
