Inheritance diagram for PEAR_Error:

Collaboration diagram for PEAR_Error:

Public Member Functions
	__construct ($message='unknown error', $code=null, $mode=null, $options=null, $userinfo=null)
	PEAR_Error constructor. More...

	getMode ()
	Get the error mode from an error object. More...

	getCallback ()
	Get the callback function/method from an error object. More...

	getMessage ()
	Get the error message from an error object. More...

	getCode ()
	Get error code from an error object. More...

	getType ()
	Get the name of this error/exception. More...

	getUserInfo ()
	Get additional user-supplied information. More...

	getDebugInfo ()
	Get additional debug information supplied by the application. More...

	getBacktrace ($frame=null)
	Get the call backtrace from where the error was generated. More...

	addUserInfo ($info)

	__toString ()

	toString ()
	Make a string representation of this object. More...

Data Fields
	$error_message_prefix = ''

	$mode = PEAR_ERROR_RETURN

	$level = E_USER_NOTICE

	$code = -1

	$message = ''

	$userinfo = ''

	$backtrace = null

Detailed Description

Definition at line 830 of file PEAR.php.

Constructor & Destructor Documentation

◆ __construct()

PEAR_Error::__construct	(	$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 865 of file PEAR.php.

References $code, $format, $message, $options, PEAR\getStaticProperty(), PEAR_ERROR_CALLBACK, PEAR_ERROR_DIE, PEAR_ERROR_EXCEPTION, PEAR_ERROR_PRINT, PEAR_ERROR_RETURN, and PEAR_ERROR_TRIGGER.

     {
         if ($mode === null) {
             $mode = PEAR_ERROR_RETURN;
         }
         $this->message   = $message;
         $this->code      = $code;
         $this->mode      = $mode;
         $this->userinfo  = $userinfo;
         if (!PEAR::getStaticProperty('PEAR_Error', 'skiptrace')) {
             $this->backtrace = debug_backtrace();
             if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) {
                 unset($this->backtrace[0]['object']);
             }
         }
         if ($mode & PEAR_ERROR_CALLBACK) {
             $this->level = E_USER_NOTICE;
             $this->callback = $options;
         } else {
             if ($options === null) {
                 $options = E_USER_NOTICE;
             }
             $this->level = $options;
             $this->callback = null;
         }
         if ($this->mode & PEAR_ERROR_PRINT) {
             if (is_null($options) || is_int($options)) {
                 $format = "%s";
             } else {
                 $format = $options;
             }
             printf($format, $this->getMessage());
         }
         if ($this->mode & PEAR_ERROR_TRIGGER) {
             trigger_error($this->getMessage(), $this->level);
         }
         if ($this->mode & PEAR_ERROR_DIE) {
             $msg = $this->getMessage();
             if (is_null($options) || is_int($options)) {
                 $format = "%s";
                 if (substr($msg, -1) != "\n") {
                     $msg .= "\n";
                 }
             } else {
                 $format = $options;
             }
             die(sprintf($format, $msg));
         }
         if ($this->mode & PEAR_ERROR_CALLBACK) {
             if (is_callable($this->callback)) {
                 call_user_func($this->callback, $this);
             }
         }
         if ($this->mode & PEAR_ERROR_EXCEPTION) {
             trigger_error("PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions", E_USER_WARNING);
             $e = new Exception($this->message, $this->code);throw($e); // no eval() necessary to throw an exception
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

PEAR_Error::__toString ( )

Definition at line 1059 of file PEAR.php.

     {
         return $this->getMessage();
     }

◆ addUserInfo()

PEAR_Error::addUserInfo ( $info )

Definition at line 1048 of file PEAR.php.

References $info.

     {
         if (empty($this->userinfo)) {
             $this->userinfo = $info;
         } else {
             $this->userinfo .= " ** $info";
         }
     }

◆ getBacktrace()

PEAR_Error::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 1034 of file PEAR.php.

References defined.

     {
         if (defined('PEAR_IGNORE_BACKTRACE')) {
             return null;
         }
         if ($frame === null) {
             return $this->backtrace;
         }
         return $this->backtrace[$frame];
     }

◆ getCallback()

PEAR_Error::getCallback ( )

Get the callback function/method from an error object.

Returns: mixed callback function or object/method array public

Definition at line 947 of file PEAR.php.

                            {
         return $this->callback;
     }

◆ getCode()

PEAR_Error::getCode ( )

Get error code from an error object.

Returns: int error code public

Definition at line 976 of file PEAR.php.

References $code.

      {
         return $this->code;
      }

◆ getDebugInfo()

PEAR_Error::getDebugInfo ( )

Get additional debug information supplied by the application.

Returns: string debug information public

Definition at line 1018 of file PEAR.php.

     {
         return $this->getUserInfo();
     }

◆ getMessage()

PEAR_Error::getMessage ( )

Get the error message from an error object.

Returns: string full error message public

Definition at line 961 of file PEAR.php.

     {
         return ($this->error_message_prefix . $this->message);
     }

◆ getMode()

PEAR_Error::getMode ( )

Get the error mode from an error object.

Returns: int error mode public

Definition at line 934 of file PEAR.php.

                        {
         return $this->mode;
     }

◆ getType()

PEAR_Error::getType ( )

Get the name of this error/exception.

Returns: string error/exception name (type) public

Definition at line 990 of file PEAR.php.

     {
         return get_class($this);
     }

◆ getUserInfo()

PEAR_Error::getUserInfo ( )

Get additional user-supplied information.

Returns: string user-supplied information public

Definition at line 1004 of file PEAR.php.

     {
         return $this->userinfo;
     }

◆ toString()

PEAR_Error::toString ( )

Make a string representation of this object.

Returns: string a string with an object summary public

Definition at line 1072 of file PEAR.php.

References array, PEAR_ERROR_CALLBACK, PEAR_ERROR_DIE, PEAR_ERROR_PRINT, PEAR_ERROR_RETURN, and PEAR_ERROR_TRIGGER.

                         {
         $modes = array();
         $levels = array(E_USER_NOTICE  => 'notice',
                         E_USER_WARNING => 'warning',
                         E_USER_ERROR   => 'error');
         if ($this->mode & PEAR_ERROR_CALLBACK) {
             if (is_array($this->callback)) {
                 $callback = (is_object($this->callback[0]) ?
                     strtolower(get_class($this->callback[0])) :
                     $this->callback[0]) . '::' .
                     $this->callback[1];
             } else {
                 $callback = $this->callback;
             }
             return sprintf('[%s: message="%s" code=%d mode=callback '.
                            'callback=%s prefix="%s" info="%s"]',
                            strtolower(get_class($this)), $this->message, $this->code,
                            $callback, $this->error_message_prefix,
                            $this->userinfo);
         }
         if ($this->mode & PEAR_ERROR_PRINT) {
             $modes[] = 'print';
         }
         if ($this->mode & PEAR_ERROR_TRIGGER) {
             $modes[] = 'trigger';
         }
         if ($this->mode & PEAR_ERROR_DIE) {
             $modes[] = 'die';
         }
         if ($this->mode & PEAR_ERROR_RETURN) {
             $modes[] = 'return';
         }
         return sprintf('[%s: message="%s" code=%d mode=%s level=%s '.
                        'prefix="%s" info="%s"]',
                        strtolower(get_class($this)), $this->message, $this->code,
                        implode("|", $modes), $levels[$this->level],
                        $this->error_message_prefix,
                        $this->userinfo);
     }

Field Documentation

◆ $backtrace

PEAR_Error::$backtrace = null

Definition at line 840 of file PEAR.php.

◆ $code

PEAR_Error::$code = -1

Definition at line 837 of file PEAR.php.

◆ $error_message_prefix

PEAR_Error::$error_message_prefix = ''

Definition at line 834 of file PEAR.php.

◆ $level

PEAR_Error::$level = E_USER_NOTICE

Definition at line 836 of file PEAR.php.

◆ $message

PEAR_Error::$message = ''

Definition at line 838 of file PEAR.php.

◆ $mode

PEAR_Error::$mode = PEAR_ERROR_RETURN

Definition at line 835 of file PEAR.php.

◆ $userinfo

PEAR_Error::$userinfo = ''

Definition at line 839 of file PEAR.php.

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

Services/Database/lib/PEAR/PEAR.php

Public Member Functions

Data Fields