API15

JApplication/enqueueMessage

From Joomla! Documentation

< API15:JApplication
Revision as of 08:32, 12 May 2013 by JoomlaWikiBot (talk | contribs) (removing red link to edit, no existant pages)

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Enqueue a system message.

[<! removed edit link to red link >]

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

Syntax[edit]

enqueueMessage($msg, $type= 'message')
Parameter Name Default Value Description
$msg $msg The message to enqueue.
$type 'message' $type The message type.

Returns[edit]

void

Defined in[edit]

libraries/joomla/application/application.php

Importing[edit]

jimport( 'joomla.application.application' );

Source Body[edit]

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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

<CodeExamplesForm />