Docs For Class atkMessageQueue

Home

Documentation home

Atk index

Docs For Class atkMessageQueue [ package: atk ]

Class: atkMessageQueue

Source Location: /utils/class.atkmessagequeue.inc

Class atkMessageQueue

Class Overview

This class implements the ATK message queue for showing messages at the top of a page.

Located in /utils/class.atkmessagequeue.inc [line 36]

Wiki documentation

Author(s):

Patrick van der Velden <patrick@ibuildings.nl>

Information Tags:

Methods

[ Top ]

Method Summary

static boolean	addMessage()	Add message to queue
static string	getMessage()	Get first message from queue and remove it
atkMessageQueue	atkMessageQueue()	Constructor
atkMessageQueue	&getInstance()	Retrieve the atkMessageQueue instance
array	getMessages()	Get all messages from queue and empty the queue
array	&getQueue()	Get the queue
boolean	_addMessage()	Add message to queue (private)
string	_getMessage()	Get first message from queue and remove it (private)
array	_getMessages()	Get all messages from queue and empty the queue (private)
string	_getTypeName()	Get the name of the message type

[ Top ]

Methods

static method addMessage [line 73]

static boolean addMessage(
string
$txt, [int
$type = AMQ_GENERAL] 
)

Add message to queue

Parameters:

string	$txt:
int	$type:

API Tags:

Return:

Success

[ Top ]

static method getMessage [line 117]

static string getMessage(
)

Get first message from queue and remove it

API Tags:

Return:

message

[ Top ]

Constructor atkMessageQueue [line 61]

atkMessageQueue atkMessageQueue(
)

Constructor

[ Top ]

getInstance [line 44]

atkMessageQueue &getInstance(
)

Retrieve the atkMessageQueue instance

API Tags:

Return:

The instance.

[ Top ]

getMessages [line 143]

array getMessages(
)

Get all messages from queue and empty the queue

API Tags:

Return:

messages

[ Top ]

getQueue [line 171]

array &getQueue(
)

Get the queue

API Tags:

Return:

The message queue

[ Top ]

_addMessage [line 104]

boolean _addMessage(
string
$txt, int
$type 
)

Add message to queue (private)

Parameters:

string	$txt:
int	$type:

API Tags:

Return:

Success

[ Top ]

_getMessage [line 132]

string _getMessage(
)

Get first message from queue and remove it (private)

API Tags:

Return:

message

[ Top ]

_getMessages [line 158]

array _getMessages(
)

Get all messages from queue and empty the queue (private)

API Tags:

Return:

messages

[ Top ]

_getTypeName [line 89]

string _getTypeName(
int
$type 
)

Get the name of the message type

Parameters:

int

$type:

The message type

API Tags:

Return:

The name of the message type

[ Top ]