Code propre en PHP – Principes fondamentaux et meilleures pratiques

[Mis à jour PHP 8.3]

Destiné aux développeurs PHP, cet article présente les principes et les meilleures pratiques pour un code PHP lisible, maintenable et efficace.

Introduction

Cet article est destiné à aider les développeurs PHP à écrire du code propre, en se concentrant sur la lisibilité, la simplicité, et la maintenabilité. Le code propre minimise les erreurs et rend le développement collaboratif plus facile.

1. Utilisez des Noms Significatifs

// Mauvais exemple
function get($n) {
    return $n + 10;
}

// Bon exemple
function addTen(int $number): int {
    return $number + 10;
}

Les noms de fonctions et de variables doivent être explicites pour améliorer la compréhension du code.

2. Gardez les Fonctions Courtes

Une fonction devrait faire une seule chose. Si elle en fait plusieurs, envisagez de la diviser en plusieurs fonctions.

// Exemple de PHP 8.3 avec une utilisation de la syntaxe améliorée
function calculatePriceWithTax(float $price, float $taxRate): float {
    return $price * (1 + $taxRate);
}

3. Utilisez des Constantes

Les constantes sont particulièrement utiles pour les valeurs fixes qui ne changeront jamais pendant l’exécution.

define("TAX_RATE", 0.20); // En PHP 8.3, préférez les constantes de classe si possible

4. Évitez les Effets de Bord

Les effets de bord surviennent lorsqu’une fonction modifie quelque chose en dehors de sa portée. Évitez cela autant que possible.

// Mauvais exemple
function addToStock($product, $quantity) {
    global $stock;
    $stock[$product] += $quantity;
}

// Bon exemple
function addToStock(array &$stock, $product, $quantity) {
    $stock[$product] += $quantity;
}

5. Favorisez les Fonctions Pures

Les fonctions pures sont prévisibles et testables car elles n’ont pas d’effets de bord et produisent toujours le même résultat pour les mêmes arguments.

// Exemple de fonction pure
function multiply(int $a, int $b): int {
    return $a * $b;
}

6. Évitez les Conditions Complexes

Les conditions imbriquées peuvent être source de confusion. Préférez les early returns pour rendre le code plus lisible.

// Mauvais exemple
function calculateDiscount($customer) {
    if ($customer->years > 3) {
        if ($customer->totalPurchases > 1000) {
            return 20;
        }
    }
    return 0;
}

// Bon exemple
function calculateDiscount($customer): int {
    if ($customer->years <= 3) {
        return 0;
    }

    return $customer->totalPurchases > 1000 ? 20 : 0;
}

7. Utilisez le Typage pour Éviter les Erreurs

PHP 8.3 renforce le typage. Utilisez-le pour améliorer la sécurité et la robustesse du code.

function add(int $a, int $b): int {
    return $a + $b;
}

8. Traitez les Erreurs avec des Exceptions

Les exceptions facilitent la gestion des erreurs et assurent un flux d’exécution propre en cas de problème.

function divide(float $dividend, float $divisor): float {
    if ($divisor === 0.0) {
        throw new DivisionByZeroException("Division by zero");
    }
    return $dividend / $divisor;
}

Conclusion

En suivant ces principes, votre code PHP sera plus clair, plus maintenable, et moins sujet aux erreurs. Un code propre facilite le travail en équipe et rend le développement plus agréable.

Nolwennig Guilbert Letouzé