PEAR_Error Class Reference

Public Member Functions
	__construct ($message='unknown error', $code=null, $mode=null, $options=null, $userinfo=null)
	__toString ()
	addUserInfo ($info)
	getBacktrace ($frame=null)
	getCallback ()
	getCode ()
	getDebugInfo ()
	getMessage ()
	getMode ()
	getType ()
	getUserInfo ()
	PEAR_Error ( $message='unknown error', $code=null, $mode=null, $options=null, $userinfo=null)
	toString ()

Data Fields
	$backtrace = null
	$callback = null
	$code = -1
	$error_message_prefix = ''
	$level = E_USER_NOTICE
	$message = ''
	$mode = PEAR_ERROR_RETURN
	$userinfo = ''

Detailed Description

Definition at line 863 of file PEAR.php.

Constructor & Destructor Documentation

__construct()

__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

@access public

Definition at line 894 of file PEAR.php.

    {
        if ($mode === null) {
            $mode = PEAR_ERROR_RETURN;
        }
        $this->message   = $message;
        $this->code      = $code;
        $this->mode      = $mode;
        $this->userinfo  = $userinfo;
 
        $skiptrace = PEAR::getStaticProperty('PEAR_Error', 'skiptrace');
 
        if (!$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;
            }
            printf($format, $msg);
            exit($code);
        }
 
        if ($this->mode & PEAR_ERROR_CALLBACK && 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);
            eval('$e = new Exception($this->message, $this->code);throw($e);');
        }
    }

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

Referenced by PEAR_Error().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

__toString()

__toString

(

)

Definition at line 1087 of file PEAR.php.

    {
        return $this->getMessage();
    }

References getMessage().

Here is the call graph for this function:

addUserInfo()

addUserInfo

(

$info

)

Definition at line 1078 of file PEAR.php.

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

getBacktrace()

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 1067 of file PEAR.php.

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

References $backtrace.

getCallback()

getCallback

(

)

Get the callback function/method from an error object.

Returns

mixed callback function or object/method array @access public

Definition at line 999 of file PEAR.php.

    {
        return $this->callback;
    }

References $callback.

getCode()

getCode

(

)

Get error code from an error object

Returns

int error code @access public

Definition at line 1021 of file PEAR.php.

     {
        return $this->code;
     }

References $code.

getDebugInfo()

getDebugInfo

(

)

Get additional debug information supplied by the application.

Returns

string debug information @access public

Definition at line 1054 of file PEAR.php.

    {
        return $this->getUserInfo();
    }

References getUserInfo().

Here is the call graph for this function:

getMessage()

getMessage

(

)

Get the error message from an error object.

Returns

string full error message @access public

Definition at line 1010 of file PEAR.php.

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

Referenced by __construct(), and __toString().

Here is the caller graph for this function:

getMode()

getMode

(

)

Get the error mode from an error object.

Returns

int error mode @access public

Definition at line 988 of file PEAR.php.

    {
        return $this->mode;
    }

References $mode.

getType()

getType

(

)

Get the name of this error/exception.

Returns

string error/exception name (type) @access public

Definition at line 1032 of file PEAR.php.

    {
        return get_class($this);
    }

getUserInfo()

getUserInfo

(

)

Get additional user-supplied information.

Returns

string user-supplied information @access public

Definition at line 1043 of file PEAR.php.

    {
        return $this->userinfo;
    }

References $userinfo.

Referenced by getDebugInfo().

Here is the caller graph for this function:

PEAR_Error()

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

Only here for backwards compatibility.

Class "Cache_Error" still uses it, among others.

Parameters

string	$message	Message
int	$code	Error code
int	$mode	Error mode
mixed	$options	See __construct()
string	$userinfo	Additional user/debug info

Definition at line 975 of file PEAR.php.

      {
        self::__construct($message, $code, $mode, $options, $userinfo);
    }

References $code, $message, $mode, $options, $userinfo, and __construct().

Here is the call graph for this function:

toString()

toString

(

)

Make a string representation of this object.

Returns

string a string with an object summary @access public

Definition at line 1098 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 $callback, E_USER_ERROR, PEAR_ERROR_CALLBACK, PEAR_ERROR_DIE, PEAR_ERROR_PRINT, PEAR_ERROR_RETURN, and PEAR_ERROR_TRIGGER.

Field Documentation

$backtrace

$backtrace = null

Definition at line 871 of file PEAR.php.

Referenced by getBacktrace().

$callback

$callback = null

Definition at line 872 of file PEAR.php.

Referenced by getCallback(), and toString().

$code

$code = -1

Definition at line 868 of file PEAR.php.

Referenced by __construct(), getCode(), and PEAR_Error().

$error_message_prefix

$error_message_prefix = ''

Definition at line 865 of file PEAR.php.

$level

$level = E_USER_NOTICE

Definition at line 867 of file PEAR.php.

$message

$message = ''

Definition at line 869 of file PEAR.php.

Referenced by __construct(), and PEAR_Error().

$mode

$mode = PEAR_ERROR_RETURN

Definition at line 866 of file PEAR.php.

Referenced by __construct(), getMode(), and PEAR_Error().

$userinfo

$userinfo = ''

Definition at line 870 of file PEAR.php.

Referenced by __construct(), getUserInfo(), and PEAR_Error().

---

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

• E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/PEAR.php