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

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