Php

Comment trouver des `Fonctions non utilisées` dans votre projet PHP

En tant que développeur, maintenir une base de code propre et efficace est crucial pour la santé à long terme de tout projet. Un problème courant qui peut alourdir votre code et contribuer à la dette technique est la présence de fonctions non utilisées. Dans cet article de blog, nous allons explorer comment vous pouvez efficacement identifier ces fonctions non utilisées dans vos projets PHP, en utilisant à la fois des fonctionnalités intégrées de PHP et un script personnalisé.

L’importance d’identifier les fonctions non utilisées

Les fonctions non utilisées peuvent entraîner :

Ressources gaspillées : Un code superflu occupe de l’espace et peut ralentir votre application.
Complexité : Plus de code signifie plus de complexité, rendant votre projet plus difficile à naviguer et à maintenir.
Risques de sécurité : Un code inutilisé pourrait involontairement exposer des vulnérabilités encore non découvertes.

Trouver et supprimer ces fonctions est essentiel pour une gestion optimale du code.

Utiliser les fonctionnalités de PHP pour localiser les fonctions non utilisées

PHP offre certaines fonctionnalités intégrées que vous pouvez exploiter pour analyser votre base de code. Deux fonctionnalités notables incluent :

Réflexion : Elle permet de réfléchir sur les classes, les méthodes et les fonctions pour comprendre leur utilisation.
Tokenisation avec token_get_all() : Cette fonction vous permet de parser du code PHP en tokens, facilitant ainsi l’identification de la structure du code.

Cependant, s’appuyer uniquement sur ces fonctionnalités pourrait ne pas vous donner une vision complète, c’est pourquoi un script personnalisé peut être utile.

Une solution rapide et sale : Script PHP personnalisé

Basé sur des recherches récentes et des retours de la communauté, voici un script personnalisé pour vous aider à trouver des fonctions non utilisées dans votre projet PHP. Ce script analyse votre répertoire de projet, identifie les définitions de fonctions et leurs références, puis présente les résultats dans un format lisible.

Étape 1 : Configurer votre environnement

Assurez-vous d’avoir un environnement PHP configuré.
Assurez-vous que le chemin de votre répertoire de projet est exact.
Copiez le script suivant dans un nouveau fichier .php.

Étape 2 : Le script PHP

<?php
$functions = array();
$path = "/chemin/vers/mon/projet/php"; // Mettez à jour ce chemin vers votre répertoire de projet.
define_dir($path, $functions);
reference_dir($path, $functions);
echo "<table>";
echo "<tr><th>Nom</th><th>Défini</th><th>Référencé</th></tr>";
foreach ($functions as $name => $value) {
    echo "<tr><td>" . htmlentities($name) . "</td>";
    echo "<td>" . (isset($value[0]) ? count($value[0]) : "-") . "</td>";
    echo "<td>" . (isset($value[1]) ? count($value[1]) : "-") . "</td></tr>";
}
echo "</table>";

function define_dir($path, &$functions) {
    if ($dir = opendir($path)) {
        while (($file = readdir($dir)) !== false) {
            if (substr($file, 0, 1) == ".") continue;
            if (is_dir($path . "/" . $file)) {
                define_dir($path . "/" . $file, $functions);
            } else {
                if (substr($file, - 4) != ".php") continue;
                define_file($path . "/" . $file, $functions);
            }
        }
    }       
}

function define_file($path, &$functions) {
    $tokens = token_get_all(file_get_contents($path));
    for ($i = 0; $i < count($tokens); $i++) {
        $token = $tokens[$i];
        if (is_array($token) && $token[0] == T_FUNCTION) {
            $i++;
            $token = $tokens[$i + 1]; // Obtenez le nom de la fonction suivante
            if (is_array($token) && $token[0] == T_STRING) {
                $functions[$token[1]][0][] = array($path, $token[2]); // Stocker la définition de la fonction
            }
        }
    }
}

function reference_dir($path, &$functions) {
    if ($dir = opendir($path)) {
        while (($file = readdir($dir)) !== false) {
            if (substr($file, 0, 1) == ".") continue;
            if (is_dir($path . "/" . $file)) {
                reference_dir($path . "/" . $file, $functions);
            } else {
                if (substr($file, - 4) != ".php") continue;
                reference_file($path . "/" . $file, $functions);
            }
        }
    }       
}

function reference_file($path, &$functions) {
    $tokens = token_get_all(file_get_contents($path));
    for ($i = 0; $i < count($tokens); $i++) {
        $token = $tokens[$i];
        if (is_array($token) && $token[0] == T_STRING) {
            if ($tokens[$i + 1][0] == "(") { // Vérifiez si c'est un appel de fonction
                $functions[$token[1]][1][] = array($path, $token[2]); // Stocker la référence de la fonction
            }
        }
    }
}
?>

Étape 3 : Exécuter le script

Mettez à jour la variable $path dans le script pour pointer vers le répertoire de votre projet PHP.
Exécutez le script via votre ligne de commande ou serveur web.
La sortie sera un tableau HTML affichant toutes les fonctions, le nombre de fois qu’elles sont définies et le nombre de fois qu’elles sont référencées.

Conclusion

Ce script personnalisé vous offre un moyen efficace de traquer les fonctions non utilisées dans votre projet PHP. Bien que les fonctionnalités intégrées de PHP telles que la réflexion et token_get_all() soient puissantes, disposer d’un script sur mesure peut rationaliser le processus d’identification et de gestion des fonctions inutilisées. En tant que meilleure pratique, envisagez de faire fonctionner ce script périodiquement pour maintenir votre base de code propre et efficace.

En maintenant votre projet en ordre, vous améliorez non seulement ses performances, mais vous facilitez également la maintenance et la collaboration à long terme.

Comment trouver des Fonctions non utilisées dans votre projet PHP