Actions

Difference between revisions of "Display error messages and notices"

From Joomla! Documentation

(Additions for J! 3.x, remove refs to PHP 4)
(Update 3.0 to 3.x)
(6 intermediate revisions by 4 users not shown)
Line 6: Line 6:
  
 
// Add a message to the message queue
 
// Add a message to the message queue
$application->enqueueMessage(JText::_('SOME_ERROR_OCCURED'), 'error');
+
$application->enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error');
  
 
/** Alternatively you may use chaining */
 
/** Alternatively you may use chaining */
JFactory::getApplication()->enqueueMessage(JText::_('SOME_ERROR_OCCURED'), 'error');
+
JFactory::getApplication()->enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error');
 
</source>
 
</source>
  
Line 48: Line 48:
 
</source>
 
</source>
  
== Joomla! 3.x and the Bootstrap template ==
+
== Joomla! 3.x is bootstraped ==
Since Joomla! {{JVer|3.0}} will use the bootstrap template, the messages will use the standard boostrap css styles for Alerts.
+
Since Joomla! {{JVer|3.x}} uses bootstraped templates, the messages will use the standard bootstrap CSS styles for Alerts.
  
 
See: http://twitter.github.com/bootstrap/components.html#alerts
 
See: http://twitter.github.com/bootstrap/components.html#alerts
Line 56: Line 56:
  
 
<source lang="php">
 
<source lang="php">
JFactory::getApplication()->enqueueMessage('Your Message', 'type);
+
JFactory::getApplication()->enqueueMessage('Your Message', 'type');
 
</source>
 
</source>
  
 
Where '''type''' can be one of
 
Where '''type''' can be one of
  
* EMPTY - yellow
+
* 'warning' - yellow
* 'info' - blue
+
* 'notice' - blue
 
* 'error' - red
 
* 'error' - red
* 'success' - green
+
* 'message' (or empty) - green
  
 
== See also ==
 
== See also ==

Revision as of 04:34, 29 April 2013

Contents

Errors, warnings and notices can be displayed from any component, module, plugin or template using the methods outlined below.

// Get a handle to the Joomla! application object
$application = JFactory::getApplication();
 
// Add a message to the message queue
$application->enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error');
 
/** Alternatively you may use chaining */
JFactory::getApplication()->enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error');

The second argument to the enqueueMessage function is the type of the message. The default is 'message', but 'error' results in a different style for the message. The message will be displayed in place of a special jdoc:include statement in your template. Place the following in your template at the location where you want messages to appear.

<jdoc:include type="message" />

Message

Message

JFactory::getApplication()->enqueueMessage('Message');

Notice

Notice

JError::raiseNotice( 100, 'Notice' );

Warning

Warning

JError::raiseWarning( 100, 'Warning' );

Error

JError::raiseError( 4711, 'A severe error occurred' );

Joomla! 3.x is bootstraped

Since Joomla! Joomla 3.x uses bootstraped templates, the messages will use the standard bootstrap CSS styles for Alerts.

See: http://twitter.github.com/bootstrap/components.html#alerts

The general syntax remains:

JFactory::getApplication()->enqueueMessage('Your Message', 'type');

Where type can be one of

  • 'warning' - yellow
  • 'notice' - blue
  • 'error' - red
  • 'message' (or empty) - green

See also