|
|
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_MessageHandler''.
| | #REDIRECT [[Class: I2CE_MessageHandler (4.0.3)]] |
| *Extends the class: [[Class: I2CE_Module | I2CE_Module]].
| |
| *Location: Part of the module [[I2CE 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.2-release/annotate/head:/modules/MessageHandler/I2CE_MessageHandler.php#L29 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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/MessageHandler/I2CE_MessageHandler.php#L107 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 107
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php 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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/MessageHandler/I2CE_MessageHandler.php#L88 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 88
| |
| *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()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/MessageHandler/I2CE_MessageHandler.php#L31 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 31
| |
| *Signature: static public function getHooks()
| |
| ===getMethods()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/MessageHandler/I2CE_MessageHandler.php#L40 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 40
| |
| *Signature: static public function getMethods()
| |
| ===handleMessages()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/MessageHandler/I2CE_MessageHandler.php#L44 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 44
| |
| *Signature: public function handleMessages($page)
| |
| *Parameters:
| |
| **$page
| |
| ===rollOverMessages()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/MessageHandler/I2CE_MessageHandler.php#L69 i2ce/modules/MessageHandler/I2CE_MessageHandler.php] on line 69
| |
| *Signature: public function rollOverMessages()
| |
| ==Inherited Methods==
| |
| ===__construct()===
| |
| This public method is inherited from [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
| |
| | |
| ===action_configure()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
| |
| | |
| ===action_disable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
| |
| | |
| ===action_enable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
| |
| | |
| ===action_initialize()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_initialize() | I2CE_Module->action_initialize()]]
| |
| | |
| ===conflict_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
| |
| | |
| ===getCLIHooks()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
| |
| | |
| ===getCLIMethods()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
| |
| | |
| ===getConfig()===
| |
| This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
| |
| | |
| ===post_update()===
| |
| This public method is inherited from [[Class: I2CE_Module#post_update() | I2CE_Module->post_update()]]
| |
| | |
| ===pre_upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#pre_upgrade() | I2CE_Module->pre_upgrade()]]
| |
| | |
| ===requirement_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
| |
| | |
| ===upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#upgrade() | I2CE_Module->upgrade()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==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]]
| |
