Classes d'exception

Fait partie de la section Programmation Orientée Objet du Journey PHP de Coddy — leçon 66 sur 91.

En PHP, les exceptions sont des objets utilisés pour signaler que quelque chose s'est mal passé pendant l'exécution. La classe de base pour toutes les exceptions est Exception, et comprendre sa structure vous aide à gérer les erreurs efficacement dans vos applications POO.

Lorsque vous lancez une exception, vous créez une instance de la classe Exception (ou d'une sous-classe) avec un message décrivant ce qui s'est mal passé :

<?php
class BankAccount {
    public function __construct(private float $balance = 0) {}
    
    public function withdraw(float $amount): float {
        if ($amount > $this->balance) {
            throw new Exception("Insufficient funds");
        }
        $this->balance -= $amount;
        return $amount;
    }
}

$account = new BankAccount(100);
$account->withdraw(150);

Cela produirait une erreur d'exception non capturée avec le message "Insufficient funds".

PHP fournit plusieurs classes d'exception intégrées pour différentes situations. InvalidArgumentException signale une entrée incorrecte, RuntimeException indique des erreurs lors de l'exécution, et LogicException représente des erreurs de programmation :

<?php
class Calculator {
    public function divide(int $a, int $b): float {
        if ($b === 0) {
            throw new InvalidArgumentException("Cannot divide by zero");
        }
        return $a / $b;
    }
}

Chaque objet d'exception contient des informations utiles : getMessage() retourne le message d'erreur, getCode() retourne un code d'erreur optionnel, getFile() et getLine() indiquent où l'exception a été levée. L'utilisation de types d'exception spécifiques rend l'intention de votre code plus claire et permet une gestion des erreurs plus précise.

Défi

Facile

Construisons un système de gestion d'inventaire qui utilise les classes d'exception intégrées de PHP pour signaler différents types de problèmes. Vous allez créer un inventaire de produits où les opérations peuvent échouer de manières spécifiques et significatives.

Vous organiserez votre code sur trois fichiers :

Product.php — Créez une classe Product qui représente un article dans l'inventaire. Utilisez la promotion de constructeur pour un $sku public (string), un $name public (string) et une $quantity privée (int). Votre classe doit avoir :
- Une méthode getQuantity(): int qui retourne la quantité actuelle
- Une méthode addStock(int $amount): void qui augmente la quantité. Si le montant est inférieur à 1, lancez une InvalidArgumentException avec le message "Amount must be positive"
- Une méthode removeStock(int $amount): void qui diminue la quantité. Si le montant est inférieur à 1, lancez une InvalidArgumentException avec le message "Amount must be positive". Si le montant dépasse la quantité actuelle, lancez une RuntimeException avec le message "Insufficient stock"
Inventory.php — Créez une classe Inventory qui gère une collection de produits. Incluez le fichier Product. Votre classe doit avoir :
- Un tableau privé pour stocker les produits indexés par SKU
- Une méthode addProduct(Product $product): void qui ajoute un produit. Si un produit avec le même SKU existe déjà, lancez une LogicException avec le message "Product already exists: [sku]"
- Une méthode getProduct(string $sku): Product qui retourne un produit par SKU. S'il n'est pas trouvé, lancez une InvalidArgumentException avec le message "Product not found: [sku]"
main.php — Incluez le fichier Inventory. Vous recevrez trois entrées : un SKU, un nom de produit et une opération ("add", "remove" ou "duplicate").
Créez un Inventory et ajoutez un nouveau Product avec le SKU donné, le nom et une quantité initiale de 10.

Selon l'opération :
- "add" : Appelez addStock(5) sur le produit, puis affichez "Stock updated: [quantity]"
- "remove" : Appelez removeStock(15) sur le produit (cela devrait lancer une exception)
- "duplicate" : Essayez d'ajouter un autre produit avec le même SKU (cela devrait lancer une exception)
Lorsqu'une exception est lancée, affichez le nom de la classe de l'exception suivi de ": " et du message de l'exception. Utilisez la fonction get_class() de PHP pour obtenir le nom de la classe.

Ce défi démontre comment différents types d'exceptions communiquent différents types de problèmes — entrées invalides, échecs d'exécution et erreurs de logique — rendant la gestion des erreurs de votre code plus précise et significative.

Aide-mémoire

En PHP, les exceptions sont des objets qui signalent des erreurs lors de l'exécution. La classe de base est Exception.

Pour lever une exception, créez une instance avec un message descriptif :

<?php
class BankAccount {
    public function __construct(private float $balance = 0) {}
    
    public function withdraw(float $amount): float {
        if ($amount > $this->balance) {
            throw new Exception("Insufficient funds");
        }
        $this->balance -= $amount;
        return $amount;
    }
}

PHP fournit des classes d'exception intégrées pour différentes situations :

InvalidArgumentException — signale une entrée invalide
RuntimeException — indique des erreurs lors de l'exécution
LogicException — représente des erreurs de programmation

<?php
class Calculator {
    public function divide(int $a, int $b): float {
        if ($b === 0) {
            throw new InvalidArgumentException("Cannot divide by zero");
        }
        return $a / $b;
    }
}

Les objets d'exception fournissent des méthodes utiles :

getMessage() — retourne le message d'erreur
getCode() — retourne un code d'erreur optionnel
getFile() — retourne le fichier où l'exception a été levée
getLine() — retourne le numéro de ligne où l'exception a été levée

Utilisez get_class() pour récupérer le nom de la classe d'un objet d'exception.

Essayez vous-même

<?php

require_once 'Inventory.php';

// Lire les entrées
$sku = trim(fgets(STDIN));
$name = trim(fgets(STDIN));
$operation = trim(fgets(STDIN));

try {
    // TODO: Créer un Inventaire (Inventory)
    // TODO: Créer un Produit (Product) avec le SKU, le nom donnés et une quantité initiale de 10
    // TODO: Ajouter le produit à l'inventaire
    
    // TODO: Selon l'opération :
    // - "add": Appeler addStock(5) sur le produit, puis afficher "Stock updated: [quantity]"
    // - "remove": Appeler removeStock(15) sur le produit
    // - "duplicate": Essayer d'ajouter un autre produit avec le même SKU
    
} catch (Exception $e) {
    // TODO: Afficher le nom de la classe de l'exception suivi de ": " et du message
    // Astuce : Utiliser get_class($e) pour obtenir le nom de la classe
}

?>