PEAR_Error Class Reference

Inheritance diagram for PEAR_Error:

Public Member Functions
	PEAR_Error ($message= 'unknown error', $code=null, $mode=null, $options=null, $userinfo=null)
	getMode ()
	getCallback ()
	getMessage ()
	getCode ()
	getType ()
	getUserInfo ()
	getDebugInfo ()
	getBacktrace ($frame=null)
	addUserInfo ($info)
	__toString ()
	toString ()
Data Fields
	$error_message_prefix = ''
	$mode = PEAR_ERROR_RETURN
	$level = E_USER_NOTICE
	$code = -1
	$message = ''
	$userinfo = ''
	$backtrace = null

---

Detailed Description

Definition at line 826 of file PEAR.php.

---

Member Function Documentation

__toString

(

)

Definition at line 1055 of file PEAR.php.

addUserInfo

(

$

info

)

Definition at line 1044 of file PEAR.php.

getBacktrace

(

$

frame = null

)

Get the call backtrace from where the error was generated. Supported with PHP 4.3.0 or newer.

Parameters:

int

$frame

(optional) what frame to fetch

Returns:

array Backtrace, or NULL if not available. public

Definition at line 1030 of file PEAR.php.

getCallback

(

)

Get the callback function/method from an error object.

Returns:

mixed callback function or object/method array public

Definition at line 943 of file PEAR.php.

getCode

(

)

Get error code from an error object

Returns:

int error code public

Definition at line 972 of file PEAR.php.

getDebugInfo

(

)

Get additional debug information supplied by the application.

Returns:

string debug information public

Definition at line 1014 of file PEAR.php.

getMessage

(

)

Get the error message from an error object.

Returns:

string full error message public

Definition at line 957 of file PEAR.php.

getMode

(

)

Get the error mode from an error object.

Returns:

int error mode public

Definition at line 930 of file PEAR.php.

getType

(

)

Get the name of this error/exception.

Returns:

string error/exception name (type) public

Definition at line 986 of file PEAR.php.

getUserInfo

(

)

Get additional user-supplied information.

Returns:

string user-supplied information public

Definition at line 1000 of file PEAR.php.

PEAR_Error	(	$	message = 'unknown error',
		$	code = null,
		$	mode = null,
		$	options = null,
		$	userinfo = null
	)

PEAR_Error constructor

Parameters:

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

public

Definition at line 861 of file PEAR.php.

toString

(

)

Make a string representation of this object.

Returns:

string a string with an object summary public

Definition at line 1068 of file PEAR.php.

---

Field Documentation

$backtrace = null

Definition at line 836 of file PEAR.php.

$code = -1

Definition at line 833 of file PEAR.php.

$error_message_prefix = ''

Definition at line 830 of file PEAR.php.

$level = E_USER_NOTICE

Definition at line 832 of file PEAR.php.

$message = ''

Definition at line 834 of file PEAR.php.

$mode = PEAR_ERROR_RETURN

Definition at line 831 of file PEAR.php.

$userinfo = ''

Definition at line 835 of file PEAR.php.

---

The documentation for this class was generated from the following file:

• PEAR.php