Licence CC BY-NC-ND

Utiliser le DOM pour générer un sommaire en PHP

Comment générer un sommaire à partir d'un bout de HTML en PHP ? En utilisant le DOM, pardi !

Publié :
Auteur :
Catégorie :
Temps de lecture estimé : 5 minutes

Imaginez : vous avez créé un site vous permettant d’écrire des pages à la volée, par exemple via un parseur MarkDown (ou BBCode si vous avez de la bouteille) ou via un éditeur WYSIWYG, mais vous voulez générer automatiquement des sommaires pour faciliter la navigation de vos utilisateurs.

Vous avez alors deux solutions :

  1. Utiliser du JavaScript côté client, imposant un délai et nécessitant des ressources en plus pour l’utilisateur
  2. Utiliser PHP côté serveur pour servir la page avec le sommaire directement, y compris aux robots de référencement

Pragmatiques, vous préférez un site léger pour l’utilisateur : c’est parti pour le faire en PHP !

Problème : Vous avez besoin de traiter un DOM partiel et plusieurs niveaux de titres, en plus de vouloir afficher le sommaire où vous le souhaitez.

Voyons donc comment utiliser le DOM en PHP pour faire tout ça nous-même, de A à Z !

Extraire le DOM

Partons du principe que l’on a une chaîne de caractère qui contient notre HTML (par exemple obtenu à partir d’un convertisseur de MarkDown, ou depuis un éditeur WYSIWYG).

Pour faire simple je vais définir un fichier HTML…

<p>Un texte d'intro</p>

<h1>Un premier titre</h1>

<h2>Un sous-titre</h2>
<p>Du texte</p>

<h2>Un autre sous-titre</h2>
<h3>Le PHP c'est génial</h3>
<p>Encore du texte</p>
<h3>On peut faire plein de choses !</h3>
<p>Toujours du texte</p>

<h1>Un second titre</h1>

<h2>Encore un sous-titre</h2>
<h3>Le PHP c'est vraiment génial</h3>
<p>Encore plus de texte</p>
<h3>On peut faire tout plein de choses !</h3>
<p>Toujours plus de texte</p>

<h2>Encore un autre sous-titre</h2>
<p>Vous reprendrez bien un peu de texte ?</p>

Attention : Ce tutoriel n’a pas pour but de vous apprendre la sécurité, n’oubliez pas de vous protéger contre les failles (notamment XSS) avant de traiter ou servir du contenu venant de l’extérieur.

… et le lire avec PHP :

<?php
$page_html = file_get_contents('texte.html');
$page_html = mb_convert_encoding($page_html, 'HTML-ENTITIES', 'UTF-8'); // On s'assure d'avoir de l'UTF-8

Attention : Votre HTML doit être valide pour pouvoir le parser, sans quoi vous pourriez rencontrer des erreurs par la suite

On commence alors par parser ce texte pour obtenir un DOM. Heureusement PHP a tout ce qu’il faut pour faire ce travail à notre place :

$page_dom = new DOMDocument('2.0', 'UTF-8'); // Mon texte HTML étant encodé en UTF-8, je peux préciser cet encodage au parseur
$page_dom->loadHTML($page_html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD); // On précise au parseur de ne pas ajouter de `doctype` ou de balises `<html><body>` inutiles

On obtient alors un objet représentant un DOM que l’on pourra alors parcourir pour récupérer les infos qui nous intéressent.

Parcourir le DOM

On peut alors créer une fonction qui, à partir d’un DOM, récupère les titres jusqu’au niveau désiré.

<?php
if (!function_exists('extract_toc')) {
    function extract_toc(DOMDocument $dom, int $max_level = 6) {
        // Notre code viendra s'insérer ici
    }
}

Avant de pouvoir parcourir notre DOM, il faut définir un chemin à suivre. Pour cela on utilise XPath, comme en XML :

$xpath = new DOMXPath($dom);
$xpath->registerNamespace('html', 'http://www.w3.org/1999/xhtml');

On peut ensuite calculer la liste des titres à récupérer :

$max_level = min(max($max_level, 1), 6); // Les titres en HTML vont de h1 à h6 maximum

$headings_queries = [];

foreach (range(1, $max_level) as $h) {
    $headings_queries[] = 'self::h'.$h; // Les requêtes XPath partent du nœud courant, pour chercher les balises `hX`
}

À noter que l’on pourrait raccourcir ce code en utilisant array_map par exemple, mais je préfère garder un code simple pour le moment. :)

On peut ensuite construire une requête unique qui nous donnera l’ensemble des titres d’un coup :

$query_headings = implode(' or ', $headings_queries); // On sélectionne toutes les balise `h1` ou `h2` ou `h3`, etc.
$query = '//*['.$query_headings.']'; // On part de la racine pour chercher les balises en question
$headings = $xpath->query($query);

Construire le HTML du sommaire

Maintenant que l’on a récupéré les titres, il va falloir construire notre sommaire !

Commençons par créer une liste en HTML :

if (count($headings)) {
    $toc = '<ol class="toc-level-1">';
    
    // La suite du code va venir ici, pour construire la liste
    
    $toc .= '</ol>';
}

return $toc ?? '';

Si on veut imbriquer les différents niveaux, on peut initialiser quelques variables :

$current_level = 1;
$items = 0;

J’utilise les fonctions url_title et xss_clean ci-dessous qui ne sont pas natives à PHP, il faudra donc les définir vous-même pour sécuriser votre application.
Vous pouvez recréer ces fonctions assez simplement :

  • url_title permet ici de transformer un texte en kebab-case
  • xss_clean filtre le texte pour empêcher les failles XSS (de façon un peu plus complète que htmlspecialchars) avant de l’envoyer aux clients

C’est parti, bouclons sur nos titres pour construire notre sommaire !

foreach ($headings as $n_i => $node){
    $level = (int) $node->tagName{1};
    $node_id = $node->getAttribute('id');

    if (empty($node_id)) {
        // On profite de l'occasion pour ajouter un ID à notre titre directement dans le DOM, pour pouvoir utiliser des ancres
        $node_id = 'toc_'.url_title(strip_tags($node->textContent), '-', TRUE);
        $node->setAttribute('id', $node_id);
    }

    // On crée un lien vers le titre en question
    $new_toc = '<a href="#'.$node_id.'">'.xss_clean($node->textContent).'</a>';

    // ==========================================
    // On va créer les éléments de la liste ici…
    //         Le code est un peu plus bas
    // ==========================================

    $current_level = $level;
    $items++;
}

La fonction strip_tags permet de supprimer les balise HTML contenues dans chaque titre pour ne pas polluer cet attribut id

Et maintenant pour la création du contenu de la liste, en gérant l’imbrication :

if ($level > $current_level) {
    // On monte d'un ou plusieurs niveaux, on crée une nouvelle liste
    for ($a = 0; $a < $level-$current_level; $a++) {
        $toc .= '<ol class="toc-level-'.$level.'"><li>';
    }
    $toc .= $new_toc;
    $items = 1;
}
elseif ($level === $current_level) {
    $toc .= ($items ? '</li>' : '').'<li>'.$new_toc;
    $items++;
}
else {
    // On descend d'un niveau, on ferme la liste
    for ($a = 0; $a < $current_level-$level; $a++) {
        $toc .= '</li></ol>';
    }
    $toc .= '</li><li>'.$new_toc;
    $items = 0;
}

Notez que l’on ne ferme pas les <li> juste après les liens, cela permet de gérer l’imbrication des <ol> au bon endroit.

Mais… les listes ne sont pas bien fermées !

C’est vrai ! Il faut donc, après la boucle, fermer les listes ouvertes :

for ($a = $level - 1; $a >= 0; $a--) {
    $toc .= '</li></ol>';
}

On peut maintenant utiliser notre fonction, en lui fournissant le DOM à parcourir, pour récupérer le nouveau HTML (celui avec les ancres) :

$page_toc = extract_toc($page_dom);

$page_html = $page_dom->saveHTML(); // On peut sauvegarder le DOM mis à jour par la fonction `extrat_toc` pour bénéficier des ancres

echo $page_toc; // On affiche notre sommaire

echo $page_html; // On affiche le contenu de notre HTML

Vous pouvez comparer votre code au mien sur GitHub si vous le souhaitez.


Bonus

Pour les plus motivés d’entre vous, vous pouvez utiliser une fonction récursive pour générer le sommaire… qui s’en sent capable ?
Encore mieux, vous pouvez aussi créer un DOM pour créer ces listes… vous êtes prêts ?


Icône du tutoriel par Lil Squid via Noun Project

Aucun commentaire

Connectez-vous pour pouvoir poster un message.
Connexion

Pas encore membre ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte