Display handler - part 1.

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

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 standard html_progress api exceptions.

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

If display_errors php.ini directive is ON, result is sent to browser. But as there is no error_log handler defined in html_progress (by default), even if log_errors is ON, no action will be taken.

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

Exception: invalid input, parameter #1 "$delay" was expecting "integer", instead got "string" in html_progress::setanimspeed (file d:\php\pear\html_progress\examples\errorstack\secure\display_errors-p1.php at line 5)

[Top]

PHP source syntax highlight

<?php 
require_once 'HTML/Progress.php';
 
$bar = new HTML_Progress();
$e = $bar->setAnimSpeed('100');   // < - - - will generate an API exception
 
echo 'code below will never be executed';
 
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>';
}
?>

[Top]