API17

JError: Difference between revisions

From Joomla! Documentation

Doxiki2 (talk | contribs)
Bots
18,905 edits
Bulk upload by Doxiki2
 
m →See also: preparing for archive only
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
{{deprecated|when=1.5|from=2.5,11.1|old=JError|link=Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1|new=PHP exceptions instead}}__NOTOC__
<span class="editsection" style="font-size:76%;">
=={{JVer|11.1}} JError==
<nowiki>[</nowiki>[[Description:JError|Edit Descripton]]<nowiki>]</nowiki>
===Description===
</span>
[[JError]] is inspired in design and concept by patErrorManager [http://www.php-tools.net]. It is Joomla's Error Handling Class and should be used by third party developers to handle errors.
{{Description:JError}}
 
===Defined in===
===Note===
libraries/joomla/error/error.php
JError is deprecated use PHP exceptions instead
===Subpackage===
 
[[Subpackage Error/11.1|Error]]
===Extends===
===Extended by===
===Methods===
===Methods===
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
!Visibility
!Method name
!Method name
!Description
!Description
|-
|-
|[[JError::addToStack/11.1|addToStack]]
|public static
|[[API17:JError::addToStack|addToStack]]
|Method to add non-JError thrown JExceptions to the  stack for debugging purposes.  
|Method to add non-JError thrown JExceptions to the  stack for debugging purposes.  
|-
|-
|[[JError::attachHandler/11.1|attachHandler]]
|public static
|[[API17:JError::attachHandler|attachHandler]]
|Method that attaches the error handler to .  
|Method that attaches the error handler to .  
|-
|-
|[[JError::customErrorHandler/11.1|customErrorHandler]]
|public static
|[[API17:JError::customErrorHandler|customErrorHandler]]
|
|
|-
|-
|[[JError::customErrorPage/11.1|customErrorPage]]
|public static
|[[API17:JError::customErrorPage|customErrorPage]]
|Display a custom error page and exit gracefully.  
|Display a custom error page and exit gracefully.  
|-
|-
|[[JError::detachHandler/11.1|detachHandler]]
|public static
|[[API17:JError::detachHandler|detachHandler]]
|Method that detaches the error handler from .  
|Method that detaches the error handler from .  
|-
|-
|[[JError::getError/11.1|getError]]
|public static
|[[API17:JError::getError|getError]]
|Method for retrieving the last exception object in the error stack.  
|Method for retrieving the last exception object in the error stack.  
|-
|-
|[[JError::getErrorHandling/11.1|getErrorHandling]]
|public static
|[[API17:JError::getErrorHandling|getErrorHandling]]
|Method to get the current error handler settings for a specified error level.  
|Method to get the current error handler settings for a specified error level.  
|-
|-
|[[JError::getErrors/11.1|getErrors]]
|public static
|[[API17:JError::getErrors|getErrors]]
|Method for retrieving the exception stack.  
|Method for retrieving the exception stack.  
|-
|-
|[[JError::handleCallback/11.1|handleCallback]]
|public static
|[[API17:JError::handleCallback|handleCallback]]
|Callback error handler
|Callback error handler


|-
|-
|[[JError::handleDie/11.1|handleDie]]
|public static
|[[API17:JError::handleDie|handleDie]]
|Die error handler
|Die error handler


|-
|-
|[[JError::handleEcho/11.1|handleEcho]]
|public static
|[[API17:JError::handleEcho|handleEcho]]
|Echo error handler
|Echo error handler


|-
|-
|[[JError::handleIgnore/11.1|handleIgnore]]
|public static
|[[API17:JError::handleIgnore|handleIgnore]]
|Ignore error handler
|Ignore error handler


|-
|-
|[[JError::handleLog/11.1|handleLog]]
|public static
|[[API17:JError::handleLog|handleLog]]
|Log error handler
|Log error handler


|-
|-
|[[JError::handleMessage/11.1|handleMessage]]
|public static
|[[API17:JError::handleMessage|handleMessage]]
|Message error handler
|Message error handler


|-
|-
|[[JError::handleVerbose/11.1|handleVerbose]]
|public static
|[[API17:JError::handleVerbose|handleVerbose]]
|Verbose error handler
|Verbose error handler


|-
|-
|[[JError::isError/11.1|isError]]
|public static
|[[API17:JError::isError|isError]]
|Method to determine if a value is an exception object.  
|Method to determine if a value is an exception object.  
|-
|-
|[[JError::raise/11.1|raise]]
|public static
|[[API17:JError::raise|raise]]
|Create a new  object given the passed arguments.  
|Create a new  object given the passed arguments.  
|-
|-
|[[JError::raiseError/11.1|raiseError]]
|public static
|[[API17:JError::raiseError|raiseError]]
|Wrapper method for the  method with predefined error level of E_ERROR and backtrace set to true.  
|Wrapper method for the  method with predefined error level of E_ERROR and backtrace set to true.  
|-
|-
|[[JError::raiseNotice/11.1|raiseNotice]]
|public static
|[[API17:JError::raiseNotice|raiseNotice]]
|Wrapper method for the  method with predefined error level of E_NOTICE and backtrace set to false.  
|Wrapper method for the  method with predefined error level of E_NOTICE and backtrace set to false.  
|-
|-
|[[JError::raiseWarning/11.1|raiseWarning]]
|public static
|[[API17:JError::raiseWarning|raiseWarning]]
|Wrapper method for the  method with predefined error level of E_WARNING and backtrace set to false.  
|Wrapper method for the  method with predefined error level of E_WARNING and backtrace set to false.  
|-
|-
|[[JError::registerErrorLevel/11.1|registerErrorLevel]]
|public static
|[[API17:JError::registerErrorLevel|registerErrorLevel]]
|Method to register a new error level for handling errors.  
|Method to register a new error level for handling errors.  
|-
|-
|[[JError::renderBacktrace/11.1|renderBacktrace]]
|public static
|[[API17:JError::renderBacktrace|renderBacktrace]]
|
|
|-
|-
|[[JError::setErrorHandling/11.1|setErrorHandling]]
|public static
|[[API17:JError::setErrorHandling|setErrorHandling]]
|Method to set the way the  will handle different error levels.  
|Method to set the way the  will handle different error levels.  
|-
|-
|[[JError::throwError/11.1|throwError]]
|public static
|[[API17:JError::throwError|throwError]]
|
|
|-
|-
|[[JError::translateErrorLevel/11.1|translateErrorLevel]]
|public static
|[[API17:JError::translateErrorLevel|translateErrorLevel]]
|Translate an error level integer to a human readable string e.g.  
|Translate an error level integer to a human readable string e.g.  
|-
|-
|}
|}
* '''Defined in''' libraries/joomla/error/error.php
===Importing===
===Importing===
<source lang="php">jimport( 'joomla.error.error' );</source>
<source lang="php">jimport( 'joomla.error.error' );</source>
===See also===
===See also===
* [[JError|Other versions of this class]]
* {{JVer|11.1}} '''JError source code''' on [[jplatform:error/error.php|BitBucket]]
{{SeeAlso:JError}}
* {{JVer|11.1}} Subpackage [[API17:Subpackage Error|Error]]
<span class="editsection" style="font-size:76%;">
* [[API17:JError|Other versions of JError]]
<nowiki>[</nowiki>[[SeeAlso:JError|Edit See Also]]<nowiki>]</nowiki>
* [[Display_error_messages_and_notices|Display error messages and notices]]
</span>
 
===Examples===
 
<CodeExamplesForm />
===User contributed notes===
<dpl>
noresultsheader=\n
category=JError
category=CodeExample
category=ClassExample
include=*
format= ,,,
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JError]]</noinclude>

Latest revision as of 02:57, 25 March 2017

 This page's content makes references relevant only for Joomla! CMS Version(s) Joomla 1.5 and earlier  →
The use of "JError" has been deprecated from Joomla 2.5 Joomla 11.1 and later Versions, please use: PHP exceptions instead.

Joomla 11.1 JError

Description

JError is inspired in design and concept by patErrorManager [1]. It is Joomla's Error Handling Class and should be used by third party developers to handle errors.

Note

JError is deprecated use PHP exceptions instead

Methods

Visibility Method name Description
public static addToStack Method to add non-JError thrown JExceptions to the stack for debugging purposes.
public static attachHandler Method that attaches the error handler to .
public static customErrorHandler
public static customErrorPage Display a custom error page and exit gracefully.
public static detachHandler Method that detaches the error handler from .
public static getError Method for retrieving the last exception object in the error stack.
public static getErrorHandling Method to get the current error handler settings for a specified error level.
public static getErrors Method for retrieving the exception stack.
public static handleCallback Callback error handler
public static handleDie Die error handler
public static handleEcho Echo error handler
public static handleIgnore Ignore error handler
public static handleLog Log error handler
public static handleMessage Message error handler
public static handleVerbose Verbose error handler
public static isError Method to determine if a value is an exception object.
public static raise Create a new object given the passed arguments.
public static raiseError Wrapper method for the method with predefined error level of E_ERROR and backtrace set to true.
public static raiseNotice Wrapper method for the method with predefined error level of E_NOTICE and backtrace set to false.
public static raiseWarning Wrapper method for the method with predefined error level of E_WARNING and backtrace set to false.
public static registerErrorLevel Method to register a new error level for handling errors.
public static renderBacktrace
public static setErrorHandling Method to set the way the will handle different error levels.
public static throwError
public static translateErrorLevel Translate an error level integer to a human readable string e.g.
  • Defined in libraries/joomla/error/error.php

Importing

jimport( 'joomla.error.error' );

See also


User contributed notes

Retrieved from "https://docs.sandbox.joomla.org/index.php?title=API17:JError&oldid=384957"