git.dj3c1t.com Git - mtweb/blob - mw/plugins/mw_minimal/mw_minimal.php

   1 <?php
   2
   3   /*
   4    * Cette classe decrit un plugin "vide", qui peut servir de base
   5    * au developpement d'un nouveau plugin.
   6    *
   7    * SI VOUS UTILISEZ CE FICHIER COMME BASE POUR UN NOUVEAU PLUGIN :
   8    *
   9    * Si par exemple vous renommez cette classe en :
  10    *
  11    *   class mon_plugin extends mw_plugin
  12    *
  13    *  - renommez le fichier mw_minimal.php en mon_plugin.php
  14    *  - renommez le dossier mw_minimal en mon_plugin
  15    *
  16    * Vous aurez alors un nouveau plugin "mon_plugin" pret a accueillir
  17    * vos nouveaux developpements
  18    *
  19    * Votre plugin peut definir de nouveaux modules d'acces aux donnes,
  20    * de nouveaux modules d'action et de nouveaux fichiers d'affichage
  21    *
  22    * d'une maniere generale, l'organisation du code dans un plugin
  23    * est la meme que celle dans l'application principale.
  24    *
  25    * un dossier de plugin peut contenir des dossiers :
  26    *  - app/controllers
  27    *  - app/data
  28    *  - app/out
  29    *  - ...
  30    *
  31    * qui seront traites exactement comme les dossiers de meme nom dans
  32    * l'application principale
  33    *
  34    *
  35    * plus d'infos en ligne sur le fonctionnement de l'application :
  36    *
  37    * http://mtweb.dj3c1t.com
  38    *
  39    */
  40
  41   class mw_minimal extends mw_plugin{
  42
  43     /*
  44      * retourne une chaine de caracteres avec le nom du plugin
  45      * tel qu'il apparaitra dans l'administration du site
  46      *
  47      */
  48     function title(){
  49       return "Minimal";
  50     }
  51
  52     /*
  53      * retourne une chaine de caracteres avec la description du plugin
  54      * telle qu'elle apparaitra dans l'administration du site
  55      *
  56      */
  57     function description(){
  58       return "Un plugin 'vide'";
  59     }
  60
  61     /*
  62      * Cette methode sera appelee lors du clic sur le lien "installer"
  63      * dans l'administration, pour ce plugin.
  64      *
  65      * l'objet $env est fourni en parametre par l'application au moment
  66      * de l'appel.
  67      *
  68      * retourne :
  69      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
  70      * - TRUE en cas de succes
  71      *
  72      */
  73     function install($env){
  74       return true;
  75     }
  76
  77     /*
  78      * Cette methode sera appelee lors du clic sur le lien "desinstaller"
  79      * dans l'administration, pour ce plugin.
  80      *
  81      * l'objet $env est fourni en parametre par l'application au moment
  82      * de l'appel.
  83      *
  84      * retourne :
  85      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
  86      * - TRUE en cas de succes
  87      *
  88      */
  89     function uninstall($env){
  90       return true;
  91     }
  92
  93     /*
  94      * Cette methode sera appelee lors du clic sur le lien "activer"
  95      * dans l'administration, pour ce plugin.
  96      *
  97      * l'objet $env est fourni en parametre par l'application au moment
  98      * de l'appel.
  99      *
 100      * retourne :
 101      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
 102      * - TRUE en cas de succes
 103      *
 104      */
 105     function enable($env){
 106       return true;
 107     }
 108
 109     /*
 110      * Cette methode sera appelee lors du clic sur le lien "desctiver"
 111      * dans l'administration, pour ce plugin.
 112      *
 113      * l'objet $env est fourni en parametre par l'application au moment
 114      * de l'appel.
 115      *
 116      * retourne :
 117      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
 118      * - TRUE en cas de succes
 119      *
 120      */
 121     function disable($env){
 122       return true;
 123     }
 124
 125     /*
 126      * Cette methode sera appelee a chaque requete, avant le traitement
 127      * de l'action demandee
 128      *
 129      * l'objet $env est fourni en parametre par l'application au moment
 130      * de l'appel.
 131      *
 132      * retourne :
 133      * - FALSE en cas d'erreur
 134      * - TRUE en cas de succes
 135      *
 136      */
 137     function init($env){
 138       return true;
 139     }
 140
 141   }
 142
 143 ?>