Class: I2CE MessageHandler: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the class ''I2CE_MessageHandler''.
This article desrcibes the class ''I2CE_MessageHandler''.
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Parent Classses:  [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Location: Part of the module [[iHRIS Module List#messageHandler|messageHandler]] in the package [https://launchpad.net/i2ce I2CE]
*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]
*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]

Revision as of 14:05, 17 October 2009

This article desrcibes the class I2CE_MessageHandler.

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 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.

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

conflict_external()

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

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

requirement_external()

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

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