php[world] 2015 Call for Speakers

Estendendo 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
    
private   $string;                          // Cache __toString 
    
protected $code 0;                        // Código definido pelo usuário
    
protected $file;                            // Nome do arquivo onde a exceção originou
    
protected $line;                            // Número da linha onde a exceção originou
    
private   $trace;                           // Backtrace
    
private   $previous;                        // Exceção anterior (se exceção empilhada)

    
public function __construct($message null$code 0Exception $previous null);

    final private function 
__clone();           // Inibe a clonagem de exceções

    
final public  function getMessage();        // Mensagem da exceção
    
final public  function getCode();           // Código definido pelo usuário
    
final public  function getFile();           // Nome do arquivo onde a exceção originou
    
final public  function getLine();           // Número da linha onde a exceção originou
    
final public  function getTrace();          // Um array do backtrace()
    
final public  function getPrevious();       // Exceção anterior
    
final public  function getTraceAsString();  // Backtrace formatado como string

    // Pode ser sobrescrito
    
public function __toString();               // String formatada da exceção
}
?>

Se uma classe estender a classe Exception e redefinir o constructor, então é altamente recomendável que também seja chamado o parent::__construct() para garantir que todos os dados estejam corretamente informados. O método __toString() pode ser sobrescrito para fornecer uma representação customizada do objeto quando utilizado como string.

Nota:

Exceções não podem ser clonadas. Tentativas de clonar um Exception resultarão em erros E_ERROR fatais.

Exemplo #2 Estendendo a classe Exception (PHP 5.3.0+)

<?php
/**
 * Define uma classe de exceção
 */
class MyException extends Exception
{
    
// Redefine a exceção de forma que a mensagem não seja opcional
    
public function __construct($message$code 0Exception $previous null) {
        
// código
    
        // garante que tudo está corretamente inicializado
        
parent::__construct($message$code$previous);
    }

    
// personaliza a apresentação do objeto como string
    
public function __toString() {
        return 
__CLASS__ ": [{$this->code}]: {$this->message}\n";
    }

    public function 
customFunction() {
        echo 
"Uma função específica desse 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:
                
// lança a exeção customizada
                
throw new MyException('1 é um parâmetro inválido'5);
                break;

            case 
self::THROW_DEFAULT:
                
// throw default one.
                
throw new Exception('2 não é um parâmetro permitido'6);
                break;

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


// Exemplo 1
try {
    
$o = new TestException(TestException::THROW_CUSTOM);
} catch (
MyException $e) {      // Entrará aqui ...
    
echo "Pegou MyException\n"$e;
    
$e->customFunction();
} catch (
Exception $e) {        // ... mas não aqui.
    
echo "Pegou Exception padrão\n"$e;
}


var_dump($o); // Null
echo "\n\n";


// Examplo 2
try {
    
$o = new TestException(TestException::THROW_DEFAULT);
} catch (
MyException $e) {      // Não entrará aqui ...
    
echo "Pegou MyException\n"$e;
    
$e->customFunction();
} catch (
Exception $e) {        // ... porque entrará aqui.
    
echo "Pegou Exception padrão\n"$e;
}


var_dump($o); // Null
echo "\n\n";


// Examplo 3
try {
    
$o = new TestException(TestException::THROW_CUSTOM);
} catch (
Exception $e) {        // Entrará aqui
    
echo "Pegou exceção padrão\n"$e;
}


var_dump($o); // Null
echo "\n\n";


// Examplo 4
try {
    
$o = new TestException();
} catch (
Exception $e) {        // Não entrará, sem exceção
    
echo "Pegou Exception padrão\n"$e;
}


var_dump($o); // TestException
echo "\n\n";
?>

Nota:

Versões do PHP 5 anteriores ao PHP 5.3.0 não suportam o empilhamento de exceções. O seguinte código pode ser utilizado como um substituto da classe MyException se quiser rodar o exemplo acima.

<?php
/**
 * Define uma exceção personalizada
 */
class MyException extends Exception
{
    
// Redefine a exceção de forma que a mensagem não seja opcional
    
public function __construct($message$code 0) {
        
// código
    
        // garante que tudo foi inicilizado corretamente
        
parent::__construct($message$code);
    }

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

    public function 
customFunction() {
        echo 
"Uma função específica para esse tipo de exceção\n";
    }
}
?>

add a note add a note

User Contributed Notes 7 notes

up
3
iamhiddensomewhere at gmail dot com
5 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
Dor
3 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
1
sapphirepaw.org
5 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
1
michaelrfairhurst at gmail dot com
2 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')
        );
}

?>
up
0
shaman_master at list dot ru
5 months 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>
up
-6
hollodotme
1 year 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
-13
paragdiwan at gmail dot com
6 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