API15

JApplication/enqueueMessage: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 55: Line 55:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=enqueueMessage
  category=enqueueMessage
  category=JApplication
  category=JApplication
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 00:16, 25 March 2017

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

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

Code Examples