Class: PEAR_Exception

Source Location: /PEAR-1.7.2/PEAR/Exception.php

Class Overview

Exception
   |
   --PEAR_Exception

Base PEAR_Exception Class

Author(s):

Greg Beaver <cellog at php.net>
Tomas V.V.Cox <cox at idecnet.com>
Hans Lellelid <hans at velum.net>
Bertrand Mansion <bmansion at mamasam.com>

Version:

Release: 1.7.2

Copyright:

1997-2008 The PHP Group

Variables

$cause

Methods

Inherited Variables

Class: Exception (Internal Class)

$code
$file
$line
$message
$string
$trace

Inherited Methods

Class: Exception (Internal Class)

constructor __construct ( [$message = ], [$code = ] )
getCode ( )
getFile ( )
getLine ( )
getMessage ( )
getTrace ( )
getTraceAsString ( )
__clone ( )
__toString ( )

Class Details

[line 103]
Base PEAR_Exception Class

1) Features:

Nestable exceptions (throw new PEAR_Exception($msg, $prev_exception))
Definable triggers, shot when exceptions occur
Pretty and informative error messages
Added more context info available (like class, method or cause)
cause can be a PEAR_Exception or an array of mixed PEAR_Exceptions/PEAR_ErrorStack warnings
callbacks for specific exception classes and their children

2) Ideas:

Maybe a way to define a 'template' for the output

3) Inherited properties from PHP Exception Class:

protected $message protected $code protected $line protected $file private $trace

4) Inherited methods from PHP Exception Class:

__clone __construct getMessage getCode getFile getLine getTraceSafe getTraceSafeAsString __toString

5) Usage example

  require_once 'PEAR/Exception.php';

 
  class Test {
     function foo() {
         throw new PEAR_Exception('Error Message', ERROR_CODE);
     }
  }
 
  function myLogger($pear_exception) {
     echo $pear_exception->getMessage();
  }
  // each time a exception is thrown the 'myLogger' will be called
  // (its use is completely optional)
  PEAR_Exception::addObserver('myLogger');
  $test = new Test;
  try {
     $test->foo();
  } catch (PEAR_Exception $e) {
     print $e;
  }

Author: Greg Beaver <cellog@php.net>
Author: Tomas V.V.Cox <cox@idecnet.com>
Author: Hans Lellelid <hans@velum.net>
Author: Bertrand Mansion <bmansion@mamasam.com>
Version: Release: 1.7.2
Copyright: 1997-2008 The PHP Group
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 1.3.3
License: PHP License 3.0

[ Top ]

Class Variables

$cause =

[line 108]

Access: protected

Type:

mixed

[ Top ]

Method Detail

__construct (Constructor) [line 127]

PEAR_Exception __construct(
string
$message, [int|Exception|PEAR_Error|array|null
$p2 = null], [int|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);

Access: public

Overrides Exception::constructor __construct ( [$message = ], [$code = ] ) (parent method not documented)

Parameters:

string	`$message`	—	exception message
int\|Exception\|PEAR_Error\|array\|null	`$p2`	—	exception cause
int\|null	`$p3`	—	exception code or null

[ Top ]

addObserver [line 162]

void addObserver(
mixed
$callback, [string
$label = 'default'])

Access: public

Parameters:

mixed

$callback

—

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()

[ Top ]

getCause [line 231]

Exception|array getCause(
)

Returns the exception that caused this exception to be thrown

Return: The context of the exception
Access: public

[ Top ]

getCauseMessage [line 240]

void getCauseMessage(
array
&$causes)

Function must be public to call on caused exceptions

Access: public

Parameters:

array &$causes —

[ Top ]

getErrorClass [line 309]

void getErrorClass(
)

Access: public

[ Top ]

getErrorData [line 221]

array 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(...))

Access: public

[ Top ]

getErrorMethod [line 315]

void getErrorMethod(
)

Access: public

[ Top ]

getTraceSafe [line 297]

void getTraceSafe(
)

Access: public

[ Top ]

getUniqueId [line 175]

int getUniqueId(
)

Return: unique identifier for an observer
Access: public

[ Top ]

removeObserver [line 167]

void removeObserver(
[
$label = 'default'])

Access: public

Parameters:

$label —

[ Top ]

toHtml [line 329]

void toHtml(
)

Access: public

[ Top ]

toText [line 383]

void toText(
)

Access: public

[ Top ]

__toString [line 321]

void __toString(
)

Access: public

Overrides Exception::__toString ( ) (parent method not documented)

[ Top ]