v5:userguide:error_handling
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
userguide:error_handling [2015/10/16 20:39] – mnewnham | v5:userguide:error_handling [2016/02/01 23:32] – [Error Messages] mnewnham | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Error Handling | ====== Error Handling | ||
+ | |||
===== Default Behaviour ===== | ===== Default Behaviour ===== | ||
- | By default errors in the execution of SQL statements are handled by the database driver that is being accessed by PHP. No errors are normally handled and it is necessary to query the last error code to see if there has been an error. | + | By default, errors in the execution of SQL statements are handled by the database driver that is being accessed by PHP. No errors are normally handled and it is necessary to query the last error code to see if there has been an error. This is done by use of the ' |
- | ===== adodb-errorhandler | + | ===== PHP set_error_handler |
- | * | + | Once the PHP set_error_handler is used to override the default |
- | * adodb-exceptions.inc.php and adodb-errorhandler.inc.php | + | --------------------------------------- |
+ | <WRAP right box round> | ||
+ | == See Also == | ||
+ | [[v5: | ||
+ | </ | ||
+ | ===== adodb-errorhandler.inc.php | ||
+ | This file is designed to be copied off and customized for your own use. In it's simplest form, it can be used to emulate the ' | ||
- | ==== Standard Version ==== | + | <code php> |
+ | include ' | ||
+ | include ' | ||
- | ==== Customization | + | $db = newAdoConnection(' |
- | ADOdb supports PHP5 exceptions. Just include _adodb-exceptions.inc.php_ and you can now catch exceptions on errors as they occur. | + | $db-> |
+ | |||
+ | /* | ||
+ | * Invalid SQL statement will be trapped inside the custom errorhandling file | ||
+ | */ | ||
+ | $result | ||
+ | </ | ||
+ | |||
+ | ===== error_reporting ===== | ||
+ | The ADOdb error handler is not dependent on [[http:// | ||
<code php> | <code php> | ||
+ | function ADODB_Error_Handler($dbms, | ||
+ | { | ||
+ | |||
+ | /* | ||
+ | * Remark out this line to trap errors when error_reporting = 0 | ||
+ | */ | ||
+ | if (error_reporting() == 0) | ||
+ | return; // obey @ protocol | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | ===== Override Error Trap/Resume ===== | ||
+ | In certain circumstances, | ||
+ | |||
+ | <code php> | ||
+ | /** | ||
+ | * Traps errors and ignores them | ||
+ | */ | ||
+ | function ignoreErrorHandler() | ||
+ | { | ||
+ | return true; | ||
+ | } | ||
+ | |||
/* | /* | ||
- | * Connection | + | * In Oracle we have no 'if index exists' |
- | */ | + | * so if the index did not exist in the first place, it would throw an error |
- | include(" | + | * We want the error ignored, and for the program |
- | try { | + | */ |
- | | + | |
- | } catch (exception | + | $saveErrorFn = $db-> |
- | | + | $db-> |
- | adodb_backtrace($e->gettrace()); | + | set_error_handler(' |
- | } | + | |
+ | $db-> | ||
+ | |||
+ | /* | ||
+ | * Set the error handling back | ||
+ | */ | ||
+ | restore_error_handler(); | ||
+ | $db->raiseErrorFn = $saveErrorFn; | ||
</ | </ | ||
+ | ===== Combining With Custom Error Handling ===== | ||
+ | If you use '' | ||
- | ADOdb also provides two custom handlers which you can modify for your needs. The first one is in the **adodb-errorhandler.inc.php** file. This makes use of the standard PHP functions [[http:// | + | < |
+ | error_reporting(E_ALL); | ||
- | Including the above file will cause _trigger_error($errorstring,E_USER_ERROR)_ to be called when | + | function myErrorHandler($p1,$p2, |
- | (a) Connect() or PConnect() fails, or | + | { |
- | (b) a function that executes SQL statements such as Execute() or SelectLimit() has an error. | + | /* |
- | (c) GenID() appears to go into an infinite loop. | + | * Do some non-adodb handling |
+ | */ | ||
+ | return true; | ||
+ | } | ||
- | The $errorstring is generated by ADOdb and will contain useful debugging information similar to the error.log data generated below. This file adodb-errorhandler.inc.php should be included before you create any ADOConnection objects. | + | set_error_handler(' |
- | If you define error_reporting(0), | + | include ' |
+ | include ' | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ===== Exception Trapping ===== | ||
+ | ADOdb supports exception trapping using the '' | ||
<code php> | <code php> | ||
- | error_reporting(E_ALL); | ||
- | include(' | + | include ' |
- | include(' | + | include 'adodb-directory/ |
- | include(' | + | |
+ | try | ||
+ | { | ||
+ | $db = NewADOConnection(" | ||
+ | |||
+ | } | ||
+ | catch (exception $e) | ||
+ | { | ||
+ | var_dump($e); | ||
+ | adodb_backtrace($e-> | ||
+ | } | ||
- | $c = NewADOConnection(' | ||
- | $c-> | ||
- | $rs=$c-> | ||
- | if ($rs) | ||
- | rs2html($rs); | ||
</ | </ | ||
- | If you want to log the error message, you can do so by defining the following optional constants ADODB_ERROR_LOG_TYPE | + | ===== Logging Error Messages ===== |
+ | If you want to log the error message, you can do so by defining the following optional constants: | ||
+ | * ADODB_ERROR_LOG_TYPE | ||
+ | * ADODB_ERROR_LOG_DEST | ||
+ | |||
+ | ADODB_ERROR_LOG_TYPE is the error log message type (see [[http:// | ||
<code php> | <code php> | ||
Line 78: | Line 150: | ||
The following message will be logged in the error.log file: | The following message will be logged in the error.log file: | ||
- | 2001-10-28 14:20:38 mysql error: [1146: Table ' | + | 2001-10-28 14:20:38 mysql error: [1146: Table ' |
+ | | ||
===== PEAR_ERROR ===== | ===== PEAR_ERROR ===== | ||
Line 118: | Line 191: | ||
===== MetaError and MetaErrMsg ===== | ===== MetaError and MetaErrMsg ===== | ||
- | If you need error messages that work across multiple databases, then use [[reference: | + | If you need error messages that work across multiple databases, then use [[v5:reference:connection: |
===== Error Messages ===== | ===== Error Messages ===== | ||
- | Error messages are outputted using the static method ADOConnnection:: | + | Error messages are outputted using the static method |
+ | |||
+ | | ||
+ | |||
+ | By default, it sends the messages to the standard output. You can override this to perform error logging. |
v5/userguide/error_handling.txt · Last modified: 2018/06/27 16:18 by dregad