Back to CMSApplication class

Method getMessageQueue

public array
getMessageQueue
(mixed $clear = false)
Get the system message queue.
Parameters
  • bool $clear Clear the messages currently attached to the application object
Returns
  • array The system message queue.
Since
  • 3.2

Method getMessageQueue - Source code

/**
 * Get the system message queue.
 *
 * @param   boolean  $clear  Clear the messages currently attached to the application object
 *
 * @return  array  The system message queue.
 *
 * @since   3.2
 */
public function getMessageQueue($clear = false)
{
    // For empty queue, if messages exists in the session, enqueue them.
    if (!\count($this->messageQueue)) {
        $sessionQueue = $this->getSession()->get('application.queue', []);
        if ($sessionQueue) {
            $this->messageQueue = $sessionQueue;
            $this->getSession()->set('application.queue', []);
        }
    }
    $messageQueue = $this->messageQueue;
    if ($clear) {
        $this->messageQueue = array();
    }
    return $messageQueue;
}