BxDolInformer Class Reference

Inheritance diagram for BxDolInformer:

Public Member Functions
	__clone ()
	setEnabled ($bEnabled)
	add ($sId, $sMsg, $iType=BX_INFORMER_INFO)
	remove ($sId)
	get ($sId)

Static Public Member Functions
static	getInstance ($oTemplate=false)
Static Public Member Functions inherited from iBxDolSingleton
static	getInstance ()

Protected Member Functions
	__construct ()
	_addPermanentMessages ()

Protected Attributes
	$_bEnabled = true
	$_aMessages = array()

Detailed Description

Informer.

It displays alerts or information messages in clearly visible area on the page to let user know important information.

Example of usage

Adding message to informer:

$oInformer = BxDolInformer::getInstance(); // get object instance
if ($oInformer) // check if Informer is available for using
    echo $oInformer->add ('my_id', 'Some important information here', BX_INFORMER_ALERT); // add an alert message

Constructor & Destructor Documentation

__construct()

BxDolInformer::__construct ( )

protected

Constructor

Reimplemented from BxDolFactory.

Member Function Documentation

__clone()

BxDolInformer::__clone

(

)

Prevent cloning the instance

_addPermanentMessages()

BxDolInformer::_addPermanentMessages ( )

protected

Add permanent messages which are displayed on every page.

Hooks:

'system', 'informer_permament_messages' - hook on informer

• $unit_name - equals system
• $action - equals informer_permament_messages
• $object_id - label id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • informer - [object] object with informer

    HOOKS

    'system', 'informer_permament_messages' - hook on informer

add()

BxDolInformer::add	(		$sId,
			$sMsg,
			$iType = BX_INFORMER_INFO )

Add message to informer.

Parameters

$sId	- message id
$sMsg	- message text
$iType	- message type: BX_INFORMER_ALERT, BX_INFORMER_INFO or BX_INFORMER_ERROR

get()

BxDolInformer::get

(

$sId

)

Get message from informer.

Parameters

$sId	- message id

getInstance()

BxDolInformer::getInstance ( $oTemplate = false )

static

Get Informer object instance

Returns

object instance or false on error

remove()

BxDolInformer::remove

(

$sId

)

Remove message from informer.

Parameters

$sId	- message id

---

The documentation for this class was generated from the following file:

• inc/classes/BxDolInformer.php