Documentation du module Powerful Form Generator

Transcription

Documentation du module Powerful Form Generator
Documentation du module
Powerful Form Generator
Installation Configuration Usage Création, modification d'un formulaire Gestion des champs Voir la liste des enregistrements Utilisation des Hooks pour afficher le formulaire Utilisation des hooks pour affichage en page CMS Mettre en place une url dédiée pour chacun de vos formulaires Le formulaire n'est pas visible, pourquoi ? Contact Merci ! Installation
L'installation de ce module est très simple. Rendez­vous simplement dans l'administration de votre site Prestashop, onglet "Module", cliquez sur "Ajouter un nouveau module", sélectionnez l'archive et voilà ! :) Une fois installé, vous trouverez un nouveau menu dans la section "Modules", appelé "​
Powerful Form Generator​
". Tout ce gère ici. Configuration
Il n'y a aucune configuration requise pour ce module. Usage
Une fois que vous êtes dans la page du module (via ​
Modules > Powerful Form Generator)​
, vous pourrez configurer vos différents formulaires. Création, modification d'un formulaire
Lors de la création/modification d'un formulaire, vous pouvez préciser divers champs, dont : ● Le type d'email à envoyer à l'émetteur : ○ Message : Un message à envoyer à l'émetteur (que vous pouvez définir plus bas) ○ Form : Le formulaire remplis ○ Rien : Ne rien envoyer à l'émetteur ● Le type d'email à envoyer aux destinataires. Les actions sont les mêmes. ● La possibilité de donner l'accès à ce formulaire à vos utilisateurs connectés uniquement, ou à tout le monde ● Le type de formulaire que vous voulez (accessible via une URL ou uniquement par Hook) ● Une liste d'email qui corresponds aux destinataires. Pensez à bien séparer les emails par des virgules si vous voulez ajouter plusieurs emails. ● Un message à afficher avant ou après le formulaire ● Un message de remerciement personalisable Gestion des champs
Dans le listing, vous trouverez des icônes à droite, dont un engrenage. Cet engrenage vous permet d'ajouter, modifier et supprimer des champs. Lors de la création/modification d'un champ, vous pouvez remplir les différentes valeurs. Il faut savoir que le champs "Valeurs" n'est utilisé que si le type est défini à : ● Select​
: Le champs valeurs correspondra alors à une liste de valeurs, séparée par des virgules ● Radio​
: Le champs valeurs correspondra alors à une liste de boutons radio à afficher avec le texte à droite, séparé par des virgules ● Fichier​
: Une liste d'extensions autorisées, séparée par des virgules, sans le point. L'autre champ important est "Lier ce champ à". Vous pourrez trouver ces trois options : ●
●
●
Email de l'émetteur​
: Ce champ sera utilisé comme l'email de l'émetteur. Vous devez définir un type à Email Sujet de l'email​
: Ce champ sera utilisé en tant que sujet de l'email. Vous pouvez choisir un type Select ou texte standard Newsletter​
: Ce champ (de type checkbox), si coché par votre client, enregistrera ce client dans la newsletter. Enfin, vous trouverez aussi d'autres champs qui permettront d'améliorer l'affichage visuel de vos champs : ● Classe​
: Indiquez ici une ou plusieurs classe CSS. Vous pourrez reprendre le nom de cette classe dans votre feuille de style afin de personnaliser l'affichage de votre champs. ● Style (css)​
: Vous pouvez dans cette partie directement mettre vos style css, tel que "border: solid red 1px". Cela permet de personnaliser les champs un à un avec un style dédié. ● Extra​
: Cette section vous permet d'ajouter des attributs à votre champ, comme l'attribut "multiple" pour un champ de type select, une limitation sur le nombre de caractères, etc. Voir la liste des enregistrements
Afin de voir la liste des enregistrements, vous pouvez cliquer sur le titre de votre formulaire, ou sur l'icône avec la loupe. Vous pourrez voir les différentes entrées, et exporter ces entrées au format CSV. C'est aussi dans cette partie que vous trouverez le lien vers votre formulaire sur le front­end de votre site. Normallement, vous trouverez le message "Cliquez­ici pour voir le formulaire" si le formulaire est accessible depuis le site vitrine. Si ce lien n'est pas présent, c'est probablement car vous avez désactivé le formulaire. Il n'est donc pas visible depuis votre frontend, d'où le lien non affiché. Enfin, vous pourrez lire n’importe quelle entrée du formulaire en détail juste en cliquant sur la ligne souhaitée : Utilisation des Hooks pour afficher le formulaire
Quand vous créez un formulaire, vous avez la possibilité de le rendre accessible via une URL ou uniquement par HOOK. Si vous décidez de passer uniquement par un HOOK, vous aurez la liberté de le placer ou vous voulez dans votre thème. Ajoutez simplement la ligne suivante ou vous voulez, et le formulaire s'affichera à l'endroit désiré: {hook h='displayPowerfulForm' mod='powerfulformgenerator' id=$idPfg}
NOTE​
: N'oubliez pas de remplacer la valeur `​
$idPfg​
` par le bon ID. (La valeur de l'ID se trouve dans la première colonne du listing de vos formulaire (​
Back office Prestashop > Modules > Powerful Form Generator)​
, just après la case à cocher.) Utilisation des hooks pour affichage en page CMS
L’avantage des hooks est de pouvoir les placer ou vous souhaitez. Pour afficher votre formulaire dans une page CMS, il vous faudra modifier le fichier cms.tpl localisé dans le dossier /theme/{votre_theme}/cms.tpl. Trouvez la ligne : <div class="rte{if $content_only} content_only{/if}">
Et mettez juste avant, ceci : {if $cms->id == X}
{hook h='displayPowerfulForm' mod='powerfulformgenerator' id=Y}
{/if}
Il vous faudra remplacer les deux valeurs suivantes : ● X = L’ID de votre page CMS (la première colonne dans votre back­office). ● Y = L’ID de votre formualire (la première colonne dans votre back­office). Et voila, vous pouvez accéder à votre formulaire via une page CMS. Mettre en place une url dédiée pour chacun de vos formulaires
Par défaut, Prestashop permet seulement de faire une url réécrite par module (url rewritting). Mais dans le cas du PowerfulFormGenerator, il se pourrait que vous aillez besoin de créer une url réécrite PAR formulaire. Dans ce cas, une solution existe. Vous devez modifier le fichier .htaccess et ajouter cette ligne à la fin du fichier, juste avant "#Dispatcher": RewriteRule ^​
contactez-nous-special​
$
%{ENV:REWRITEBASE}index.php?fc=module&module=powerfulformgenerator&co
ntroller=display&​
id=1​[QSA,L]
Remarquez que vous devez changer deux valeurs a la ligne précédente : 1. Remplacez le "​
contactez­nous­special​
" par la valeur que vous souhaitez mettre dans votre URL réécrite 2. Remplacez la valeur "​
id=1​
" par l'id du formulaire que vous souhaitez afficher. Le formulaire sera alors accessible via l'adresse ​
/contactez-nous-special​
(dans le cas de notre example). Le formulaire n'est pas visible, pourquoi ?
Quelques raisons peuvent expliquer cette situation : 1. Avez­vous activé le formulaire (Un check vert doit être visible dans le listing des formulaires, vers le formulaire en question) 2. Avez­vous créer des champs pour ce formulaire ? 3. Avez­vous autorisé l'accés uniquement aux personnes connectées et vous n'êtes pas un "client" connecté lorsque vous tentez d'afficher le formulaire? Contact
Vous avez découvert un bug, vous avez des problèmes pour installer/configurer/utiliser ce module ? N'hésitez pas à me contacter via le site de Prestashop à cette url https://addons.prestashop.com/en/2_community?contributor=130560​
et je ferai de mon mieux pour vous aider. Merci !
Vous avez acheté un de mes modules, et pour ça je tenais à vous remercier.