Exceções em PHP: throw e classes de exceção próprias

Você lança uma exceção no PHP com throw new Exception('message');. A execução para naquela linha e pula para o bloco catch mais próximo que aceita o tipo da exceção, onde $e->getMessage() retorna a mensagem. Use uma classe específica, como InvalidArgumentException, para que quem chama consiga distinguir os problemas.

<?php
function setQuantity(int $qty): string
{
    if ($qty < 1) {
        throw new InvalidArgumentException("Quantity must be at least 1, got $qty");
    }
    return "Quantity set to $qty";
}

try {
    echo setQuantity(3), "\n";
    echo setQuantity(0), "\n";
} catch (InvalidArgumentException $e) {
    echo 'Rejected: ', $e->getMessage(), "\n";
}

Uma exceção é um objeto. O throw a passa para cima na pilha de chamadas até o primeiro chamador com um catch correspondente, e esse chamador decide o que fazer; a função que encontrou o problema não precisa saber. A mecânica da captura, do finally e da captura de vários tipos está na página sobre try catch.

O que um objeto de exceção contém

Toda exceção carrega uma mensagem, um código inteiro, o arquivo e a linha em que foi criada e um stack trace. O construtor recebe ($message, $code, $previous), todos opcionais:

<?php
function findOrder(int $id): array
{
    throw new RuntimeException("Order $id not found", 404);
}

try {
    findOrder(77);
} catch (RuntimeException $e) {
    echo 'Class:   ', get_class($e), "\n";
    echo 'Message: ', $e->getMessage(), "\n";
    echo 'Code:    ', $e->getCode(), "\n";
    echo 'File:    ', basename($e->getFile()), "\n";
    echo 'Line:    ', $e->getLine(), "\n";
    echo "Trace:\n", $e->getTraceAsString(), "\n";
}

getLine() é a linha do throw new, não a linha do catch. O trace lista as chamadas que levaram até ali (#0 /home/index.php(8): findOrder()), que costuma ser a primeira coisa a ler quando um erro aparece num log. Converter a exceção em string (echo $e; ou (string) $e) imprime tudo isso no formato padrão do PHP.

Classes de exceção nativas

O PHP traz uma família de classes de exceção na sua Standard PHP Library (SPL). Lançar a que dá nome ao problema deixa o código mais legível e permite que quem chama capture de forma precisa. Todas estas estendem Exception:

InvalidArgumentException, DomainException, LengthException e OutOfRangeException estendem LogicException; OutOfBoundsException, RangeException e UnexpectedValueException estendem RuntimeException. Você mesmo pode verificar as classes pai de qualquer classe:

<?php
foreach ([InvalidArgumentException::class, RangeException::class, JsonException::class, TypeError::class] as $class) {
    echo $class, ' -> ', implode(' -> ', class_parents($class)), "\n";
}

$e = new OutOfRangeException('Index 9 is out of range');
var_dump($e instanceof LogicException, $e instanceof RuntimeException, $e instanceof Throwable);

TypeError tem Error como classe pai, não Exception: ela pertence à segunda família, abaixo.

Erros que o próprio PHP lança

Desde o PHP 7, e muito mais desde o PHP 8, as funções e os operadores do próprio PHP lançam subclasses de Error para problemas que antes eram warnings. Você as captura do mesmo jeito, mas catch (Exception $e) não bate com elas:

<?php
declare(strict_types=1);

$cases = [
    'intdiv by zero'  => fn () => intdiv(10, 0),
    'modulo by zero'  => fn () => 7 % 0,
    'wrong arg type'  => fn () => str_repeat(5, 2),
    'invalid value'   => fn () => array_fill(0, -1, 'x'),
    'too few args'    => fn () => (fn (int $a, int $b) => $a + $b)(1),
    'no match arm'    => fn () => match (99) { 1 => 'one', 2 => 'two' },
    'undefined func'  => fn () => undefined_function(),
];

foreach ($cases as $label => $run) {
    try {
        $run();
    } catch (Error $e) {
        printf("%-16s %-22s %s\n", $label, get_class($e), $e->getMessage());
    }
}

DivisionByZeroError, TypeError, ValueError, ArgumentCountError, UnhandledMatchError e o Error simples estendem Error. Cada uma aponta mais vezes para um bug no código que chama do que para dados ruins, e é por isso que ficam fora da árvore de Exception. É o declare(strict_types=1) que faz str_repeat(5, 2) ser um TypeError; sem ele o PHP converteria 5 em "5".

Escrever uma classe de exceção própria

Uma subclasse de uma linha muitas vezes é tudo de que você precisa: o próprio nome da classe carrega o significado, e quem chama pode capturar exatamente esse tipo. Quando quem captura precisa de dados (qual pedido, qual valor), adicione propriedades e repasse a mensagem com parent::__construct():

<?php
class PaymentException extends RuntimeException {}

class InsufficientFundsException extends PaymentException
{
    public function __construct(
        public readonly int $balanceCents,
        public readonly int $neededCents,
    ) {
        parent::__construct(sprintf(
            'Insufficient funds: balance %.2f, needed %.2f',
            $balanceCents / 100,
            $neededCents / 100,
        ), 402);
    }

    public function shortfall(): int
    {
        return $this->neededCents - $this->balanceCents;
    }
}

function pay(int $balance, int $amount): string
{
    if ($amount > $balance) {
        throw new InsufficientFundsException($balance, $amount);
    }
    return 'paid';
}

try {
    echo pay(5000, 1200), "\n";
    echo pay(5000, 8000), "\n";
} catch (InsufficientFundsException $e) {
    echo $e->getMessage(), "\n";
    echo 'Top up at least ', $e->shortfall() / 100, " EUR (code {$e->getCode()})\n";
} catch (PaymentException $e) {
    echo 'Payment failed: ', $e->getMessage(), "\n";
}

Escolha a classe pai com cuidado: estender RuntimeException (em vez de Exception simples) significa que o código que captura RuntimeException também trata a sua. Uma pequena hierarquia, uma exceção base por biblioteca ou módulo com subclasses específicas abaixo dela, deixa quem chama escolher entre "capturar tudo de pagamentos" e "capturar só este caso".

Encadear exceções com previous

Quando você captura uma exceção de baixo nível e lança uma de nível mais alto, passe a original como terceiro argumento. Nada se perde: getPrevious() volta até a causa raiz.

<?php
class ImportException extends RuntimeException {}

function parseRow(string $line, int $n): array
{
    $cols = str_getcsv($line);
    if (count($cols) !== 3) {
        throw new UnexpectedValueException("row $n has " . count($cols) . ' columns, expected 3');
    }
    return $cols;
}

function import(array $lines): int
{
    foreach ($lines as $i => $line) {
        try {
            parseRow($line, $i + 1);
        } catch (UnexpectedValueException $e) {
            throw new ImportException('customers.csv could not be imported', 0, $e);
        }
    }
    return count($lines);
}

try {
    import(['Ada,ada@example.com,UK', 'Linus,linus@example.com']);
} catch (ImportException $e) {
    $level = 0;
    for ($x = $e; $x !== null; $x = $x->getPrevious()) {
        echo str_repeat('  ', $level++), get_class($x), ': ', $x->getMessage(), "\n";
    }
}

O usuário vê "customers.csv could not be imported"; o log, percorrendo a cadeia, também recebe "row 2 has 2 columns". Se uma exceção encadeada nunca for capturada, o erro fatal do PHP imprime a cadeia inteira: primeiro a causa original, depois cada camada numa linha Next.

throw como expressão

Desde o PHP 8.0, throw é uma expressão, então pode ficar onde quer que um valor seja esperado: depois de ??, num ternário, numa arrow function. Isso transforma "pegue isto ou falhe" numa única linha:

<?php
$config = ['host' => 'localhost', 'port' => '5432'];

function setting(array $config, string $key): string
{
    return $config[$key] ?? throw new OutOfBoundsException("Missing setting '$key'");
}

echo setting($config, 'host'), "\n";

$port = (int) $config['port'] ?: throw new DomainException('Port must not be 0');
echo $port, "\n";

$positive = fn (int $n) => $n > 0 ? $n : throw new DomainException("$n is not positive");
echo $positive(8), "\n";

try {
    echo setting($config, 'password'), "\n";
} catch (OutOfBoundsException $e) {
    echo $e->getMessage(), "\n";
}

Quando não lançar

Exceções são para situações que a função atual não consegue tratar e que o fluxo normal não espera. Uma busca que não encontra nada, um campo opcional vazio ou um usuário que não está logado são resultados comuns: retorne null, false ou um array vazio e deixe quem chama verificar, e guarde as exceções para os casos em que continuar seria errado.

<?php
$users = ['ada' => 'Ada Lovelace', 'linus' => 'Linus Torvalds'];

// Ordinary outcome: "not found" is a normal answer, so return null
function findUser(array $users, string $handle): ?string
{
    return $users[$handle] ?? null;
}

// Broken input: an empty handle is a bug in the caller, so throw
function requireHandle(string $handle): string
{
    if ($handle === '') {
        throw new InvalidArgumentException('Handle must not be empty');
    }
    return strtolower($handle);
}

foreach (['ADA', 'grace', ''] as $input) {
    try {
        $name = findUser($users, requireHandle($input));
        echo $input, ': ', $name ?? 'no such user', "\n";
    } catch (InvalidArgumentException $e) {
        echo 'Bug: ', $e->getMessage(), "\n";
    }
}

Mais dois hábitos mantêm o código com exceções legível: nunca capture uma exceção só para ignorá-la (um catch (Exception $e) {} vazio esconde o próximo bug de verdade), e lance classes específicas em vez de Exception simples, para que quem chama nunca seja obrigado a capturar tudo para tratar um caso.