Error_Log handler - part 2.

$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.

This example will show you how to handle html_progress errors both for display and file logging system. Such as used in development phase.

An error was volontary made on call of setAnimSpeed method (line 20). As it's an API error, default is to return error after it was raised, so lines below line 21 will be executed.

Error is also logged on 'progress2.log' (line 8) flat file type (line 14) which format look like apache logs (lines 7 to 13).

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

None, all default options are used. These options are :

error_handler : callback HTML_Progress::_errorHandler() [use PEAR_Error]
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 : '%1$s: %2$s %3$s'
handler/display/conf/contextFormat : ' in %3$s (file %1$s at line %2$s)'

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

[Top]

Output

Error: invalid input, parameter #1 "$delay" was expecting "less or equal 1000", instead got "10000" in html_progress::setanimspeed (file d:\php\pear\html_progress\examples\errorstack\secure\log_errors-p2.php at line 20)

Catch PEAR_Error

[pear_error: message="invalid input, parameter #1 "$delay" was expecting "less or equal 1000", instead got "10000"" code=-100 mode=return level=error prefix="" info="Array"]

Inside the progress2.log file:
127.0.0.1 [07/Aug/2004:14:04:36] - error - invalid input, parameter #1 "$delay" was expecting "less or equal 1000", instead got "10000" (context: Function="html_progress::setanimspeed" File="d:\php\pear\html_progress\examples\errorstack\secure\log_errors-p2.php" Line="20")

[Top]

PHP source syntax highlight

<?php 
require_once 'HTML/Progress.php';
 
ini_set('display_errors', true);  // in developement we may accept browser outputs
ini_set('log_errors', true);      // be sure to logs errors
 
$options = array(
    'destination' => 'progress2.log',
    'extra_headers' => '',
    'timeFormat' => '%d/%b/%Y:%H:%M:%S',
    'lineFormat' => '%2$s [%1$s] - %3$s - %4$s (context: %5$s)',
    'contextFormat' => 'Function="%3$s" File="%1$s" Line="%2$s"'
);
$logger['handler']['error_log'] = array('name' => HTML_PROGRESS_LOG_TYPE_FILE,
                                        'ident' => $_SERVER['REMOTE_ADDR'],
                                        'conf' => $options
                                        );
 
$bar = new HTML_Progress($logger);
$e = $bar->setAnimSpeed(10000);   // < - - - will generate an API error
 
if (is_object($e)) {
    if (is_a($e,'PEAR_Error')) {
        die('<h1>Catch PEAR_Error</h1>'.$e->toString());
    }
}
?>

[Top]