API16:JApplication/enqueueMessage

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Enqueue a system message.

<! removed transcluded page call, red link never existed >

Syntax

enqueueMessage($msg, $type= 'message')

Parameter Name	Default Value	Description
$msg		$msg The message to enqueue.
$type	'message'	$type The message type.

Returns

void

Defined in

libraries/joomla/application/application.php

Importing

jimport( 'joomla.application.application' );

Source Body

public function enqueueMessage($msg, $type = 'message')
{
        // For empty queue, if messages exists in the session, enqueue them first.
        if (!count($this->_messageQueue))
        {
                $session = &JFactory::getSession();
                $sessionQueue = $session->get('application.queue');
                if (count($sessionQueue)) {
                        $this->_messageQueue = $sessionQueue;
                        $session->set('application.queue', null);
                }
        }
        // Enqueue the message.
        $this->_messageQueue[] = array('message' => $msg, 'type' => strtolower($type));
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />