Login   Register  
PHP Classes
elePHPant
Icontem

File: readme.1st

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Gyozo Papp  >  ErrorHandler  >  readme.1st  >  Download  
File: readme.1st
Role: License text
Content type: text/plain
Description: licence and changelog
Class: ErrorHandler
enhanced customizable error handler implementation
Author: By
Last change: update the CHANGELOG and TODO sections. Please vote and suggest what features you want to see in the next release.
Date: 12 years ago
Size: 7,105 bytes
 

Contents

Class file image Download
ErrorHandler information page
written by      : Gyozo Papp @: gerzson@php.net
VERSION-CTRL    : 2.0a5
last modified   : 2002.08.29.

--COPYRIGHT---------------------------------------------------------------------
ErrorHandler  Copyright by all of us
Permission to use, copy, modify, and distribute this software and
its documentation for any purpose, without fee, and without a written
agreement is hereby granted, provided that the above copyright notice
and this paragraph and the following two paragraphs appear in all copies.

IN NO EVENT SHALL i BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF
THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF i HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.

i SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS-IS" BASIS, AND i HAS NO OBLIGATIONS
TO PROVIDE MAINTAINANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
BUT i LIKE TO VERY MUCH.


--INFORMATIONS------------------------------------------------------------------
If you find ErrorHandler useful or even if you are not satisifed, then mail me!

I'm likely to improve this package, so it is recommended to visit the download
page to always get the newest version. I undertake to notify everyone, I'd
contacted with, about every new release. You can also subscribe to ErrorHandler
mailing list: errorhandler-subscribe@yahoogroups.com (few trtaffic)

About Documentation
I warmly appreciate if you could contribute to the documentaion with description
or example of usage, how-to's. Please note that the documentation is written in
DocBook format. If you are unfamiliar with it, you can write a plain text file,
too, I'll convert it.

All features tested on:
     + Debian (2.2) Apache 1.3.9  PHP 4.2.1 (client-side: NS 4.77, Opera 5.12)
     + SuSE  (7.3+) Apache 1.3.24 PHP 4.2.0 (client-side: Opera 6.0B2)


ErrorHandler works with 4.0.6. If you use older version of PHP, you must upgrade.
Konqueror (2.2.1) can not display the content of CONSOLE window, it is a known
issue, but I could not figure out why. Any suggestions?


--CHANGELOG---------------------------------------------------------------------
(2.0.0 will be released if I finish the documentation and fix open bugs.)
# + new documentation (in DocBook format)


2.0a5  CHANGES from version 2.0a4  (2002-08-29)
----------------------------------
 + lock(): capability of lock the actual settings at run-time (new)


2.0a4  CHANGES from version 2.0a2  (2002-05-30)
----------------------------------
(I don't know what changes had been made in 2.0a3, so it's an accummulative list)
 + LOGGING : log message contains
 + the default location of ErrorHandler.ini is the directory where the class
   resides
 + escaping '</' char sequences in JavaScript code like '<\/' 
   (Konqueror has still got problems to display the CONSOLE window)

2.0a2  CHANGES from version 2.0pre (2002-05-07)
----------------------------------
 + CONTEXT : more readable variable dumps
   `- string in quotes (array keys of type string, too)
   `- "key => value" format within arrays/objects
   `- prints a diagnostic message if no source available in strict mode.
bugfix:
 + 'level' setting from .ini file (Michael Monscheuer <michi@monscheuer.de>)

2.0pre  CHANGES from version 1.3.1 (2002-05-06)
----------------------------------
 + configuration settings read from an .ini file (new)
 + LOCKED directive to protect .ini settings     (new)
   `- useful in production sites
 + LOGGING encryption with user supplied callback(new)
 + SOURCE 'block' mode (in primitive experimental phase)
   `- only one-line control structures recognized
   `- no support for alternative syntax
 + CONSOLE window used always
   `- inline reports not supported
 + CONTEXT slightly improved variable search
   `- limited support to curly syntax and variable variables
 + CONTEXT truncates too long variables so as to avoid possible client crash
   `- the fix is so ugly as annoying the error is =:-|
 + CUSTOM became a callback function
 + extended capabilities with REPLACE page
   `- possibilty of redirection either on server or on client side
 + SILENT mode is totally independent from SILENT page
   `- SILENT page is now called REPLACE page.
 + customizable ADTL log
   `- per-file level dependency, unregistering

1.3.1 (2002-04-24)
-----
 + new escaping mechanism while generating CONSOLE window so not to break any JS
   code

1.3.0  CHANGES from version 1.2.1 (2002-04-18)
---------------------------------
 + restore() method        (new)
 + custom LOGGING facility (new)
 + "real" SILENCE facility (new) -- SILENT page is displayed only when
   the specified error occurs, otherwise errors is discarded "silently"

 + use crc32() instead of md5() in file registering
 + \ ' and " characters sometimes break the CONSOLE javascript code

1.2.1 (2002-03-06)
-----
bugfixes:
 + CUSTOM report: undefined variable (Leandro Lucarella <llucar@mecon.gov.ar>)
 + debug(): prevent undesired logging
 + _sprint_var(): undefined variable (Marq <barilley@noos.fr>)


1.2.0  CHANGES from version 1.1.0 (2002-02-??)
---------------------------------
 + DEBUG variable content (new)
 + ERROR TRAPPING (new)
CONTEXT report:
 + exclude sensitive variables such as passwords
 + more descriptive variable printouts

 + PHP version checking before instantiating ErrorHandler
 + Lookup_ErrorHandler() returns the variable name of ErrorHandler object

important notes:
- - - - - - - - 
 ! API changed: set_context()
 ! auxiliary.ErrorHandler.inc merged into oo.ErrorHandler.inc
 ! renamed main file: ErrorHandler.inc

1.1.0  CHANGES from version 1.0 (2002-01-22)
-------------------------------
 + multi target LOG report
 + The ability to define REPORT levels for each report layout independently. 
  CUSTOM, SOURCE, CONTEXT, LOGGING, SILENT (from the wish list)
 + Automatic Log-target Detection based on __FILE__ (from the wish list)
 + Lookup_ErrorHandler traverses $GLOBALS more safely
 + new PHP scope detection in SOURCE report (recognizing <% %>, <? ?> tags)
 + SOURCE, CONTEXT report layout has been changed a bit
 + CONSOLE report 
 (every output generated by ErrorHandler appears in a seperate new window)

 - SOURCE report while LOGGING are now enable on FATAL errors 
 (omitted in releases) if you really need this feature, contact me! 

--TODO--------------------------------------------------------------------------
 ! statements prepended with @ operator does invoke the errorhandler with 
   error-reporting level set to 0.
 ! MUCH MORE DOCUMENTATION
 ! SOURCE : more investigation to 'block' mode
 ! SESSION: incorporate EHTerminal conception
 ! LOGGING: accummulated error logging -- similar to CONSOLE window
   (messages are queued first, then sent in one "big" mail)