Installation

Pour installer la bibliothèque PHP, vous pouvez utiliser soit composer, soit la cloner ou la télécharger depuis GitHub pour l'inclure dans votre projet.

Via Composer

C'est la méthode recommandée, car elle vous permettra de bénéficier des mises à jour de façon très simple.

Ouvrez un terminal dans le dossier de votre projet, puis tapez :

composer require "pdfkiwi/php-lib"

Cloner ou télécharger la bibliothèque

Si vous ne voulez pas utiliser composer, vous pouvez soit :

  • faire un fork du projet sur votre compte Github (bouton fork tout en haut),
  • cloner directement depuis le dépôt officiel (bouton clone or download en haut),
  • télécharger une archive de la dernière version stable.

Pour cloner directement depuis le dépôt officiel, ouvrez un terminal dans un dossier de votre choix (par exemple ~/projects/web), puis tapez :

git clone https://github.com/pdfkiwi/php-lib.git

Enfin, il vous suffira de copier le contenu du dossier src à l'emplacement le plus approprié dans votre projet, puis d'inclure les classes PdfKiwi et PdfKiwiException dans les fichiers PHP qui devront utiliser la bibliothèque.

Exemple d'utilisation

Cet exemple part du principe que vous avez déjà inclut (via un autoload ou des require) les fichiers des classes PdfKiwi et PdfKiwiException dans le fichier qui va les utiliser.

<?php
use PdfKiwi\PdfKiwi;

try {
    // Instanciation de la classe PdfKiwi avec les identifiants d'accès à l'API
    $pdfKiwi = new PdfKiwi('email@example.net', '5a4b84c611eab7dd953b47aa6f89fb3');

    // Définition de quelques options
    $pdfKiwi->setPageMargins('10mm', '20mm', '10mm', '20mm');
    $pdfKiwi->setOrientation('landscape');

    // Appel à l'API pour convertir du HTML en PDF
    $pdf = $pdfKiwi->convertHtml('<h1>Testing pdf.kiwi awesomness</h1>');

    // Sauvegarde du contenu dans un fichier
    file_put_contents('downloads/test.pdf', $pdf);
} catch (PdfKiwiException $e) {
    // Affichage de l'éventuelle erreur
    echo sprintf("pdf.kiwi error %s:\n%s", $e->getCode(), $e->getMessage());
}

Liste des méthodes

Voici la liste de toutes les méthodes que la bibliothèque pdfkiwi/php-lib met à votre disposition pour définir les options de rendu PDF.

convertHtml()

Pour appeler l'API de pdf.kiwi afin de convertir une chaîne HTML en document PDF. Cette méthode est à utiliser après avoir éventuellement défini des options avec les méthodes décrites plus bas.

Paramètre :

$html (string) Le contenu HTML du document à convertir.

Note : Les balises <Doctype>, <html>, <head> et <body> sont facultatives.

setPageWidth()

Pour définir la largeur du document imprimé.

Paramètre :

$value (string) La largeur du document, avec l'unité (ex. '210mm')

setPageHeight()

Pour définir la hauteur du document imprimé.

Paramètre :

$value (string) La hauteur du document, avec l'unité (ex. '297mm')

setPageSize()

Pour définir la taille papier du document PDF. Voir la liste des tailles de page supportées.

Paramètre :

$value (string) La taille papier du document (ex. 'A3')

setHeaderHtml()

Pour définir un en-tête de page, au format HTML.

Paramètre :

$value (string) Le contenu HTML de l'en-tête de page (ex. '<span>Page {{page}} / {{topage}}</span>')

Note : Dans les header et footer, les chaînes entre doubles accolades ({{}}) sont interprétées comme des variables. La liste de ces variables est disponible dans la documentation des options.

setHeaderSpacing()

Pour définir l'espacement entre l'en-tête et le corps du document.

Paramètre :

$value (float) L'espacement (en mm) entre l'en-tête et le corps, sans l'unité (ex. `2.5`)

setHeaderText()

Pour définir des en-têtes de page au format TEXTE, placés à différents endroits.

Paramètres :

$value (mixed) Peut être soit :
  - (string) Le contenu (texte) de l'en-tête (sera placé à gauche)
  - (array) Un tableau avec 3 valeurs de texte, placés respectivement à : [gauche, centre, droite]

setFooterHtml()

Pour définir un pied de page, au format HTML.

Paramètre :

$value (string) Le contenu HTML du pied de page (ex. '<span>Page {{page}} / {{topage}}</span>')

Note : Dans les header et footer, les chaînes entre doubles accolades ({{}}) sont interprétées comme des variables. La liste de ces variables est disponible dans la documentation des options.

setFooterSpacing()

Pour définir l'espacement entre le pied de page et le corps du document.

Paramètre :

$value (float) L'espacement (en mm) entre le pied de page et le corps, sans l'unité (ex. `2.5`)

setFooterText()

Pour définir des pieds de page au format TEXTE, placés à différents endroits.

Paramètres :

$value (mixed) Peut être soit :
  - (string) Le contenu (texte) du pied de page (sera placé à gauche)
  - (array) Un tableau avec 3 valeurs de texte, placés respectivement à : [gauche, centre, droite]

setHeaderFooterPageExcludeList()

Pour définir une liste de numéros des pages sur lesquelles l'en-tête et le pied de page n'apparaîtront pas.

Paramètre :

$value (mixed) Peut être soit :
  - (string) Une liste de numéros de page, séparés par des virgules (sans espace, ex. '1,3,5')
  - (array) Un tableau contenant les numéros des pages (ex. [1, 3, 5])

setPageMargins()

Pour définir les marges de page.

Paramètres :

$top (string) Taille de la marge du haut, avec l'unité (ex. '20mm')
$right (string) Taille de la marge de droite, avec l'unité (ex. '20mm')
$bottom (string) Taille de la marge du bas, avec l'unité (ex. '20mm')
$left (string) Taille de la marge dde gauche, avec l'unité (ex. '20mm')

setOrientation()

Pour définir l'orientation des pages du document.

Paramètre :

$orientation (string) L'orientation du document.
                      Peut-être soit 'landscape' (paysage), soit 'portrait'.

résultats pour ""

    Aucun résultat pour ""