SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

289 Plugins, 197 contribs sur SPIP-Zone, 118 visiteurs en ce moment

Accueil > Dates, calendriers et agendas > Plugin Agenda > SPIP 3.2, Agenda et FullCalendar

SPIP 3.2, Agenda et FullCalendar

6 juin 2018 – par Maïeul

4 votes

Ceci est une « contribution pédagogique », qui montre par l’exemple comment développer une nouvelle fonctionnalité pour SPIP.

Nous avions publié un article sur la manière d’utiliser FullCalendar avec SPIP 3.0 afin d’afficher des évènements sous forme d’Agenda.

La version de FullCalendar a changé avec SPIP 3.2. Le présent article est donc un tutoriel adapté à SPIP 3.2.

Pour une première approche, vous pouvez utiliser le plugin Agenda Fullcalendar facile.

Souhait

Nous souhaitons afficher tous les événements (publiés) du site sous forme calendaire, en proposant d’abord un affichage par mois, avec possibilité de basculer en affichage par semaine ou par jour.

Agenda souhaité au final

Pré-requis

  • SPIP 3.2.x, en ayant conservé l’organiseur dans plugins-dist.
  • Plugin Agenda 3.6.11 minimum.
  • Compréhension de la mécanique des squelettes de SPIP.
  • Quelques évènements à afficher.

Vous n’avez pas besoin d’installer la librairire FullCalendar : elle est livrée avec SPIP.

Principe de base

Pour afficher notre agenda nous allons :

  1. créer un squelette agenda.html, avec un div dont l’attribut id est agenda.
  2. appeler dans le squelette le script fullcalendar et ses feuilles de styles.
  3. utiliser ce script pour afficher l’agenda dans dans la div#agenda.
  4. créer un squelette agenda.json.html fournissant au script les données à afficher dans l’agenda.

Fichiers manipulés

Dans cet article nous manipulons deux fichiers squelettes :

  • agenda.html (qui contient le code nécessaire à l’affichage du calendrier).
  • agenda.json.html (qui nous permet de générer une liste d’événements compatible avec le script fullcalendar).

Si l’un de ces squelette existe déjà, je vous invite à utiliser le mécanisme de surcharge de SPIP.

Création du squelette

Il nous faut créer un squelette agenda.html complet (à savoir une page SPIP classique avec les balises <head><body> etc), dans lequel nous mettons un div dont l’attribut id est agenda à l’endroit où nous souhaitons que l’agenda s’affiche.

Au dessus de ce div, nous allons appeler :

  • plusieurs scripts javascript, dans leurs versions compressées :
    • moment-with-locales, nécessaire au fonctionnement de fullcalendar [1] ;
    • fullcalendar, qui gère l’affichage proprement dit du calendrier
    • locale-all, qui contient les traductions des informations de calendriers pour fullcalendar ;
  • les styles CSS associés à fullcalendar.

Pour ce faire, nous utilisons la balise #CHEMIN :

  1. <link rel='stylesheet' type='text/css' href='#CHEMIN{lib/fullcalendar/fullcalendar.min.css}' />
  2. <script type='text/javascript' src='#CHEMIN{lib/moment/moment-with-locales.min.js}'></script>
  3. <script type='text/javascript' src='#CHEMIN{lib/fullcalendar/fullcalendar.min.js}'></script>
  4. <script type='text/javascript' src='#CHEMIN{lib/fullcalendar/locale-all.js}'></script>
  5. <div id="agenda">
  6. </div>

Télécharger

Appel à l’agenda

Nous allons maintenant ajouter les fonctions javascript qui permettent d’afficher l’agenda. Pour ce faire, nous allons mettre au dessus du div (cela pourrait être dedans ou en dessous, cela importe peu) le code suivant, que je vais commenter :

  1. <script type="text/javascript">/*<![CDATA[*/
  2.         jQuery(function($) {
  3.                 $('#agenda').fullCalendar({
  4.                         locale : '[(#LANG|strtolower)]',
  5.                         editable: false,
  6.                         navLinks: true,
  7.                         eventLimit: true,
  8.                         events: "[(#URL_PAGE{agenda.json})]",
  9.                         header: {
  10.                                 left: [(#LANG_DIR|=={ltr}|?{"'prevYear,prev,next,nextYear,today'","'listMonth,month,agendaWeek,agendaDay'"})],
  11.                                 center: 'title',  
  12.                                 right: [(#LANG_DIR|=={ltr}|?{"'agendaDay,agendaWeek,month,listMonth'","'today nextYear,next,prev,prevYear'"})]
  13.                         },  
  14.                         fixedWeekCount: false,
  15.                        allDayHtml:'<:organiseur:cal_jour_entier|textebrut:>',
  16.                         loading: function(bool) {
  17.                                if (bool) $('#calendrier-loading').show();
  18.                                 else $('#calendrier-loading').hide();
  19.                         },
  20.                 })
  21.         });
  22. /*]]>*/</script>

Télécharger

  • l. 2 jQuery(function($) signifie que le navigateur va exécuter la fonction dans les accolades qui suivent.
  • l. 3 $('#agenda').fullCalendar signifie que nous allons demander à javascript de modifier le div dont l’id est égale à agenda pour y mettre à la place… l’agenda.
  • Le code entre parenthèse puis accolade correspond aux options passées à l’agenda (l. 4-21) :
    • l. 4 : on passe le nom de la langue courante comme paramètre de langue à fullcalendar, ceci permet notamment d’avoir les bons noms de jours et de mois, et de déterminer automatiquement le premier jour de la semaine [2].
    • l. 5 : on ne peut pas éditer les évènements depuis l’agenda.
    • l. 6 : rend cliquable les numéros de jours / les noms de jours pour basculer sur une vue par jour.
    • l. 7 : limite le nombre d’évènements affichés par jour à la hauteur de la cellule. Les évènements supplémentaires seront affichables via un clique supplémentaire.
    • l. 8 : on récuperera la liste des évènements via un squelette agenda.json.html, nous détaillerons ce squelette dans la partie suivante
    • l. 9-13 : qu’affiche-t-on dans l’entête de l’agenda ? :
      • l. 10 : à gauche, on met les boutons de navigation par mois/semaines/jours (selon le type de calendrier) et par années (dans tout les cas).
      • l. 11 : au centre, on affiche le titre de l’agenda, correspondant à la période affichée (par ex. "Août 2012").
      • l. 12 : à droite, on affiche la bascule vers l’agenda en mode mois, semaine ou jour.
      • À noter l. 10 et l. 12 le test sur la direction de la langue, qui permet d’inverser les boutons de gauche et de droite si l’on est dans écriture de droite à gauche.
    • l. 14 : afficher 4, 5 ou 6 semaines par mois en fonction du mois, et non pas systématiquement 6.
    • l. 15 : changer la chaîne de langue pour "toute la journée", chaîne de langue définie par SPIP.
    • l. 16-19 : pendant le temps du chargement, afficher l’élément HTML dont l’id est calendrier-loading. Nous reviendrons dessus plus bas.

D’autres options sont bien sûr possibles : on se reportera à la documentation de FullCalendar, malheureusement en anglais uniquement.

Sélection des évènements à afficher

Pour pouvoir afficher les évènements, il va falloir nous fabriquer un squelette agenda.json.html (cf. l. 7) qui retournera les évènements qui nous intéreressent sous forme de données JSON.

La page spip.php?page=agenda.json sera automatiquement appelée par FullCalendar, qui lui passera deux arguments, variant selon la période demandée :

  • start, correspondant à l’ISO-8601 de la date de début.
  • end, correspondant à ISO-8601 de la date de fin [3].

Dans le squelette agenda.json.html correspondant à cette page, nous pourrons récuperer ces informations via : #ENV{start} et #ENV{end} (voir mon article sur la balise #ENV). On pourrait éventuellement passer d’autres arguments, en appliquant le filtre |parametre_url sur #URL_PAGE{agenda.json}.

Voilà un squelette agenda.json.html basique :

  1. #HTTP_HEADER{Content-Type: application/json; charset=#CHARSET}
  2. #SET{start,#ENV{start}|strtotime}
  3. #SET{end,#ENV{end}|strtotime}
  4. [<BOUCLE_evenements(EVENEMENTS){', '}{par date_debut}  
  5. {agendafull date_debut,date_fin, periode,
  6.         #VAL{Y}|date{#GET{start}}, #VAL{m}|date{#GET{start}},     #VAL{d}|date{#GET{start}},
  7.         #VAL{Y}|date{#GET{end}}, #VAL{m}|date{#GET{end}}, #VAL{d}|date{#GET{end}}}
  8.         >
  9.                                         [(#ARRAY{
  10.                                         id,#ID_EVENEMENT,
  11.                                        title,[(#TITRE|html2unicode|unicode2charset)],
  12.                                        allDay,[(#HORAIRE|=={non}|?{#EVAL{true},#EVAL{false}})],
  13.                                         start,#DATE_DEBUT,
  14.                                         end,#DATE_FIN,
  15.                                         url,#URL_ARTICLE,
  16.                                        description,[(#DESCRIPTIF|html2unicode|unicode2charset)]
  17.                                         }|json_encode)]
  18. </BOUCLE_evenements>]

Télécharger

Je commente rapidement ce squelette :

  • l. 1. On demande à SPIP de :
    • Ne pas insérer de boutons d’administration.
    • Dire au navigateur que la page retournée est du json, et fournir le charset.
  • l. 2-3 : nous convertissons les dates de début et de fin de l’ISO-8601 au timestamp, et nous stockons dans les variables start et end, homonymes aux variables d’environnement reçues.
  • l. 4 et l .18, les crochets servent à indiquer que nous retournons plusieurs objets JSON, chacun correspondant à un évènements.
  • l. 4 nous bouclons sur les évènements. Entre chaque élément de la boucle, nous affichons une virgule ({", "}). Nous trions par date de début : ceci servira plus loin lors de l’affichage des données sans Javascript.
  • l. 5-7 pour sélectionner les évènements, nous utilisons le critère agendafull. Les options de ce critère nous indiquent :
    • date_debut : que le champ date_debut servira pour repérer… la date de début de sélection.
    • date_fin : que le champ date_fin servira pour repérer… la date de fin de sélection.
    • periode que la période sélectionnée sera déterminée par les options suivantes :
    • #VAL{Y}|date{#GET{start}}, #VAL{m}|date{#GET{start}},     #VAL{d}|date{#GET{start}} que le début de la période correspond à la date stockée dans #SET{start}. La syntaxe un peu absconse que vous voyiez ici permet d’extraire, respectivement, l’année, le mois et la jour depuis un timestamp.
    • #VAL{Y}|date{#GET{end}}, #VAL{m}|date{#GET{end}}, #VAL{d}|date{#ENV{end}} que la fin de la période correspond à la date stocké dans #SET{end}.
    • Le critère agendafull « permet de sélectionner tous les évènements à cheval sur la période considérée », comme l’explique la documentation du plugin Agenda.
  • l. 9-17 : nous remplissons un tableau SPIP via #ARRAY, puis nous le transformons en objet JSON, via le filtre |json_encode. Ce tableau comprend les entrées suivantes :
    • id : identifiant unique pour FullCalendar. Ca tombe bien, SPIP attribut un identifiant à chaque évenement : #ID_EVENEMENT
    • title : le titre. On transforme les entité HTML en caractère unicode (|html2unicode) puis on s’assure de proposer des données avec le bon charset (|unicode2charset).
    • allDay : on précise si l’évènement dure toute la journée. Utiliséepour l’affichage par jour. Pour préciser cela, on s’appuie sur le champ #HORAIRE qui contient justement cette information. On utilise #EVAL pour indiquer qu’on insére une valeur booléenne et non pas textuelle.
    • start : date de début. On garde le format SQL.
    • end : date de fin. On garde le format SQL.
    • url : lien. Pour le coup, on renvoie vers l’article.
    • description : description de l’évènement. Là encore, on converti en Unicode, puis dans le charset correct.

À noter que l’on pourrait définir d’autres données pour chaque évènement : on se refera à la documentation de l’objet Event de FullCalendar. Par exemple, on pourrait indiquer des classe HTML en fonction de la rubrique.

Il vous faut également créer un fichier agenda.json_fonctions.php contenant les lignes suivantes :

  1. <?php
  2.  
  3. include_spip('inc/json');
  4. ?>

Télécharger

Ceci assurera que le filtre json_encode est bien chargé [4].

Et pour les personnes sans Javascript ?

Et oui, tout le monde n’a pas de Javascript. Comment on fait alors ? La solution consiste à afficher un calendrier sous forme de liste dans un div dont l’id est calendrier-loading. Si Javascript est activé, FullCalendar va masquer ce div.

Comme on a déjà fabriqué une boucle dans le squelette agenda.json.html, nous allons nous en reservir, afin d’éviter de dupliquer les critères. Pour ce faire, nous allons utiliser la boucle DATA de SPIP 3.

Nous mettons donc dans le squelette agenda.html :

  1. <B_agenda>
  2. <div id="calendrier-loading">
  3. <p class="pagination">#PAGINATION</p>
  4. <BOUCLE_agenda(DATA){source json, #PRODUIRE{fond=agenda.json, start=0,end=2147483647,_=#REM|time}|url_absolue}{pagination 15}>
  5.     <dl>
  6.         [<dt><:agenda:evenement_titre:></dt>
  7.         <dd><a href="#VALEUR{url}">(#VALEUR{title})</a></dd>]
  8.        
  9.         [<dt><:agenda:evenement_date:></dt>
  10.         <dd>(#VALEUR{start}|Agenda_affdate_debut_fin{#VALEUR{end},#VALEUR{allDay}|=={true}|?{non,oui}})</dd>]
  11.        
  12.         [<dt><:agenda:evenement_descriptif:></dt>
  13.         <dd>(#VALEUR{description})</dd>]
  14.     </dl>
  15. </BOUCLE_agenda>
  16. <p class="pagination">#PAGINATION</p>
  17. </div>
  18. </B_agenda>

Télécharger

  • l. 1-3 : partie optionnelle avant de la boucle, avec la pagination éventuelle.
  • l. 4 : code de la boucle. Nous bouclons sur des données ((DATA)) au format json ({source json) extrait du fichier produit (#PRODUIRE) par le squelette agenda.json.html avec la valeur de start égale à 0, c’est à dire au 1 janvier 1970 à minuit, et la valeur end égale à 2147483647, c’est à dire à la date maximale gérée par les ordinateurs actuel, le 19 janvier 2038, 3h14m7s [5]. Ainsi, nous sommes sûr de récuperer tout les évènements de l’agenda. L’option _=#REM|time permet de s’assurer de ne pas avoir de cache, puisque nous passons comme argument le moment d’appel (|time). Nous passons au chemin du fichier produit le filtre |url_absolue pour obtenir l’url du fichier [6]. Nous paginons de 15 en 15.
  • l. 5-14 : nous affichons les données pour chaque évènement, via #VALEUR{donnée}. Ces données sont tirées du JSON.
  • l. 16 et suivante : partie optionelle arrière de la boucle.

On obtient alors un agenda, certes sommaire, mais au moins existant sans Javascript :

Agenda pour les personnes sans Javascript

Conclusion

Vous voilà maintenant prêt à avoir un agenda avec FullCalendar. Bien sûr, il y aurait beaucoup de chose à améliorer, cependant cet article aborde déjà beaucoup de notions :
-  produire du JSON avec SPIP.
-  le formatage de FullCalendar.
-  les boucles DATA.

Notes

[1Permet la gestion de dates.

[2Avec les précédentes versions de fullcalendar, il fallait passer manuellement toutes ces informations.

[3Les précédentes versions de fullcalendar utilisait le timestamp.

[4Dans certain cas, que je n’ai pas encore réussi à déterminer précisément, il n’y a pas besoin de cela...

[5Voir l’article sur le bug de l’an 2038.

[6Cela permet d’éviter certains problèmes de droit de lecture dans certaines configuration... la chose n’est pas claire pour nous.

Dernière modification de cette page le 6 juin 2018

Retour en haut de la page

Répondre à cet article

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 Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • Numérotation rapide

    27 octobre 2008 – 34 commentaires

    Le plugin Numérotation Rapide permet d’un clic de numéroter/re-numéroter/dé-numeroter tous les articles ou sous-rubriques d’une rubrique.

  • Albums 3

    8 août 2014 – 282 commentaires

    Le plugin « Albums » évolue dans une version 3 pour SPIP 3. Avant d’effectuer une mise à jour depuis la version 1 ou 2, consultez les notes sur la rétro-compatibilité. Les modèles, notamment, on reçut quelques changements pour la bonne cause. En (...)

  • Formidable, le générateur de formulaires

    23 janvier 2012 – 2464 commentaires

    Un générateur de formulaires facilement configurable pour les non-informaticiens et facilement extensible pour les développeurs. Introduction L’objectif était de créer un plugin permettant de générer des formulaires. Historiquement, 2 plugins (...)

  • Éditorial (HTML5UP)

    27 novembre 2017 – 77 commentaires

    Squelette SPIP pour intégrer le modèle Editorial de HTML5UP https://html5up.net/editorial Configuration La page de configuration permet quelques réglages. On y défini la couleur principale du site, des informations de contact et le contenu de la (...)

  • SPIP 400 - Gestion des erreurs HTTP

    23 mars 2012 – 13 commentaires

    Ce plugin tente de compléter la distribution de SPIP en proposant des modèles de pages d’erreur HTTP (codes 401 et 404) avec un texte explicatif et la possibilité pour l’internaute de transmettre un « ticket de bug » au webmestre du site. (...)