CPDF_IMPORT_JPEG |
Conversion de PDF : Importe le JPEG |
|---|---|
| PHP 3.0.9 à 5.0.4 | Extension CLIBPDF |
Syntaxe
| function cpdf_import_jpeg($pdf_document, $file_name, $x_coor, $y_coor, $angle, $width, $height, $x_scale, $y_scale, $gsave); |
| function cpdf_import_jpeg($pdf_document, $file_name, $x_coor, $y_coor, $angle, $width, $height, $x_scale, $y_scale, $gsave, $mode); |
Paramètres
| Nom | Description |
|---|---|
| $pdf_document | Ce paramètre permet d'indiquer l'objet de document PDF. |
| $file_name | Ce paramètre permet d'indiquer le nom du fichier contenant l'image JPEG. |
| $x_coor | Ce paramètre permet d'indiquer la coordonnées horizontal où doit être mise l'image. |
| $y_coor | Ce paramètre permet d'indiquer la coordonnées vertical où doit être mise l'image. |
| $angle | Ce paramètre permet d'indiquer l'angle que doit avoir l'image. |
| $width | Ce paramètre permet d'indiquer la largeur que doit avoir l'image. |
| $height | Ce paramètre permet d'indiquer la hauteur que doit avoir l'image. |
| $x_scale | Ce paramètre permet d'indiquer l'échelle horizontal de l'image (proportion). |
| $y_scale | Ce paramètre permet d'indiquer l'échelle vertical de l'image (proportion). |
| $gsave | Ce paramètre permet d'indiquer la sauvegarde graphique. ATTENTION ! Cette valeur ne peut pas être nulle pour que cette fonction fonctionne. |
| $mode | Ce paramètre permet d'indiquer l'unité de longueur. |
Description
Cette fonction permet d'ouvrir une image JPEG contenu dans un fichier et de le mettre 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 charger une image JPEG depuis un fichier et de l'insérer dans un document PDF. Cela permet d'ajouter des illustrations, logos ou photos directement dans le contenu PDF, avec un contrôle précis sur la position et la taille.
- Le paramètre $pdf_document est obligatoire car il identifie le document PDF dans lequel l'image doit être insérée. Sans ce paramètre, la fonction ne saurait pas où appliquer l'image, ce qui rend l'appel inefficace.
- Les paramètres $x_coor et $y_coor définissent la position horizontale et verticale de l'image sur la page PDF. Ils déterminent le point de référence où l'image sera placée, généralement le coin inférieur gauche de l'image, ce qui permet un positionnement précis.
- Les paramètres $angle, $width, $height, $x_scale et $y_scale permettent de modifier l'orientation, la taille et l'échelle de l'image. Cela offre une grande flexibilité pour ajuster l'image selon les besoins du document sans modifier le fichier source.
- Le paramètre $gsave est essentiel pour la sauvegarde graphique, car il préserve l'état du contexte graphique avant d'appliquer la transformation ou le positionnement de l'image. Il ne peut pas être nul, sinon la fonction ne fonctionne pas correctement.
- Le paramètre optionnel $mode permet de spécifier l'unité de longueur utilisée pour le positionnement et la taille de l'image. Cela peut être utile pour travailler dans différentes unités (points, millimètres, pouces) selon le format du PDF ou les conventions du projet.
- Comme cette fonction est obsolète, son utilisation peut rendre le code difficile à maintenir. Les bibliothèques modernes comme TCPDF ou FPDF offrent des fonctions plus robustes et intuitives pour insérer des images JPEG ou autres formats, avec des options supplémentaires comme la transparence, le recadrage ou la mise à l'échelle automatique.
Dernière mise à jour : Mercredi, le 25 mars 2015