Class: I2CE MessageHandler: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 5: Line 5:


* The module that is a basic message handler
* The module that is a basic message handler
 
*Author: Carl Leitner <litlfred@ibiblio.org>
@package I2CE
*Since: Demo-v1.a
 
@access public
 
@author Carl Leitner <litlfred@ibiblio.org>
 
@since Demo-v1.a
 
@version Demo-v2.a
==Variables==
==Variables==
===$immediate_messages===
===$immediate_messages===

Revision as of 21:13, 16 October 2009

This article desrcibes the class I2CE_MessageHandler which 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()