git.dj3c1t.com Git - mw_minimal/blob - 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 mw/plugins/mon_plugin peut contenir
  24    * un dossier app avec les sous-dossiers :
  25    *
  26    *  - app/controllers
  27    *  - app/data
  28    *  - app/out
  29    *  - app/observers
  30    *  - ...
  31    *
  32    * ces dossiers seront traites de le meme facon que ceux de
  33    * l'application principale (dans le dossier mw/app)
  34    * plus d'infos sur ce dossier app dans la doc en ligne :
  35    *
  36    * http://mtweb.dj3c1t.com/index.php?id=14&e=pages/view/page#mvc
  37    *
  38    */
  39
  40   class mw_minimal extends mw_plugin{
  41
  42     /*
  43      * retourne une chaine de caracteres avec le nom du plugin
  44      * tel qu'il apparaitra dans l'administration du site
  45      *
  46      */
  47     public function title(){
  48       return "Minimal";
  49     }
  50
  51     /*
  52      * retourne une chaine de caracteres avec la description du plugin
  53      * telle qu'elle apparaitra dans l'administration du site
  54      *
  55      */
  56     public function description(){
  57       return "Un plugin 'vide'";
  58     }
  59
  60     /*
  61      * Cette methode sera appelee a chaque requete, avant la methode "init"
  62      * (voir plus bas), que le plugin soit activé ou pas dans l'administration
  63      * du site.
  64      *
  65      * l'objet $env est fourni en parametre par l'application au moment
  66      * de l'appel.
  67      *
  68      */
  69     public function loaded($env){
  70     }
  71
  72     /*
  73      * Cette methode sera appelee a chaque requete, si le plugin
  74      * est installé ET activé
  75      *
  76      * l'objet $env est fourni en parametre par l'application au moment
  77      * de l'appel.
  78      *
  79      * retourne :
  80      * - TRUE en cas de succes
  81      * - FALSE en cas d'erreur
  82      *
  83      * Si la methode retourne TRUE, l'application principale continuera
  84      * son traitement normalement
  85      *
  86      * Si la methode retourne FALSE, l'application principale sera terminée,
  87      * la requète ne sera pas traitée et un message d'erreur indiquera qu'une
  88      * erreur s'est produite durant l'initialisation du plugin.
  89      *
  90      */
  91     public function init($env){
  92       return true;
  93     }
  94
  95     /*
  96      * Cette methode sera appelee lors du clic sur le lien "installer"
  97      * dans l'administration, pour ce plugin.
  98      *
  99      * l'objet $env est fourni en parametre par l'application au moment
 100      * de l'appel.
 101      *
 102      * retourne :
 103      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
 104      * - TRUE en cas de succes
 105      *
 106      */
 107     public function install($env){
 108       return true;
 109     }
 110
 111     /*
 112      * Cette methode sera appelee lors du clic sur le lien "desinstaller"
 113      * dans l'administration, pour ce plugin.
 114      *
 115      * l'objet $env est fourni en parametre par l'application au moment
 116      * de l'appel.
 117      *
 118      * retourne :
 119      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
 120      * - TRUE en cas de succes
 121      *
 122      */
 123     public function uninstall($env){
 124       return true;
 125     }
 126
 127     /*
 128      * Cette methode sera appelee lors du clic sur le lien "activer"
 129      * dans l'administration, pour ce plugin.
 130      *
 131      * l'objet $env est fourni en parametre par l'application au moment
 132      * de l'appel.
 133      *
 134      * retourne :
 135      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
 136      * - TRUE en cas de succes
 137      *
 138      */
 139     public function enable($env){
 140       return true;
 141     }
 142
 143     /*
 144      * Cette methode sera appelee lors du clic sur le lien "desctiver"
 145      * dans l'administration, pour ce plugin.
 146      *
 147      * l'objet $env est fourni en parametre par l'application au moment
 148      * de l'appel.
 149      *
 150      * retourne :
 151      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
 152      * - TRUE en cas de succes
 153      *
 154      */
 155     public function disable($env){
 156       return true;
 157     }
 158
 159   }