Actions

Difference between revisions of "Display error messages and notices"

From Joomla! Documentation

(Success: prevent a notice)
m
 
(6 intermediate revisions by 4 users not shown)
Line 12: Line 12:
 
</source>
 
</source>
  
The second argument to the [[JApplication/enqueueMessage|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 <tt>jdoc:include</tt> statement in your template.  Place the following in your template at the location where you want messages to appear.
+
The second argument to the [http://api.joomla.org/11.4/Joomla-Platform/Application/JApplication.html#enqueueMessage 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 <tt>jdoc:include</tt> statement in your template.  Place the following in your template at the location where you want messages to appear.
 
<source lang="php">
 
<source lang="php">
 
<jdoc:include type="message" />
 
<jdoc:include type="message" />
Line 48: Line 48:
 
</source>
 
</source>
  
== Joomla! 3.x is bootstraped ==
+
== Joomla! 3.x is bootstrapped ==
Since Joomla! {{JVer|3.0}} will use bootstraped templates, 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://getbootstrap.com/2.3.2/components.html#alerts
  
 
The general syntax remains:
 
The general syntax remains:
  
 
<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
 
+
== Success ==
+
Note the new style in Joomla! 3 using the type '''success''' which is now used instead of the former "Message".
+
 
+
<div style="background-color: #dff0d8; color: #468847; border-top: 3px solid #468847; border-bottom: 3px solid #468847; padding-left: 1em; font-weight: bold;">
+
Success
+
</div>
+
 
+
<source lang="php">
+
JFactory::getApplication()->enqueueMessage('Success');
+
</source>
+
  
 
== See also ==
 
== See also ==
* [[JError]]
+
* [http://api.joomla.org/11.4/Joomla-Platform/Error/JError.html JError on api.joomla.org]
* [[JApplication]]
+
*  [http://api.joomla.org/11.4/Joomla-Platform/Application/JApplication.html JApplication on api.joomla.org]
*  [http://api.joomla.org/1.5/Joomla-Framework/Application/JApplication.html JApplication on api.joomla.org]
+
  
 
<noinclude>[[Category:Development]]</noinclude>
 
<noinclude>[[Category:Development]]</noinclude>
 
[[Category:Tutorials]][[Category:Component Development]]
 
[[Category:Tutorials]][[Category:Component Development]]

Latest revision as of 07:36, 20 June 2014

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 bootstrapped

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

See: http://getbootstrap.com/2.3.2/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