Fork me on GitHub

Plugin cgu

Introduction

Ce plugin permet de gérer des Conditions Générales d'Utilisations (CGU). Une CGU peut avoir plusieurs versions. Une version reste modifiable et n'est pas visible en front-office tant qu'elle n'est pas publiée.

Configuration

Le plugin ajoute la page d'admin Gestion des CGU qui permet de gérer les CGU. Les CGU créées sont alors affichées. Seules les 2 dernières versions des CGU sont affichées : la version draft et la dernière version publiée. Pour voir l'ensemble des versions d'une CGU, il suffit de cliquer sur le bouton Voir les versions précédentes de la colonne Actions.

L'administrateur peut effectuer les actions suivantes :

  • Ajouter une CGU. Elle s'ajoutera alors à la liste des CGU.
  • Modifier une CGU. Seule la version draft d'une CGU peut être éditée.
  • Publier version. La version en question sera alors disponible en front-office. Seule la dernière version publiée est disponible en front-office. Une nouvelle version draft est alors automatiquement créée.
  • Voir les versions précédentes. Les versions précédentes s'affichent alors sous la dernière version publiée.
  • Prévisualisation du texte. La prévisualisation de la CGU s'affiche alors dans un nouvel onglet. Le rendu est celui affiché en appliquant les classes CSS renseignées.

Lors de la création d'une CGU, les champs suivants sont à renseigner :

  • Description : champ à destination des administrateurs pour qu'ils puissent s'y retrouver parmi la liste des CGU.
  • Code CGU : code unique parmi les CGU. Ce code est utilisé par les autres plugins Lutece pour retrouver la bonne CGU.
  • Age minimum : l'âge minimum requis pour accepter la CGU. Si la valeur est inférieure ou égale à 0, alors il n'y a pas de limite d'âge.
  • Texte : texte de la CGU. Ce texte peut contenir du HTML.
  • Feuille de style : classes CSS en lien avec le HTML du champ Texte. Champ facultatif.

Tous ces éléments peuvent être différents d'une version à l'autre. Attention : La modification des champs Description et Code CGU s'applique à l'ensemble des versions de la CGU.

Services

Le service fr.paris.lutece.plugins.cgu.service.ICguService expose des méthodes permettant de gérer les CGU par les autres plugins Lutece :

  • findLastVersion( String strCguCode ) : permet de retrouver la dernière version de la CGU dont le code strCguCodeest passé en paramètre.
  • acceptCgu( String strCguCode, int nIdResource, String strResourceType ) : indique au plugin-cgu que la CGU dont le code est strCguCode a été acceptée pour la ressource dont le type est strResourceType et l'id est nIdResource. La ressource est propre au plugin Lutece utilisant ce service.
  • hasAcceptedLastVersion( String strCguCode, int nIdResource, String strResourceType ) : teste si la ressource dont le type est strResourceType et l'id est nIdResource a accepté la dernière version de la CGU dont le code est strCguCode. La ressource est propre au plugin Lutece utilisant ce service. Cela peut être utile lorsqu'une nouvelle version de la CGU a été publiée. Il faut alors que la ressource accepte cette nouvelle version.

Ce service est implémenté par la classe fr.paris.lutece.plugins.cgu.service.CguService.

L'objet fr.paris.lutece.plugins.cgu.business.CguVersion représente une version d'une CGU. Cet objet contient l'id de la CGU associée, l'id, le texte et le numéro de version de la version de la CGU, si la version est publiée ou non et l'âge minimum d'acceptation de la CGU.

L'objet fr.paris.lutece.plugins.cgu.business.AcceptedCgu représente la CGU acceptée par une ressource. Cet objet contient l'id et le type de la ressource et l'id de la dernière version acceptée de la CGU par cette ressource. L'id de la dernière version acceptée de la CGU est l'id d'un objet fr.paris.lutece.plugins.cgu.business.CguVersion.

Usage

Ce plugin s'utilise à travers les services exposés.