Check the other SPL Exception classes and extend one of those if your intended exception is a subclass of one of those. This allows more finesse when catching.
Ampliar las Excepciones
Una clase de Excepción definida por el usuario puede ser definida ampliando la clase Exception interna. Los miembros y las propiedades de abajo muestran lo que es accesible dentro de la clase hija que deriva de la clase Exception interna.
Ejemplo #1 La clase Exception Interna
<?php
class Exception
{
protected $message = 'Unknown exception'; // mensaje de excepción
private $string; // caché de __toString
protected $code = 0; // código de excepción definido por el usuario
protected $file; // nombre de archivo fuente de la excepción
protected $line; // línea fuente de la excepción
private $trace; // determinación del origen
private $previous; // excepción previa si la excepción está anidada
public function __construct($message = null, $code = 0, Exception $previous = null);
final private function __clone(); // Inhibe la clonación de excepciones.
final public function getMessage(); // mensaje de excepción
final public function getCode(); // código de excepción
final public function getFile(); // nombre de archivo fuente
final public function getLine(); // línea fuente
final public function getTrace(); // un array de backtrace()
final public function getPrevious(); // excepción anterior
final public function getTraceAsString(); // string formateado del seguimiento del origen
// Sobrescribible
public function __toString(); // string formateado para mostrar
}
?>Si una clase extiende la clase Exception interna y redefine el constructor, se recomienda encarecidamente que también llame a parent::__construct() para asegurarse que toda la información disponible haya sido asignada apropiadamente. El método __toString() puede ser sobrescrito para proporcionar una salida personalizada cuando el objeto es presentado como un string.
Nota:
Las excepciones no se pueden clonar. Intentar clonar una Excepción resultará en un error
E_ERRORfatal.
Ejemplo #2 Extender la clase Exception (PHP 5.3.0+)
<?php
/**
* Definir una clase de excepción personalizada
*/
class MiExcepción extends Exception
{
// Redefinir la excepción, por lo que el mensaje no es opcional
public function __construct($message, $code = 0, Exception $previous = null) {
// algo de código
// asegúrese de que todo está asignado apropiadamente
parent::__construct($message, $code, $previous);
}
// representación de cadena personalizada del objeto
public function __toString() {
return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
}
public function funciónPersonalizada() {
echo "Una función personalizada para este tipo de excepción\n";
}
}
/**
* Crear una clase para probar la excepción
*/
class ProbarExcepción
{
public $var;
const THROW_NONE = 0;
const THROW_CUSTOM = 1;
const THROW_DEFAULT = 2;
function __construct($avalue = self::THROW_NONE) {
switch ($avalue) {
case self::THROW_CUSTOM:
// lanzar la excepción personalizada
throw new MiExcepción('1 no es un parámetro válido', 5);
break;
case self::THROW_DEFAULT:
// lanzar la predeterminada.
throw new Exception('2 no está permitido como parámetro', 6);
break;
default:
// No hay excepción, el objeto se creará.
$this->var = $avalue;
break;
}
}
}
// Ejemplo 1
try {
$o = new ProbarExcepción(ProbarExcepción::THROW_CUSTOM);
} catch (MiExcepción $e) { // Será atrapada
echo "Atrapada mi excepción\n", $e;
$e->funciónPersonalizada();
} catch (Exception $e) { // Skipped
echo "Atrapada la Excepción Predeterminada\n", $e;
}
// Continuar la ejecución
var_dump($o); // Null
echo "\n\n";
// Ejemplo 2
try {
$o = new ProbarExcepción(ProbarExcepción::THROW_DEFAULT);
} catch (MiExcepción $e) { // Este tipo no coincide
echo "Atrapada mi excepción\n", $e;
$e->funciónPersonalizada();
} catch (Exception $e) { // Will be caught
echo "Atrapada la Excepción Predeterminada\n", $e;
}
// Continuar la ejecución
var_dump($o); // Null
echo "\n\n";
// Ejemplo 3
try {
$o = new ProbarExcepción(ProbarExcepción::THROW_CUSTOM);
} catch (Exception $e) { // Será atrapada
echo "Atrapada la Excepción Predeterminada\n", $e;
}
// Continuar la ejecución
var_dump($o); // Null
echo "\n\n";
// Ejemplo 4
try {
$o = new ProbarExcepción();
} catch (Exception $e) { // Saltado, sin excepción
echo "Atrapada la Excepción Predeterminada\n", $e;
}
// Continuar la ejecución
var_dump($o); // ProbarExcepción
echo "\n\n";
?>Nota:
Las versiones de PHP 5, anteriores a PHP 5.3.0, no soportan excepciones anidadas. El siguiente fragmento de código se puede usar para reemplazar la clase MiExcepción si se desea ejecutar este ejemplo.
<?php
/**
* Definir una clase de excepción personalizada
*/
class MiExcepción extends Exception
{
// Redefinir la excepción, por lo que el mensaje no es opcional
public function __construct($message, $code = 0) {
// algo de código
// asegúrese de que todo está asignador apropiadamente
parent::__construct($message, $code);
}
// representación de cadena personalizada del objeto
public function __toString() {
return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
}
public function funciónPersonalizada() {
echo "Una función personalizada para este tipo de excepción\n";
}
}
?>
add a note
User Contributed Notes 8 notes
Hayley Watson ¶
5 years ago
iamhiddensomewhere at gmail dot com ¶
14 years ago
As previously noted exception linking was recently added (and what a god-send it is, it certainly makes layer abstraction (and, by association, exception tracking) easier).
Since <5.3 was lacking this useful feature I took some initiative and creating a custom exception class that all of my exceptions inherit from:
<?php
class SystemException extends Exception
{
private $previous;
public function __construct($message, $code = 0, Exception $previous = null)
{
parent::__construct($message, $code);
if (!is_null($previous))
{
$this -> previous = $previous;
}
}
public function getPrevious()
{
return $this -> previous;
}
}
?>
Hope you find it useful.
sapphirepaw.org ¶
14 years ago
Support for exception linking was added in PHP 5.3.0. The getPrevious() method and the $previous argument to the constructor are not available on any built-in exceptions in older versions of PHP.
michaelrfairhurst at gmail dot com ¶
12 years ago
Custom exception classes can allow you to write tests that prove your exceptions
are meaningful. Usually testing exceptions, you either assert the message equals
something in which case you can't change the message format without refactoring,
or not make any assertions at all in which case you can get misleading messages
later down the line. Especially if your $e->getMessage is something complicated
like a var_dump'ed context array.
The solution is to abstract the error information from the Exception class into
properties that can be tested everywhere except the one test for your formatting.
<?php
class TestableException extends Exception {
private $property;
function __construct($property) {
$this->property = $property;
parent::__construct($this->format($property));
}
function format($property) {
return "I have formatted: " . $property . "!!";
}
function getProperty() {
return $this->property;
}
}
function testSomethingThrowsTestableException() {
try {
throw new TestableException('Property');
} Catch (TestableException $e) {
$this->assertEquals('Property', $e->getProperty());
}
}
function testExceptionFormattingOnlyOnce() {
$e = new TestableException;
$this->assertEquals('I have formatted: properly for the only required test!!',
$e->format('properly for the only required test')
);
}
?>
Dor ¶
13 years ago
It's important to note that subclasses of the Exception class will be caught by the default Exception handler
<?php
/**
* NewException
* Extends the Exception class so that the $message parameter is now mendatory.
*
*/
class NewException extends Exception {
//$message is now not optional, just for the extension.
public function __construct($message, $code = 0, Exception $previous = null) {
parent::__construct($message, $code, $previous);
}
}
/**
* TestException
* Tests and throws Exceptions.
*/
class TestException {
const NONE = 0;
const NORMAL = 1;
const CUSTOM = 2;
public function __construct($type = self::NONE) {
switch ($type) {
case 1:
throw new Exception('Normal Exception');
break;
case 2:
throw new NewException('Custom Exception');
break;
default:
return 0; //No exception is thrown.
}
}
}
try {
$t = new TestException(TestException::CUSTOM);
}
catch (Exception $e) {
print_r($e); //Exception Caught
}
?>
Note that if an Exception is caught once, it won't be caught again (even for a more specific handler).
shaman_master at list dot ru ¶
9 years ago
Use this example for not numeric codes:
<code>
<?php
class MyException extends Exception
{
/**
* Creates a new exception.
*
* @param string $message Error message
* @param mixed $code The exception code
* @param Exception $previous Previous exception
* @return void
*/
public function __construct($message = '', $code = 0, Exception $previous = null)
{
// Pass the message and integer code to the parent
parent::__construct((string)$message, (int)$code, $previous);
// @link http://bugs.php.net/39615 Save the unmodified code
$this->code = $code;
}
}
</code>
florenxe ¶
9 years ago
I just wanted to add that "extends" is same concept of "Inheritance" or "Prototyping in Javascript". So when you extend a class, you are simply inheriting the class's methods and properties. So you can create custom classes from existing classes like extending the array class.
paragdiwan at gmail dot com ¶
15 years ago
I have written similar simple custom exception class. Helpful for newbie.
<?php
/*
This is written for overriding the exceptions.
custom exception class
*/
error_reporting(E_ALL-E_NOTICE);
class myCustomException extends Exception
{
public function __construct($message, $code=0)
{
parent::__construct($message,$code);
}
public function __toString()
{
return "<b style='color:red'>".$this->message."</b>";
}
}
class testException
{
public function __construct($x)
{
$this->x=$x;
}
function see()
{
if($this->x==9 )
{
throw new myCustomException("i didnt like it");
}
}
}
$obj = new testException(9);
try{
$obj->see();
}
catch(myCustomException $e)
{
echo $e;
}
?>
