CPDF_ADD_OUTLINE

Syntaxe

Paramètres

Description

Cette fonction permet d'ajouter un signet à la page courante d'un document de format PDF. Cette fonction est obsolète.

Remarques

• L'extension CLIBPDF initialement proposé à partir du PHP 3 a été progressivement retiré jusqu'à la version 5 du PHP où elle fut remplacé par l'extension PDFLIB, laquelle est utilisé par de nombreux langages de programmations autre que le PHP. Si vous ne pouvez pas installer un extension supplémentaire, vous pouvez utiliser la bibliothèque gratuite et open source entièrement écrit en PHP pure FPDF Library développé par Olivier PLATHEY.
• La fonction cpdf_add_outline() permet d'ajouter un signet (ou marque-page) dans un document PDF&nbs;: Cela facilite la navigation dans un document volumineux en structurant le contenu avec des entrées hiérarchiques accessibles dans l'arborescence du lecteur PDF.
• Le paramètre $sublevel est utile pour organiser des signets hiérarchiques : Il permet de créer une structure en niveaux (parent/enfant), ce qui est idéal pour représenter un sommaire ou diviser un rapport en chapitres et sous-chapitres.
• Le paramètre $open permet de définir si le signet est affiché ouvert ou replié : Cela influence directement l'expérience de lecture, notamment si l'on souhaite que certaines sections soient visibles par défaut à l'ouverture du document.
• Le numéro de page ($pagenr) permet d'associer chaque signet à une position précise dans le document : Il est crucial de bien connaître la pagination du PDF pour que chaque signet mène à la bonne section.
• Le paramètre $text détermine le libellé du signet visible par l'utilisateur : Il est conseillé de le rendre clair et significatif pour que l'utilisateur comprenne immédiatement à quelle section il correspond.
• Cette fonction repose sur l'extension CLIBPDF, qui est désormais obsolète et non maintenue : Son usage est risqué en environnement de production moderne. Pour la génération de signets avec du code PHP actuel, il est préférable d'utiliser des bibliothèques comme TCPDF ou FPDF.
• Le paramètre $lastoutline permet de rattacher le nouveau signet à un signet précédent : Cela offre un contrôle précis sur la relation entre les différents niveaux de signets, mais peut s'avérer complexe à gérer si les identifiants ne sont pas suivis rigoureusement.
• L'utilisation de signets améliore considérablement l'accessibilité et la lisibilité des documents PDF complexes : Les utilisateurs peuvent accéder plus rapidement aux sections souhaitées sans faire défiler manuellement l'intégralité du document.