SPIP/gamuMail
SPIP/gamuMail
4
0
Fork 0
Code Issues 2 Pull requests Projects Releases Wiki Activity

correction de la doc

Browse source
This commit is contained in:
Christophe 2021-09-14 15:20:57 +02:00
parent 01db7f0715
commit 24eec4e076
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -54,7 +54,7 @@ et du formulaire d'envoi **formulaires/gamumail.html** : il permet de lister les
- les génériques fournis par Gamumail par la fonction `inc_gamumail_remplacements_dist()` du fichier `inc/gamumail_remplacements.php` - les génériques fournis par Gamumail par la fonction `inc_gamumail_remplacements_dist()` du fichier `inc/gamumail_remplacements.php`
- ceux fournis par les plugins via le pipeline **remplacement_slugs** (cf ci-dessous) - ceux fournis par les plugins via le pipeline **remplacement_slugs** (cf ci-dessous)
- pour documenter les remplacements (pied de la page gamumail_config.html), chaque plugin doit renseigner ses remplacements dans l'array global `$GLOBALS['remplacements_gamumail']` - pour documenter les remplacements (pied de la page gamumail_config.html), chaque plugin doit renseigner ses remplacements dans l'array global `$GLOBALS['remplacements_gamumail']`
Exemple dans un fichier `prefixe_fonctions.php` : Exemple dans un fichier `prefixe_fonctions.php` :
```php ```php
$GLOBALS['remplacements_gamumail']['@@num_facture@@'] = 'numéro de la facture'; $GLOBALS['remplacements_gamumail']['@@num_facture@@'] = 'numéro de la facture';
``` ```
@ -114,7 +114,7 @@ l'Argument $Tclient est utilisé pour récupérer des emails dans un ou X autres
nom,Fiche_guide, nom,Fiche_guide,
contexte,#ARRAY{ contexte,#ARRAY{
id_article,#ENV{id_article}, id_article,#ENV{id_article},
type_guide,#ENV{type_guide,guide} type_guide,#ENV{type_guide,guide}
} }
}, },
#ENV{redirect}, #ENV{redirect},
@ -137,7 +137,7 @@ le fichier PDF sera généré par SPIPDF avec l'URL suivante : `...spip.php?page
nom,Fiche_guide, nom,Fiche_guide,
contexte,#ARRAY{ contexte,#ARRAY{
id_article,#ENV{id_article}, id_article,#ENV{id_article},
type_guide,guide, type_guide,guide,
} }
}, },
1,#ARRAY{ 1,#ARRAY{
@ -145,7 +145,7 @@ le fichier PDF sera généré par SPIPDF avec l'URL suivante : `...spip.php?page
nom,Fiche_guide_renfort, nom,Fiche_guide_renfort,
contexte,#ARRAY{ contexte,#ARRAY{
id_article,#ENV{id_article}, id_article,#ENV{id_article},
type_guide,guide_renfort, type_guide,guide_renfort,
} }
} }
}, },
@ -155,7 +155,7 @@ le fichier PDF sera généré par SPIPDF avec l'URL suivante : `...spip.php?page
} }
})] })]
``` ```
/!\ en cas de plusieurs PDF : /!\ en cas de plusieurs PDF :
- il faut une *clé unique* pour chaque #ARRAY (0, 1, 2... est une bonne solution) - il faut une *clé unique* pour chaque #ARRAY (0, 1, 2... est une bonne solution)
- dans l'#ARRAY contexte il faut que le dernier élément soit suivi d'une virgule ou d'une accolade fermante - dans l'#ARRAY contexte il faut que le dernier élément soit suivi d'une virgule ou d'une accolade fermante
@ -214,7 +214,7 @@ Pour les remplacements des @@ et tout autre traitement du texte des mails on uti
* $flux['args']['options'] = $options * $flux['args']['options'] = $options
* @return array $flux données du pipeline * @return array $flux données du pipeline
``` ```
#### 4. Pipeline post_gamumail_ok #### 4. Pipeline post_gamumail_ok
Ce pipeline est appelé si le retour de l'envoi du gamumail est OK. Il permet, par exemple, à Paybyurl d'aller modifier le champ date_paybyurl_envoye pour que la date d'envoi soit mise à jour. Ce pipeline est appelé si le retour de l'envoi du gamumail est OK. Il permet, par exemple, à Paybyurl d'aller modifier le champ date_paybyurl_envoye pour que la date d'envoi soit mise à jour.
#### 5. Ajouter un header / footer dans le content html #### 5. Ajouter un header / footer dans le content html
@ -225,12 +225,12 @@ on peut définir un header / footer pour les messages :
* gamumail/SLUG_html_footer.html => pour les mails du modele SLUG * gamumail/SLUG_html_footer.html => pour les mails du modele SLUG
#### 6. Utiliser l'inclure `<INCLURE{fond=inclure/fermer_modale,env}>` pour fermeture de la modale de gamumail #### 6. Utiliser l'inclure `<INCLURE{fond=inclure/fermer_modale,env}>` pour fermeture de la modale de gamumail
- cet inclure est appelé au début de `formulaire/gamumail.html` : par défaut il est vide - cet inclure est appelé au début de `formulaire/gamumail.html` : par défaut il est vide
- un plugin peut arriver avec son fichier pour le surcharger afin de pouvoir intégrer du JS en fonction du message de retour `message_ok` du traiter de gamumail.php - un plugin peut arriver avec son fichier pour le surcharger afin de pouvoir intégrer du JS en fonction du message de retour `message_ok` du traiter de gamumail.php
- dans `gamumail.php`, la fonction `gamumail_traiter` ajoute en fin du message de retour OK `message_ok` le suffixe `@@gamumail_ok` - dans `gamumail.php`, la fonction `gamumail_traiter` ajoute en fin du message de retour OK `message_ok` le suffixe `@@gamumail_ok`
- il est donc possible de tester la présence de ce suffixe dans `message_ok` pour afficher du JS qui permet de refermer la modale dans laquelle est chargée gamumail - il est donc possible de tester la présence de ce suffixe dans `message_ok` pour afficher du JS qui permet de refermer la modale dans laquelle est chargée gamumail
mais aussi de faire la mise à jour de l'affichage d'un bloc ajax dans la page appelante. mais aussi de faire la mise à jour de l'affichage d'un bloc ajax dans la page appelante.
=> voir le code en commentaire dans le fichier `inclure/fermer_modale` => voir le code en commentaire dans le fichier `inclure/fermer_modale`
## API d'envoi de mails utilisant les slugs ## API d'envoi de mails utilisant les slugs
### fonction envoyer_gamumail() ### fonction envoyer_gamumail()
@ -238,9 +238,9 @@ mais aussi de faire la mise à jour de l'affichage d'un bloc ajax dans la page a
```php ```php
$fonction = charger_fonction('envoyer_gamumail','inc'); $fonction = charger_fonction('envoyer_gamumail','inc');
$options = [ $options = [
'debug' => false, 'debug' => false,
'args' => ['nb_parts' => intval(_request('nombre'))], 'options' => ['nb_parts' => intval(_request('nombre'))],
'pdfs' => [ 'pdfs' => [
[ [
'fichier' => 'pdf_attestation_souscription', 'fichier' => 'pdf_attestation_souscription',
'nom' => 'attestation_souscription_'.$id_souscription, 'nom' => 'attestation_souscription_'.$id_souscription,