Inheritance diagram for PEAR_Error:

Collaboration diagram for PEAR_Error:

Public Member Functions
	PEAR_Error ($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 826 of file PEAR.php.

Member Function Documentation

◆ __toString()

PEAR_Error::__toString ( )

Definition at line 1055 of file PEAR.php.

    {
        return $this->getMessage();
    }

References getMessage().

Here is the call graph for this function:

◆ addUserInfo()

PEAR_Error::addUserInfo ( $info )

Definition at line 1044 of file PEAR.php.

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

References $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. @access public

Definition at line 1030 of file PEAR.php.

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

References $backtrace.

◆ getCallback()

PEAR_Error::getCallback ( )

Get the callback function/method from an error object.

Returns: mixed callback function or object/method array @access public

Definition at line 943 of file PEAR.php.

                           {
        return $this->callback;
    }

◆ getCode()

PEAR_Error::getCode ( )

Get error code from an error object.

Returns: int error code @access public

Definition at line 972 of file PEAR.php.

     {
        return $this->code;
     }

References $code.

◆ getDebugInfo()

PEAR_Error::getDebugInfo ( )

Get additional debug information supplied by the application.

Returns: string debug information @access public

Definition at line 1014 of file PEAR.php.

    {
        return $this->getUserInfo();
    }

References getUserInfo().

Here is the call graph for this function:

◆ getMessage()

PEAR_Error::getMessage ( )

Get the error message from an error object.

Returns: string full error message @access public

Definition at line 957 of file PEAR.php.

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

Referenced by __toString(), and PEAR_Error().

Here is the caller graph for this function:

◆ getMode()

PEAR_Error::getMode ( )

Get the error mode from an error object.

Returns: int error mode @access public

Definition at line 930 of file PEAR.php.

                       {
        return $this->mode;
    }

References $mode.

◆ getType()

PEAR_Error::getType ( )

Get the name of this error/exception.

Returns: string error/exception name (type) @access public

Definition at line 986 of file PEAR.php.

    {
        return get_class($this);
    }

◆ getUserInfo()

PEAR_Error::getUserInfo ( )

Get additional user-supplied information.

Returns: string user-supplied information @access public

Definition at line 1000 of file PEAR.php.

    {
        return $this->userinfo;
    }

References $userinfo.

Referenced by getDebugInfo().

Here is the caller graph for this function:

◆ PEAR_Error()

PEAR_Error::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

@access public

Definition at line 861 of file PEAR.php.

    {
        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
        }
    }

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

Referenced by IT_Error\IT_Error(), and MDB2_Error\MDB2_Error().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

PEAR_Error::toString ( )

Make a string representation of this object.

Returns: string a string with an object summary @access public

Definition at line 1068 of file PEAR.php.

                        {
        $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);
    }

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

Field Documentation

◆ $backtrace

PEAR_Error::$backtrace = null

Definition at line 836 of file PEAR.php.

Referenced by getBacktrace().

◆ $code

PEAR_Error::$code = -1

Definition at line 833 of file PEAR.php.

Referenced by getCode(), ilBMFFault\getFault(), MDB2_Error\MDB2_Error(), and PEAR_Error().

◆ $error_message_prefix

PEAR_Error::$error_message_prefix = ''

Definition at line 830 of file PEAR.php.

Referenced by ilBMFFault\getActor(), and ilBMFFault\getFault().

◆ $level

PEAR_Error::$level = E_USER_NOTICE

Definition at line 832 of file PEAR.php.

Referenced by MDB2_Error\MDB2_Error().

◆ $message

PEAR_Error::$message = ''

Definition at line 834 of file PEAR.php.

Referenced by ilBMFFault\getFault(), and PEAR_Error().

◆ $mode

PEAR_Error::$mode = PEAR_ERROR_RETURN

Definition at line 831 of file PEAR.php.

Referenced by getMode(), ilBMFFault\ilBMFFault(), MDB2_Error\MDB2_Error(), and PEAR_Error().

◆ $userinfo

PEAR_Error::$userinfo = ''

Definition at line 835 of file PEAR.php.

Referenced by ilBMFFault\getDetail(), ilBMFFault\getFault(), getUserInfo(), and PEAR_Error().

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

Services/PEAR/lib/PEAR.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ __toString()

◆ addUserInfo()

◆ getBacktrace()

◆ getCallback()

◆ getCode()

◆ getDebugInfo()

◆ getMessage()

◆ getMode()

◆ getType()

◆ getUserInfo()

◆ PEAR_Error()

◆ toString()

Field Documentation

◆ $backtrace

◆ $code

◆ $error_message_prefix

◆ $level

◆ $message

◆ $mode

◆ $userinfo