API15:JError/raise

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Create a new JException object given the passed arguments

Syntax

& raise($level, $code, $msg, $info=null, $backtrace=false)

Parameter Name	Default Value	Description
$level		$level The error level - use any of PHP's own error levels for this: E_ERROR, E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE.
$code		$code The application-internal error code for this error
$msg		$msg The error message, which may also be shown the user if need be.
$info	null	$info Optional: Additional error information (usually only developer-relevant information that the user should never see, like a database DSN).
$backtrace	false

Returns

mixed The object

Defined in

libraries/joomla/error/error.php

Importing

jimport( 'joomla.error.error' );

Source Body

function & raise($level, $code, $msg, $info = null, $backtrace = false)
{
        jimport('joomla.error.exception');
 
        // build error object
        $exception = new JException($msg, $code, $level, $info, $backtrace);
 
        // see what to do with this kind of error
        $handler = JError::getErrorHandling($level);
 
        $function = 'handle'.ucfirst($handler['mode']);
        if (is_callable(array('JError', $function))) {
                $reference =& JError::$function ($exception, (isset($handler['options'])) ? $handler['options'] : array());
        } else {
                // This is required to prevent a very unhelpful white-screen-of-death
                jexit(
                        'JError::raise -> Static method JError::' . $function . ' does not exist.' .
                        ' Contact a developer to debug' .
                        '<br /><strong>Error was</strong> ' .
                        '<br />' . $exception->getMessage()
                );
        }
 
        //store and return the error
        $GLOBALS['_JERROR_STACK'][] =& $reference;
        return $reference;
}

Examples

<CodeExamplesForm />