PHP 5.4.31 Released

Herdando Exceções

Uma classe de exceção definida pelo usuário pode ser criada herdando a classe Exception. Os membros e propriedades abaixo mostram o que é acessível a partir da classe filha que deriva da Exception.

Exemplo #1 A classe nativa Exception

<?php
class Exception {

  protected 
$message 'Unknown exception'// Mensagem da exceção
  
protected $code 0;                      // Código da exceção definido pelo usuário
  
protected $file;                          // Arquivo gerador da exceção
  
protected $line;                          // Linha geradora da exceção

  
function __construct(string $message=NULLint code=0);

  final function 
getMessage();              // Mensagem da exceção
  
final function getCode();                 // Código da exceção
  
final function getFile();                 // Arquivo gerador
  
final function getTrace();                // um array com o backtrace()
  
final function getTraceAsString();        // String formatada do trace

  /* Sobrecarregável */
  
function _toString();                     // String formatada para ser mostrada

}
?>

Se uma classe herda da classe Exception e redefine o construtor, é altamente recomendado que o mesmo chame parent::__construct() para garantir que todas as informações disponíveis sejam devidamente atribuídas. O método __toString() pode ser sobrecarregado para permitir uma saída personalizada quando o objeto é apresentado como string.

Exemplo #2 Herdando a classe Exception

<?php

class MyException extends Exception {

  
/* Redefine a exceção para que a mensagem não seja opcional */
  
public function __construct($message$code 0) {

    
// coisas personalizadas que você queira fazer
    // ...

    /* Garante que tudo é atribuído corretamente */
    
parent::__construct($message$code);
  }

  
/* Representação do objeto personalizada no formato string */
  
public function __toString() {
    return 
__CLASS__ ": [{$this->code}]: {$this->message}\n";
  }

  public function 
customFunction() {
    echo 
"Uma função personalizada para esse tipo de exceção\n";
  }

}

/**
 * Cria uma classe para testar a exceção
 */
class TestException {

  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:
        
// dispara exceção personalizada
        
throw new MyException('1 é um parâmetro inválido'5);
        break;

      case 
self::THROW_DEFAULT:
        
// dispara a padrão
        
throw new Exception('2 não é permitido como parâmetro'6);

        break;

      default:
        
// Nenhuma exceção, objeto será criado.
        
$this->var $avalue;
        break;

    }

  }

}

// Exemplo 1
try {
  
$o = new TestException(TestException::THROW_CUSTOM);
}
catch (
MyException $e) {            /* Será pega */
  
echo "Pegou minha exceção\n"$e;
  
$e->customFunction();
}
catch (
Exception $e) {              /* Ignorado */
  
echo "Pegou Exceção Padrão\n"$e;
}
var_dump($o);                       /* continua execução */
echo "\n\n";


// Exemplo 2
try {
  
$o = new TestException(TestException::THROW_DEFAULT);
}
catch (
MyException $e) {            /* Tipos não batem */
  
echo "Pegou minha exceção\n"$e;
  
$e->customFunction();
}
catch (
Exception $e) {              /* Será pega */
  
echo "Pegou Exceção Padrão\n"$e;
}
var_dump($o);                       /* continua execução */
echo "\n\n";


// Exemplo 3
try {
  
$o = new TestException(TestException::THROW_CUSTOM);
}
catch (
Exception $e) {              /* Será pega */
  
echo "Default Exception caught\n"$e;
}
var_dump($o);                       /* continua execução */
echo "\n\n";


// Exemplo 4
try {
  
$o = new TestException();
}
catch (
Exception $e) {              /* Ignorada, nenhuma exceção */
  
echo "Default Exception caught\n"$e;
}
var_dump($o);                       /* continua execução */
echo "\n\n";
add a note add a note

User Contributed Notes 6 notes

up
2
iamhiddensomewhere at gmail dot com
4 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.
up
1
michaelrfairhurst at gmail dot com
1 year 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')
        );
}

?>
up
0
hollodotme
2 months ago
Not mentioned in the class structure on top of this site are the following members:

<?php
/**
* @var string
*/
protected $string;

/**
* @var array
*/
protected $trace;

/**
* @var Exception
*/
protected $previous;
?>

... and these methods:

<?php
/**
* @return Exception|null
*/
final public function getPrevious();
?>
up
0
Dor
2 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).
up
0
sapphirepaw.org
4 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.
up
-5
paragdiwan at gmail dot com
5 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;
    }
?>
To Top