Class: I2CE MessageHandler (Development)

For other versions, see Class: I2CE_MessageHandler (versions) .

This article describes the class I2CE_MessageHandler .

• Extends the class: I2CE_Module.
• Location: Part of the module messageHandler in the package I2CE 4.0-dev
• Source: Defined in the file 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 i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 107
• Type: protected 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 i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 88
• 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()

• Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 31
• Signature: static public function getHooks()

getMethods()

• Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 40
• Signature: static public function getMethods()

handleMessages()

• Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 44
• Signature: public function handleMessages($page)
• Parameters:
  • $page

rollOverMessages()

• Defined in i2ce/modules/MessageHandler/I2CE_MessageHandler.php on line 69
• Signature: public function rollOverMessages()

Inherited Methods

__construct()

This public method is inherited from I2CE_Module->__construct()

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

action_initialize()

This public method is inherited from I2CE_Module->action_initialize()

getCLIHooks()

This public method is inherited from I2CE_Module->getCLIHooks()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

post_update()

This public method is inherited from I2CE_Module->post_update()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

upgrade()

This public method is inherited from I2CE_Module->upgrade()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

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()