Inheritance diagram for PEAR_Exception:

Collaboration diagram for PEAR_Exception:

Public Member Functions
	__construct ($message, $p2=null, $p3=null)
	__toString ()
	getCause ()
	getCauseMessage (&$causes)
	getErrorClass ()
	getErrorData ()
	getErrorMethod ()
	getTraceSafe ()
	toHtml ()
	toText ()

Static Public Member Functions
static	addObserver ($callback, $label='default')
static	getUniqueId ()
static	removeObserver ($label='default')

Data Fields
const	OBSERVER_DIE = -8
const	OBSERVER_PRINT = -2
const	OBSERVER_TRIGGER = -4

Protected Attributes
	$cause

Private Member Functions
	signal ()

Private Attributes
	$_trace

Static Private Attributes
static	$_observers = array()
static	$_uniqueid = 0

Detailed Description

Definition at line 96 of file Exception.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$message,
		$p2 = null,
		$p3 = null )

Supported signatures:

PEAR_Exception(string $message);
PEAR_Exception(string $message, int $code);
PEAR_Exception(string $message, Exception $cause);
PEAR_Exception(string $message, Exception $cause, int $code);
PEAR_Exception(string $message, PEAR_Error $cause);
PEAR_Exception(string $message, PEAR_Error $cause, int $code);
PEAR_Exception(string $message, array $causes);
PEAR_Exception(string $message, array $causes, int $code);
Parameters

string exception message

int|Exception|PEAR_Error|array|null exception cause

int|null exception code or null

Definition at line 120 of file Exception.php.

    {
        if (is_int($p2)) {
            $code = $p2;
            $this->cause = null;
        } elseif (is_object($p2) || is_array($p2)) {
            // using is_object allows both Exception and PEAR_Error
            if (is_object($p2) && !($p2 instanceof Exception)) {
                if (!class_exists('PEAR_Error') || !($p2 instanceof PEAR_Error)) {
                    throw new PEAR_Exception('exception cause must be Exception, ' .
                        'array, or PEAR_Error');
                }
            }
            $code = $p3;
            if (is_array($p2) && isset($p2['message'])) {
                // fix potential problem of passing in a single warning
                $p2 = array($p2);
            }
            $this->cause = $p2;
        } else {
            $code = null;
            $this->cause = null;
        }
        parent::__construct($message, $code);
        $this->signal();
    }

References signal().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

__toString ( )

Definition at line 314 of file Exception.php.

    {
        if (isset($_SERVER['REQUEST_URI'])) {
            return $this->toHtml();
        }
        return $this->toText();
    }

References toHtml(), and toText().

Here is the call graph for this function:

◆ addObserver()

addObserver	(		$callback,
			$label = 'default' )

static

Parameters

mixed	$callback	- A valid php callback, see php func is_callable() A PEAR_Exception::OBSERVER_* constant An array(const PEAR_Exception::OBSERVER_*, mixed $options)
string	$label	The name of the observer. Use this if you want to remove it later with removeObserver()

Definition at line 155 of file Exception.php.

    {
        self::$_observers[$label] = $callback;
    }

◆ getCause()

getCause ( )

Returns the exception that caused this exception to be thrown @access public

Returns: Exception|array The context of the exception

Definition at line 224 of file Exception.php.

    {
        return $this->cause;
    }

References $cause.

◆ getCauseMessage()

getCauseMessage ( & $causes )

Function must be public to call on caused exceptions

Parameters

array

Definition at line 233 of file Exception.php.

    {
        $trace = $this->getTraceSafe();
        $cause = array('class'   => get_class($this),
                       'message' => $this->message,
                       'file' => 'unknown',
                       'line' => 'unknown');
        if (isset($trace[0])) {
            if (isset($trace[0]['file'])) {
                $cause['file'] = $trace[0]['file'];
                $cause['line'] = $trace[0]['line'];
            }
        }
        $causes[] = $cause;
        if ($this->cause instanceof PEAR_Exception) {
            $this->cause->getCauseMessage($causes);
        } elseif ($this->cause instanceof Exception) {
            $causes[] = array('class'   => get_class($this->cause),
                              'message' => $this->cause->getMessage(),
                              'file' => $this->cause->getFile(),
                              'line' => $this->cause->getLine());
        } elseif (class_exists('PEAR_Error') && $this->cause instanceof PEAR_Error) {
            $causes[] = array('class' => get_class($this->cause),
                              'message' => $this->cause->getMessage(),
                              'file' => 'unknown',
                              'line' => 'unknown');
        } elseif (is_array($this->cause)) {
            foreach ($this->cause as $cause) {
                if ($cause instanceof PEAR_Exception) {
                    $cause->getCauseMessage($causes);
                } elseif ($cause instanceof Exception) {
                    $causes[] = array('class'   => get_class($cause),
                                   'message' => $cause->getMessage(),
                                   'file' => $cause->getFile(),
                                   'line' => $cause->getLine());
                } elseif (class_exists('PEAR_Error') && $cause instanceof PEAR_Error) {
                    $causes[] = array('class' => get_class($cause),
                                      'message' => $cause->getMessage(),
                                      'file' => 'unknown',
                                      'line' => 'unknown');
                } elseif (is_array($cause) && isset($cause['message'])) {
                    // PEAR_ErrorStack warning
                    $causes[] = array(
                        'class' => $cause['package'],
                        'message' => $cause['message'],
                        'file' => isset($cause['context']['file']) ?
                                            $cause['context']['file'] :
                                            'unknown',
                        'line' => isset($cause['context']['line']) ?
                                            $cause['context']['line'] :
                                            'unknown',
                    );
                }
            }
        }
    }

References $cause, and getTraceSafe().

Referenced by toHtml(), and toText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getErrorClass()

getErrorClass ( )

Definition at line 302 of file Exception.php.

    {
        $trace = $this->getTraceSafe();
        return $trace[0]['class'];
    }

References getTraceSafe().

Here is the call graph for this function:

◆ getErrorData()

getErrorData ( )

Return specific error information that can be used for more detailed error messages or translation.

This method may be overridden in child exception classes in order to add functionality not present in PEAR_Exception and is a placeholder to define API

The returned array must be an associative array of parameter => value like so:

array('name' => $name, 'context' => array(...))

Returns: array

Definition at line 214 of file Exception.php.

    {
        return array();
    }

◆ getErrorMethod()

getErrorMethod ( )

Definition at line 308 of file Exception.php.

    {
        $trace = $this->getTraceSafe();
        return $trace[0]['function'];
    }

References getTraceSafe().

Here is the call graph for this function:

◆ getTraceSafe()

getTraceSafe ( )

Definition at line 290 of file Exception.php.

    {
        if (!isset($this->_trace)) {
            $this->_trace = $this->getTrace();
            if (empty($this->_trace)) {
                $backtrace = debug_backtrace();
                $this->_trace = array($backtrace[count($backtrace)-1]);
            }
        }
        return $this->_trace;
    }

References $_trace.

Referenced by getCauseMessage(), getErrorClass(), getErrorMethod(), and toHtml().

Here is the caller graph for this function:

◆ getUniqueId()

getUniqueId ( )

static

Returns: int unique identifier for an observer

Definition at line 168 of file Exception.php.

    {
        return self::$_uniqueid++;
    }

◆ removeObserver()

removeObserver ( $label = 'default' )

static

Definition at line 160 of file Exception.php.

    {
        unset(self::$_observers[$label]);
    }

◆ signal()

signal ( )

private

Definition at line 173 of file Exception.php.

    {
        foreach (self::$_observers as $func) {
            if (is_callable($func)) {
                call_user_func($func, $this);
                continue;
            }
            settype($func, 'array');
            switch ($func[0]) {
                case self::OBSERVER_PRINT :
                    $f = (isset($func[1])) ? $func[1] : '%s';
                    printf($f, $this->getMessage());
                    break;
                case self::OBSERVER_TRIGGER :
                    $f = (isset($func[1])) ? $func[1] : E_USER_NOTICE;
                    trigger_error($this->getMessage(), $f);
                    break;
                case self::OBSERVER_DIE :
                    $f = (isset($func[1])) ? $func[1] : '%s';
                    die(printf($f, $this->getMessage()));
                    break;
                default:
                    trigger_error('invalid observer type', E_USER_WARNING);
            }
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ toHtml()

toHtml ( )

Definition at line 322 of file Exception.php.

    {
        $trace = $this->getTraceSafe();
        $causes = array();
        $this->getCauseMessage($causes);
        $html =  '<table style="border: 1px" cellspacing="0">' . "\n";
        foreach ($causes as $i => $cause) {
            $html .= '<tr><td colspan="3" style="background: #ff9999">'
               . str_repeat('-', $i) . ' <b>' . $cause['class'] . '</b>: '
               . htmlspecialchars($cause['message']) . ' in <b>' . $cause['file'] . '</b> '
               . 'on line <b>' . $cause['line'] . '</b>'
               . "</td></tr>\n";
        }
        $html .= '<tr><td colspan="3" style="background-color: #aaaaaa; text-align: center; font-weight: bold;">Exception trace</td></tr>' . "\n"
               . '<tr><td style="text-align: center; background: #cccccc; width:20px; font-weight: bold;">#</td>'
               . '<td style="text-align: center; background: #cccccc; font-weight: bold;">Function</td>'
               . '<td style="text-align: center; background: #cccccc; font-weight: bold;">Location</td></tr>' . "\n";
 
        foreach ($trace as $k => $v) {
            $html .= '<tr><td style="text-align: center;">' . $k . '</td>'
                   . '<td>';
            if (!empty($v['class'])) {
                $html .= $v['class'] . $v['type'];
            }
            $html .= $v['function'];
            $args = array();
            if (!empty($v['args'])) {
                foreach ($v['args'] as $arg) {
                    if (is_null($arg)) $args[] = 'null';
                    elseif (is_array($arg)) $args[] = 'Array';
                    elseif (is_object($arg)) $args[] = 'Object('.get_class($arg).')';
                    elseif (is_bool($arg)) $args[] = $arg ? 'true' : 'false';
                    elseif (is_int($arg) || is_double($arg)) $args[] = $arg;
                    else {
                        $arg = (string)$arg;
                        $str = htmlspecialchars(substr($arg, 0, 16));
                        if (strlen($arg) > 16) $str .= '&hellip;';
                        $args[] = "'" . $str . "'";
                    }
                }
            }
            $html .= '(' . implode(', ',$args) . ')'
                   . '</td>'
                   . '<td>' . (isset($v['file']) ? $v['file'] : 'unknown')
                   . ':' . (isset($v['line']) ? $v['line'] : 'unknown')
                   . '</td></tr>' . "\n";
        }
        $html .= '<tr><td style="text-align: center;">' . ($k+1) . '</td>'
               . '<td>{main}</td>'
               . '<td>&nbsp;</td></tr>' . "\n"
               . '</table>';
        return $html;
    }

References $cause, getCauseMessage(), and getTraceSafe().

Referenced by __toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toText()

toText ( )

Definition at line 376 of file Exception.php.

    {
        $causes = array();
        $this->getCauseMessage($causes);
        $causeMsg = '';
        foreach ($causes as $i => $cause) {
            $causeMsg .= str_repeat(' ', $i) . $cause['class'] . ': '
                   . $cause['message'] . ' in ' . $cause['file']
                   . ' on line ' . $cause['line'] . "\n";
        }
        return $causeMsg . $this->getTraceAsString();
    }

References $cause, and getCauseMessage().

Referenced by __toString().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_observers

$_observers = array()

staticprivate

Definition at line 102 of file Exception.php.

◆ $_trace

$_trace

private

Definition at line 104 of file Exception.php.

Referenced by getTraceSafe().

◆ $_uniqueid

$_uniqueid = 0

staticprivate

Definition at line 103 of file Exception.php.

◆ $cause

$cause

protected

Definition at line 101 of file Exception.php.

Referenced by getCause(), getCauseMessage(), toHtml(), and toText().

◆ OBSERVER_DIE

const OBSERVER_DIE = -8

Definition at line 100 of file Exception.php.

◆ OBSERVER_PRINT

const OBSERVER_PRINT = -2

Definition at line 98 of file Exception.php.

◆ OBSERVER_TRIGGER

const OBSERVER_TRIGGER = -4

Definition at line 99 of file Exception.php.

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

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

string	exception message
int\|Exception\|PEAR_Error\|array\|null	exception cause
int\|null	exception code or null

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ addObserver()

◆ getCause()

◆ getCauseMessage()

◆ getErrorClass()

◆ getErrorData()

◆ getErrorMethod()

◆ getTraceSafe()

◆ getUniqueId()

◆ removeObserver()

◆ signal()

◆ toHtml()

◆ toText()

Field Documentation

◆ $_observers

◆ $_trace

◆ $_uniqueid

◆ $cause

◆ OBSERVER_DIE

◆ OBSERVER_PRINT

◆ OBSERVER_TRIGGER