API15:JError/customErrorPage

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

Display a custom error page and exit gracefully

<! removed transcluded page call, red link never existed >

Syntax

customErrorPage(&$error)

Parameter Name	Default Value	Description
&$error		$error Exception object

Returns

void

Defined in

libraries/joomla/error/error.php

Importing

jimport( 'joomla.error.error' );

Source Body

function customErrorPage(& $error)
{
        // Initialize variables
        jimport('joomla.document.document');
        $app        = & JFactory::getApplication();
        $document       = & JDocument::getInstance('error');
        $config         = & JFactory::getConfig();

        //Get the current language direction
        $language = &JFactory::getLanguage();
        if ($language->isRTL()){
        $dir ="rtl";
        }
        else {
        $dir ="ltr";
        }

        // Get the current template from the application
        $template = $app->getTemplate();

        // Push the error object into the document
        $document->setError($error);

        @ob_end_clean();
        $document->setTitle(JText::_('Error').': '.$error->code);
        $document->setLanguage($language->getTag());
        $document->setDirection($dir);
        $data = $document->render(false, array (
                'template' => $template,
                'directory' => JPATH_THEMES,
                'debug' => $config->getValue('config.debug')
        ));

        JResponse::setBody($data);
        echo JResponse::toString();
        $app->close(0);
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />