CPDF_FINALIZE_PAGE

Syntaxe

Paramètres

Description

Cette fonction permet d'indiquer la fin d'une page 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.
• Son rôle principal est de finaliser une page individuelle dans un document PDF. Cela signifie qu'après son appel, le contenu ajouté à cette page est considéré comme terminé, et aucun texte ou élément graphique supplémentaire ne peut y être inséré.
• Le paramètre $pdf_document est obligatoire car il identifie le document PDF dans lequel la page doit être finalisée. Sans ce paramètre, la fonction ne saurait pas sur quel fichier appliquer la finalisation de page, rendant l'appel inutile.
• Le paramètre $page_number permet de spécifier la page exacte à finaliser. Cela est important pour les documents multi-pages, où chaque page peut contenir des contenus distincts et doit être clôturée individuellement pour garantir la structure correcte du PDF.
• cpdf_finalize_page doit être appelée après avoir ajouté tout le contenu à la page : texte, formes, images ou tracés. Toute modification ultérieure sur la page après cet appel risque de ne pas être prise en compte ou de provoquer des erreurs.
• Comme la fonction est obsolète, son utilisation peut rendre le code difficile à maintenir et moins compatible avec PHP moderne. Les bibliothèques actuelles comme TCPDF, FPDF ou mPDF gèrent automatiquement la finalisation des pages lors de l'ajout de nouvelles pages ou de la fermeture du document.
• Cette fonction illustre la philosophie des anciennes bibliothèques PDF, qui exigeaient un contrôle manuel précis : chaque page devait être finalisée explicitement pour que la structure interne du document reste valide et lisible par les lecteurs PDF.
• Ne pas utiliser cpdf_finalize_page après avoir complété une page peut entraîner des pages incomplètes ou corrompues, car les objets internes et les flux de la page ne seront pas correctement finalisés. Cela souligne l'importance de respecter l'ordre exact des appels dans CLIBPDF pour garantir un rendu correct.