PEAR
[ class tree: PEAR ] [ index: PEAR ] [ all elements ]

Class: PEAR_Error

Source Location: /PEAR-1.10.0dev2/PEAR.php

Class Overview


Standard PEAR error class for PHP 4


Author(s):

Version:

  • Release: 1.10.0dev2

Copyright:

  • 1997-2006 The PHP Group

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 831]
Standard PEAR error class for PHP 4

This class is supserseded by PEAR_Exception in PHP 5



[ Top ]


Class Variables

$backtrace =  null

[line 839]


Type:   mixed


[ Top ]

$code =  -1

[line 836]


Type:   mixed


[ Top ]

$error_message_prefix =  ''

[line 833]


Type:   mixed


[ Top ]

$level =  E_USER_NOTICE

[line 835]


Type:   mixed


[ Top ]

$message =  ''

[line 837]


Type:   mixed


[ Top ]

$mode =  PEAR_ERROR_RETURN

[line 834]


Type:   mixed


[ Top ]

$userinfo =  ''

[line 838]


Type:   mixed


[ Top ]



Method Detail

__construct (Constructor)   [line 861]

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

PEAR_Error constructor
  • Access: public

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

[ Top ]

addUserInfo   [line 1026]

void addUserInfo( $info)


Parameters:

   $info   — 

[ Top ]

getBacktrace   [line 1015]

array getBacktrace( [int $frame = null])

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

Parameters:

int   $frame   —  (optional) what frame to fetch

[ Top ]

getCallback   [line 947]

mixed getCallback( )

Get the callback function/method from an error object.
  • Return: callback function or object/method array
  • Access: public

[ Top ]

getCode   [line 969]

int getCode( )

Get error code from an error object
  • Return: error code
  • Access: public

[ Top ]

getDebugInfo   [line 1002]

string getDebugInfo( )

Get additional debug information supplied by the application.
  • Return: debug information
  • Access: public

[ Top ]

getMessage   [line 958]

string getMessage( )

Get the error message from an error object.
  • Return: full error message
  • Access: public

[ Top ]

getMode   [line 936]

int getMode( )

Get the error mode from an error object.
  • Return: error mode
  • Access: public

[ Top ]

getType   [line 980]

string getType( )

Get the name of this error/exception.
  • Return: error/exception name (type)
  • Access: public

[ Top ]

getUserInfo   [line 991]

string getUserInfo( )

Get additional user-supplied information.
  • Return: user-supplied information
  • Access: public

[ Top ]

toString   [line 1046]

string toString( )

Make a string representation of this object.
  • Return: a string with an object summary
  • Access: public

[ Top ]

__toString   [line 1035]

void __toString( )


[ Top ]


Documentation generated on Fri, 31 Jul 2015 09:30:24 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.