BxDolInformer Class Reference

Inheritance diagram for BxDolInformer:

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

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

Protected Member Functions
	__construct ()
	_addPermanentMessages ()

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

Member Function Documentation

__clone()

BxDolInformer::__clone

(

)

Prevent cloning the instance

_addPermanentMessages()

BxDolInformer::_addPermanentMessages ( )

protected

Add permanent messages which are displayed on every page.

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

static 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