Difference between revisions of "Display error messages and notices"
From Joomla! Documentation
(Additions for J! 3.x, remove refs to PHP 4) |
(Typo..) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 6: | Line 6: | ||
// Add a message to the message queue | // Add a message to the message queue | ||
| − | $application->enqueueMessage(JText::_(' | + | $application->enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error'); |
/** Alternatively you may use chaining */ | /** Alternatively you may use chaining */ | ||
| − | JFactory::getApplication()->enqueueMessage(JText::_(' | + | JFactory::getApplication()->enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error'); |
</source> | </source> | ||
| Line 48: | Line 48: | ||
</source> | </source> | ||
| − | == Joomla! 3.x | + | == Joomla! 3.x is bootstraped == |
| − | Since Joomla! {{JVer|3.0}} will use | + | Since Joomla! {{JVer|3.0}} will use bootstraped templates, the messages will use the standard boostrap CSS styles for Alerts. |
See: http://twitter.github.com/bootstrap/components.html#alerts | See: http://twitter.github.com/bootstrap/components.html#alerts | ||
| Line 65: | Line 65: | ||
* 'error' - red | * 'error' - red | ||
* 'success' - green | * 'success' - green | ||
| + | |||
| + | == Success == | ||
| + | Note the new style in Joomla! 3 using the type '''success''' | ||
| + | |||
| + | <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', 'success'); | ||
| + | </source> | ||
== See also == | == See also == | ||
Revision as of 03:05, 12 September 2012
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[edit]
Message
JFactory::getApplication()->enqueueMessage('Message');Notice[edit]
Notice
JError::raiseNotice( 100, 'Notice' );Warning[edit]
Warning
JError::raiseWarning( 100, 'Warning' );Error[edit]
JError::raiseError( 4711, 'A severe error occurred' );Joomla! 3.x is bootstraped[edit]
Since Joomla! 
will use bootstraped templates, the messages will use the standard boostrap 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
- EMPTY - yellow
- 'info' - blue
- 'error' - red
- 'success' - green
Success[edit]
Note the new style in Joomla! 3 using the type success
Success
JFactory::getApplication()->enqueueMessage('Success', 'success');