CPDF_ADD_ANNOTATION |
Conversion de PDF : Ajout d'une notation |
| PHP 3.0.12 à 5.0.4 |
Extension CLIBPDF |
Syntaxe
|
function cpdf_add_annotation($pdfdocument, $llx, $lly, $urx, $ury, $title, $content, $mode);
|
Paramètres
| Nom |
Description |
| $pdf_document |
Ce paramètre permet d'indiquer l'objet de document PDF. |
| $llx |
Ce paramètre permet d'indiquer la coordonnée horizontale du coin gauche. |
| $lly |
Ce paramètre permet d'indiquer la coordonnée verticale de la partie supérieur. |
| $urx |
Ce paramètre permet d'indiquer la coordonnée horizontale du coin droite. |
| $ury |
Ce paramètre permet d'indiquer la coordonnée verticale de la partie inférieur. |
| $title |
Ce paramètre permet d'indiquer le titre de la note. |
| $content |
Ce paramètre permet d'indiquer le contenu de la note. |
| $mode |
Ce paramètre permet d'indiquer l'unité de longueur. |
Description
Cette fonction permet d'ajouter une note à l'emplacement spécifié dans 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_annotation() permet d'ajouter une annotation directement dans un document PDF : Elle est utile pour enrichir un PDF avec des
commentaires ou remarques visibles, à des positions précises définies par des coordonnées, ce qui peut faciliter les échanges ou les validations.
- Les coordonnées spécifiées doivent être bien comprises pour un positionnement correct : Les paramètres $llx, $lly, $urx et $ury définissent une boîte
rectangulaire dans laquelle sera placée la note. Une erreur dans ces valeurs peut rendre la note invisible ou mal positionnée dans le document.
- L'unité de longueur ($mode) permet d'adapter les coordonnées au système choisi (points, mm, cm,...) : Cette souplesse permet d'adapter les annotations aux
dimensions spécifiques du document, selon les besoins d'impression ou d'affichage.
- Le paramètre $title n'est pas obligatoire pour le fonctionnement technique, mais essentiel pour la lisibilité : Un bon titre améliore la compréhension
du contenu de l'annotation, surtout dans les cas où plusieurs notes sont ajoutées dans un même document.
- Le contenu de la note ($content) doit être succinct et pertinent : Comme il s'affiche sous forme de bulle ou boîte, un texte trop long peut nuire à la
lisibilité ou au rendu visuel final. Il est conseillé de rester concis.
- Cette fonction est marquée obsolète et n'est plus disponible dans les versions modernes de PHP : Son usage est déconseillé dans de nouveaux projets. Il vaut
mieux se tourner vers des bibliothèques PDF plus récentes comme TCPDF, FPDF ou dompdf pour une meilleure compatibilité.
- Les annotations ajoutées sont visibles dans la plupart des lecteurs PDF classiques : Cela permet une bonne interopérabilité entre les documents générés
par PHP et les outils de lecture/édition PDF comme Adobe Acrobat Reader.
- Comme cette fonction dépend de l'extension CLIBPDF, elle nécessite une configuration spéciale du serveur : CLIBPDF n'étant plus maintenu, cela pose des
limites importantes à son utilisation en production, notamment en matière de sécurité, de support ou de portabilité.
Dernière mise à jour : Mercredi, le 25 mars 2015