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

This example will show you how to ignore logging system for all html_progress errors. But we keep errors into stack.

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

As we've decided to use our own error handler (lines 4 thru 11, and 12), variable $e (line15) will contains NULL and no more a PEAR_Error object as default.

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 : '%1$s: %2$s %3$s'
handler/display/conf/contextFormat : ' in %3$s (file %1$s at line %2$s)'

Only option changed is :

error_handler : callback _errorHandler() [do not use PEAR_Error; no logs]

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

Array
(
    [code] => -100
    [params] => Array
        (
            [var] => $delay
            [was] => 10000
            [expected] => less or equal 1000
            [paramnum] => 1
        )

    [package] => HTML_Progress
    [level] => error
    [time] => 1091649873.02
    [context] => Array
        (
            [file] => d:\php\pear\html_progress\examples\errorstack\secure\display_errors-p3.php
            [line] => 15
            [function] => setanimspeed
            [class] => html_progress
            [type] => ->
            [args] => Array
                (
                    [0] => 10000
                )

        )

    [message] => invalid input, parameter #1 "$delay" was expecting "less or equal 1000", instead got "10000"
)

Catch HTML_Progress error

[Top]

PHP source syntax highlight

<?php 
require_once 'HTML/Progress.php';
 
function _errorHandler($err)
{
    /**
     * we don't want to manage progress error; 
     * none outputs (display, file, mail ...)
     */
    return;
}
$logger['error_handler'] = '_errorHandler';
 
$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());
    }
}
 
if ($bar->hasErrors()) {
    $err = $bar->getError();
    echo '<pre>';
    print_r($err);
    echo '</pre>';
    die('<h1>Catch HTML_Progress error</h1>');
}
echo 'End of process';
?>

[Top]