Temps : compréhension de 20 lignes de codes
Domaine : php

Bonjour,

Lorsque vous codez en PHP, vous manipulez parfois des variables assez complexes comme des objets ou encore des résultats de validation de formulaires. Alors à un instant t vous ne savez plus ce que contient une ou plusieurs variables. Pour pallier à ce problème il existe des fonctions php qui permettent de visualiser le contenu des variables print_r() et var_dump(). Lors d'un projet sur lequel je travaillais avec un collègue de travail il a eu l'idée de cette fonction très simple :

function pre($objet)
{
    echo"<pre>";
    print_r($objet);
    echo"</pre>";
}

Grâce au formatage de la balise <pre> on obtient un résultat clair à l'écran. Après avoir travaillé encore et encore avec cette fonction je n'ai pas cessé de l'améliorer et j'ai obtenu le résultat suivant :

function pre($var, $nAff=false){
    ob_start();
    echo '<pre style="text-align: left; white-space: pre;">';
   
    switch(gettype($var)){
    case "array": case "object":
        print_r($var);
        break;
    default:
        var_dump($var);
    }
    echo '</pre>';
   
    $resu = ob_get_contents();
    ob_end_clean();
   
    if(!$nAff)
        echo $resu;
   
    return $resu;
}
Maintenant une petite explication serait utile non ?

L'entête :

function pre($var, $nAff=false){


Il s'agit d'une fonction curieux n'est-ce pas ? Son nom pre lui vient des balises dans lesquelles sont placés l'affichage pour avoir un bon formatage (saut de lignes, tabulations, ...) et parce qu'il est court et simple...
$var c'est la variable que l'on veux étudier, par définition on y met m'importe quoi.
$nAff ce paramètre a été ajouté pour une raison très précise. Par défaut ce booléen est à Faux, cela signifie : "ne bloque pas l'affichage des informations". Donc si on met Vrai en second paramètre rien ne s'affichera.
Quelle est l'utilité ? Vous êtes surchargé de texte à afficher, l'idée vous viens de stocker le résultat dans un fichier, vous n'affichez rien et vous récupérez le tout en chaine de caractères avec le retour de fonction.

ob_start();

C'est quoi ça ?
Pour info : ob_start().
Définition : "Enclenche la tamporisation de sortie".
Définition humaine : "Place tout affichage suivant cette fonction en mémoire tampon sans l'afficher".
En gros l'affichage des informations qui nous intéressent est placé en mémoire sans être affiché.

echo '<pre style="text-align: left; white-space: pre;">';

Ici on affiche donc la balise de pré-formatage du texte avec un alignement à gauche et au cas où on replace la commande de pré-formatage.

    switch(gettype($var)){
    case "array": case "object":
        print_r($var);
        break;
    default:
        var_dump($var);
    }

Le selon est assez facile à comprendre si on sait le lire : gettype()  retourne une chaine de caractères indiquant le type de la variable et dans le cas d'un tableau ou d'un objet on utilise print_r et dans tous les autres cas var_dump. Si on utilise print_r pour les tableaux et objets c'est parce que var_dump est moins lisible.

echo '</pre>';

On termine l'affichage du formatage du texte.

$resu = ob_get_contents();

Maintenant on place dans une chaine de caractères les affichage de la mémoire tampon. ob_get_contents()

ob_end_clean();

On stoppe le stockage des affichages dans la mémoire tampon et on vide la mémoire tampon. ob_end_clean()

    if(!$nAff)
        echo $resu;

On choisit d'afficher ou pas le résultat.

return $resu;

On retourne le résultat pour l'utiliser au besoin, comme pour l'écrire dans un fichier.

Voilà voilà cette fonction ne sert que pendant la réalisation de votre code, elle est vouée à en disparaître mais elle vous aidera lors de vos tests. Pour finir une petite démonstration :

l'url de ma page : http://localhost/site/pre.php?a=12593

Le code :

<?php

$var1 = array(1, "quatre" => "test", "plop");
$var2 = false;
$var3 = null;
$var4 = "youpi";
$var5 = $_GET;

pre($var1);
pre($var2);
pre($var3);
$texteVar4 =  pre($var4, true);
pre($var5);

echo $texteVar4;

// juste pour le fun :

echo $var1;
print_r($var1);
var_dump($var1);
?>

Et son résultat HTML :

Array
(
    [0] => 1
    [quatre] => test
    [1] => plop
)

bool(false)

NULL

Array
(
    [a] => 12593
)

string(5) "youpi"


ArrayArray ( [0] => 1 [quatre] => test [1] => plop ) array(3) { [0]=> int(1) ["quatre"]=> string(4) "test" [1]=> string(4) "plop" }