Docs For Class PEAR

Description

Standard PEAR error class for PHP 4

This class is supserseded by PEAR_Exception in PHP 5

link: http://pear.php.net/manual/en/core.pear.pear-error.php
see: PEAR::raiseError(), PEAR::throwError()
since: Class available since PHP 4.0.2
version: Release: 1.4.9
license: PHP License 3.0
author: Tomas V.V. Cox <cox@idecnet.com>
author: Stig Bakken <ssb@php.net>
copyright: 1997-2006 The PHP Group
author: Gregory Beaver <cellog@php.net>

Direct descendents

Class	Description
XML_Parser_Error	error class, replaces PEAR_Error

Variable Summary

mixed $backtrace

mixed $code

mixed $error_message_prefix

mixed $level

mixed $message

mixed $mode

mixed $userinfo

Method Summary

PEAR_Error PEAR_Error ([string $message = 'unknown error'], [int $code = null], [int $mode = null], [mixed $options = null], [string $userinfo = null])

void addUserInfo (mixed $info)

array getBacktrace ([int $frame = null])

mixed getCallback ()

int getCode ()

string getDebugInfo ()

string getMessage ()

int getMode ()

string getType ()

string getUserInfo ()

string toString ()

Variables

mixed $backtrace = null (line 826)

mixed $code = -1 (line 823)

mixed $error_message_prefix = '' (line 820)

Redefined in descendants as:

XML_Parser_Error::$error_message_prefix : prefix for all messages

mixed $level = E_USER_NOTICE (line 822)

mixed $message = '' (line 824)

mixed $mode = PEAR_ERROR_RETURN (line 821)

mixed $userinfo = '' (line 825)

Methods

Constructor PEAR_Error (line 851)

PEAR_Error constructor

access: public

PEAR_Error PEAR_Error ([string $message = 'unknown error'], [int $code = null], [int $mode = null], [mixed $options = null], [string $userinfo = null])

string $message: message
int $code: (optional) error code
int $mode: (optional) error mode, one of: PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER, PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION
mixed $options: (optional) error level, _OR_ in the case of PEAR_ERROR_CALLBACK, the callback function or object/method tuple.
string $userinfo: (optional) additional user/debug info

addUserInfo (line 1033)

void addUserInfo (mixed $info)

getBacktrace (line 1019)

Get the call backtrace from where the error was generated.

Supported with PHP 4.3.0 or newer.

return: Backtrace, or NULL if not available.
access: public

array getBacktrace ([int $frame = null])

int $frame: (optional) what frame to fetch

getCallback (line 932)

Get the callback function/method from an error object.

return: callback function or object/method array
access: public

mixed getCallback ()

getCode (line 961)

Get error code from an error object

return: error code
access: public

int getCode ()

getDebugInfo (line 1003)

Get additional debug information supplied by the application.

return: debug information
access: public

string getDebugInfo ()

getMessage (line 946)

Get the error message from an error object.

return: full error message
access: public

string getMessage ()

getMode (line 919)

Get the error mode from an error object.

return: error mode
access: public

int getMode ()

getType (line 975)

Get the name of this error/exception.

return: error/exception name (type)
access: public

string getType ()

getUserInfo (line 989)

Get additional user-supplied information.

return: user-supplied information
access: public

string getUserInfo ()

toString (line 1051)

Make a string representation of this object.

return: a string with an object summary
access: public

string toString ()