ajout de commentaires
[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.
24    *
25    * un dossier de plugin peut contenir des dossiers :
26    *  - app/data
27    *  - app/mods
28    *  - out
29    *
30    * qui seront traites exactement comme les dossiers de meme nom dans
31    * l'application principale
32    *
33    *
34    * plus d'infos en ligne sur le fonctionnement de l'application :
35    *
36    * http://mtweb.dj3c1t.com
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     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     function description(){
57       return "Un plugin 'vide'";
58     }
59
60     /*
61      * Cette methode sera appelee lors du clic sur le lien "installer"
62      * dans l'administration, pour ce plugin.
63      * 
64      * l'objet $env est fourni en parametre par l'application au moment
65      * de l'appel.
66      *
67      * retourne :
68      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
69      * - TRUE en cas de succes
70      *
71      */
72     function install($env){
73       return true;
74     }
75
76     /*
77      * Cette methode sera appelee lors du clic sur le lien "desinstaller"
78      * dans l'administration, pour ce plugin.
79      * 
80      * l'objet $env est fourni en parametre par l'application au moment
81      * de l'appel.
82      *
83      * retourne :
84      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
85      * - TRUE en cas de succes
86      *
87      */
88     function uninstall($env){
89       return true;
90     }
91
92     /*
93      * Cette methode sera appelee lors du clic sur le lien "activer"
94      * dans l'administration, pour ce plugin.
95      * 
96      * l'objet $env est fourni en parametre par l'application au moment
97      * de l'appel.
98      *
99      * retourne :
100      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
101      * - TRUE en cas de succes
102      *
103      */
104     function enable($env){
105       return true;
106     }
107
108     /*
109      * Cette methode sera appelee lors du clic sur le lien "desctiver"
110      * dans l'administration, pour ce plugin.
111      * 
112      * l'objet $env est fourni en parametre par l'application au moment
113      * de l'appel.
114      *
115      * retourne :
116      * - une chaine de caracteres avec un message d'erreur en cas d'erreur
117      * - TRUE en cas de succes
118      *
119      */
120     function disable($env){
121       return true;
122     }
123
124     /*
125      * Cette methode sera appelee a chaque requete, avant le traitement
126      * de l'action demandee
127      * 
128      * l'objet $env est fourni en parametre par l'application au moment
129      * de l'appel.
130      *
131      * retourne :
132      * - FALSE en cas d'erreur
133      * - TRUE en cas de succes
134      *
135      */
136     function init($env){
137       return true;
138     }
139
140   }
141
142 ?>