PDForm syntaxe

Article complémentaire décrivant des fonctionnalités avancées du plugin PDForm : générer un PDF à partir de données éditoriales.

Résumé

Le plugin PDForm : générer un PDF à partir de données éditoriales permet de créer précisément des objets PDF, au millimètre près, à partir des données de votre site. La mise en page, c’est à dire le choix des éléments et leur emplacement dans le PDF, est définie par un objet Patron.

Pour cela, il est possible d’associer à un Patron 2 autres sortes d’objets, au moyen de l’interface dans la partie privée du site :
-  des Cellules : elles apportent des éléments textuels et leurs conditions d’affichage
-  des Cadrages : ils définissent où seront affichés les images.

Au moyen d’un peu de programmation, il est aussi possible de définir les éléments à afficher par le Patron par un Flot. Un flot est un flux de données sous la forme d’un tableau.

Les éléments précisés dans les objets ou le flot peuvent être statiques ou dynamiques. Le présent article présente les syntaxes qui permettent une utilisation dynamique.

1. L’objet Cellule

1.1 Le principe : définir ou non un objet nourricier

L’objet Cellule a pour finalité de fournir un élément de texte à afficher dans le PDF produit. La chaîne à imprimer dans le PDF est a indiquer dans un contrôle qui permet d’éditer du texte sur plusieurs lignes.

Si cette chaîne est une constante, par exemple Bonjour monde, indiquez la simplement dans la saisie :

Si vous souhaitez chercher l’information textuelle dans un objet SPIP, indiquez la table nourricière, par exemple celle de l’objet Auteur :

Vous pouvez ensuite indiquer entre deux @ quel est le nom du champ qui fournit la valeur :

1.2 Le dynamisme des références

Le caractère >, lorsqu’il suit la référence d’un champ @unchamp@ permet d’indiquer quelle source devra être utilisée en remplacement si ce champ ’unchamp’ n’est pas défini.

Il vous est possible d’avoir un exemple en procédant à un peuplement accessible lorsque vous lister les patrons. Dans l’exemple, vous trouverez une cellule dont le titre est bloc prenom nom avec plusieurs appels dont l’un est sous la forme :
@prenom@>@prenom_substitution@

@prenom_substitution@ est une clé qui va chercher une valeur dans les arguments transmis dans le flot par le formulaire par défaut.

Pour découvrir ce qu’est ce flot, regardez le fichier formulaires/pdform.php
Modifiez à la ligne 151 la valeur vide du flot par 'Jean-Luc'  :

'prenom_substitution' => 'Jean-Luc',

et regardez l’effet lors de la création du document PDF.

L’interprétation est la suivant : le plugin cherche si la table spip_auteurs à une colonne @prenom@. Si la table n’a pas de @prenom@, le plugin prend la valeur @prenom_subsitution@ donnée par le flot.

Voici une manipulation plus extraordinaire encore.
1°) Supprimez la clé et la valeur @prenom_subsitution@ dans le flot.
2°) Dans la cellule intitulée bloc prenom nom retirer l’opération @prenom@>@prenom_substitution@ et remplacez là par @prenom@>@email@.
Le plugin va, s’il ne trouve pas la colonne @prenom@ dans la table, recherchez la colonne @email@ de la même table et la proposée à la place.

2. L’objet Cadrage

2.1. Le principe : un lien vers une image

L’objet cadrage est principalement un lien vers une image, accompagné des paramètres pour afficher l’image.

2.2 Rendre dynamique le lien

Les cadrages n’ont pas de table nourricière ce qui semble rendre impossible le fait de rendre les urls dynamiques. Mais le plugin permet d’utiliser les identifiants uniques transmis au formulaire.

Par exemple, si vous créez un PDF en appelant un patron avec comme valeur auteur1, votre url peut allé chercher l’image via un lien dynamique auquel est ajoutée la valeur de l’identifiant unique de la table.

Discussion

Aucune discussion

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom