Examples TOC examples

Error_Log handler - part 3.

$Date: 2004/08/07 14:28:59 $

Table of contents

Introduction
Render options
Ouput
PHP source syntax highlight

Introduction

This example requires :

PEAR::HTML_Progress 1.2.0 or better.
PEAR.
PEAR::DB
creation of a table (dump is at line 55 thru 64)

This example will show you how to handle html_progress errors with a dbms.

An error was volontary made on call of setAnimSpeed method (line 80). As it's an API error, default is to return error after it was raised, so lines below line 81 will be executed. Error is also logged into table 'log_table' of database 'test'.

We have defined (lines 4 to 44) a new user error handler for html_progress (line 77). In this handler, we will send error message on browser by using PEAR_Error (print mode) object (lines 11 to 16). We will also logged the same error content on a database (lines 18 to 41). DB account is defined on lines 49 to 53 (and only there).

display_errors

Print out errors (as a part of the output). For production web sites, you're strongly encouraged to turn this feature off, and use error logging instead. Keeping display_errors enabled on a production web site may reveal security information to end users, such as file paths on your Web server, your database schema or other information.

1	<?php ini_set('display_errors', false); ?>

log_errors

Log errors into a log file (server-specific log, stderr, syslog ...) As stated above, you're strongly advised to use error logging in place of error displaying on production web sites.

1	<?php ini_set('log_errors', true); ?>

Render options

Default options below are used :

message_callback : callback HTML_Progress::_msgCallback()
context_callback : callback HTML_Progress::_getBacktrace()
push_callback : callback HTML_Progress::_handleError() [log and die if error is an exception]
handler/display/conf/lineFormat : '<b>%1$s</b>: %2$s %3$s'
handler/display/conf/contextFormat : ' in <b>%3$s</b> (file <b>%1$s</b> at line <b>%2$s</b>)'

Only option changed is :

error_handler : callback _errorHandler() [use PEAR_Error as print driver]

Legend for lineFormat:

1$ = error level
2$ = message body
3$ = error context (class/method/file/line)

Legend for contextFormat:

1$ = filename
2$ = line number
3$ = class and method names

Output

HTML Progress Error : invalid input, parameter #1 "$delay" was expecting "less or equal 1000", instead got "10000"

Previous error has been recorded in database 'test', table 'log_table'

PHP source syntax highlight

<?php 
require_once 'HTML/Progress.php';
 
function _errorHandler($err)
{
    global $sql_handler;
    
    $display_errors = ini_get('display_errors');
    $log_errors = ini_get('log_errors');
    
    if ($display_errors) {
        include_once 'PEAR.php';
        $e = PEAR::raiseError($err['message'], $err['code'], 
                              PEAR_ERROR_PRINT, '<b>HTML Progress Error :</b> %s', 
                              $err['context']);
    }
 
    if ($log_errors) {
        include_once 'DB.php';
      
        $db = &DB::connect($sql_handler['conf']['dsn']);
        if (DB::isError($db)) {
            return $db;
        }
        $id = $db->nextId('log_id');
        $q = sprintf('insert into %s (id, logtime, ident, priority, message)' .
                     'values(%d, %d, %s, %s, %s)',
                     $sql_handler['name'], 
                     $id, 
                     $err['time'],
                     $db->quote($sql_handler['ident']),
                     $db->quote($err['level']),
                     $db->quote($err['message']));
 
        $result = $db->query($q);
        if (DB::isError($result)) {
            return $db;
        }
        
        $db->disconnect();
    }
 
    return $e;
}
 
ini_set('display_errors', true);  // in developement we may accept browser outputs
ini_set('log_errors', true);      // be sure to logs errors
 
$dbms     = 'mysql';     // your database management system
$db_user  = 'root';      // your database user account
$db_pass  = '****';      // your database user-password account
$db_name  = 'test';      // your database name
$db_table = 'log_table'; // your database log table 
 
/**
 * CREATE TABLE log_table (
 *  id          INT NOT NULL,
 *  logtime     INT NOT NULL,
 *  ident       CHAR(16) NOT NULL,
 *  priority    CHAR(12) NOT NULL,
 *  message     VARCHAR(200),
 *  PRIMARY KEY (id)
 * );
 */
 
$options = array(
    'dsn' => "$dbms://$db_user:$db_pass@/$db_name",
    'lineFormat' => '%4$s (context: %5$s)',
    'contextFormat' => 'Function="%3$s" File="%1$s" Line="%2$s"'
);
$sql_handler = array('name' => $db_table,
                     'ident' => 'HTML_Progress',
                     'conf' => $options
                     );
 
$logger['handler']['sql'] =& $sql_handler;
$logger['error_handler']  = '_errorHandler';
 
$bar = new HTML_Progress($logger);
$e = $bar->setAnimSpeed(10000);   // < - - - will generate an API error
 
if ($bar->hasErrors()) {
    $msg  = "<br/><hr/>";
    $msg .= "Previous error has been recorded in database '$db_name', table '$db_table'";
    die($msg);
}
?>