<?php
/*
- * Cette classe decrit un plugin "vide", qui peut servir de base
+ * Cette classe decrit un plugin "vide" et peut servir de base
* au developpement d'un nouveau plugin.
*
- * SI VOUS UTILISEZ CE FICHIER COMME BASE POUR UN NOUVEAU PLUGIN :
*
- * Si par exemple vous renommez cette classe en :
+ * pour creer un nouveau plugin (par exemple "mon_plugin") :
*
- * class mon_plugin extends mw_plugin
+ * - creez un dossier "mon_plugin" dans le dossier "mw/plugins"
*
- * - renommez le fichier mw_minimal.php en mon_plugin.php
- * - renommez le dossier mw_minimal en mon_plugin
+ * - copiez dans ce dossier le fichier "mw_minimal.php" et renommez-le
+ * en "mon_plugin.php"
*
- * Vous aurez alors un nouveau plugin "mon_plugin" pret a accueillir
- * vos nouveaux developpements
+ * - dans "mon_plugin.php", renommez la classe en :
*
- * Votre plugin peut definir de nouveaux modules d'acces aux donnes,
- * de nouveaux modules d'action et de nouveaux fichiers d'affichage
+ * class mon_plugin extends mw_plugin
*
- * d'une maniere generale, l'organisation du code dans un plugin
- * est la meme que celle dans l'application.
+ * vous aurez alors un nouveau plugin, activable dans l'administration
+ * du site.
*
- * un dossier de plugin peut contenir des dossiers :
- * - app/data
- * - app/mods
- * - out
*
- * qui seront traites exactement comme les dossiers de meme nom dans
- * l'application principale
+ * Votre dossier de plugin mw/plugins/mon_plugin peut contenir
+ * un dossier app avec les sous-dossiers :
*
+ * - app/controllers
+ * - app/data
+ * - app/out
+ * - app/observers
+ * - ...
*
- * plus d'infos en ligne sur le fonctionnement de l'application :
+ * ces dossiers seront traites de le meme facon que ceux de
+ * l'application principale (dans le dossier mw/app)
+ * plus d'infos sur ce dossier app dans la doc en ligne :
*
- * http://mtweb.dj3c1t.com
+ * http://mtweb.dj3c1t.com/index.php?id=14&e=pages/view/page#mvc
*
*/
* tel qu'il apparaitra dans l'administration du site
*
*/
- function title(){
+ public function title(){
return "Minimal";
}
* telle qu'elle apparaitra dans l'administration du site
*
*/
- function description(){
+ public function description(){
return "Un plugin 'vide'";
}
/*
- * Cette methode sera appelee lors du clic sur le lien "installer"
- * dans l'administration, pour ce plugin.
+ * Cette methode sera appelee a chaque requete, avant la methode "init"
+ * (voir plus bas), que le plugin soit activé ou pas dans l'administration
+ * du site.
+ *
+ * l'objet $env est fourni en parametre par l'application au moment
+ * de l'appel.
+ *
+ */
+ public function loaded($env){
+ }
+
+ /*
+ * Cette methode sera appelee a chaque requete, si le plugin
+ * est installé ET activé
*
* l'objet $env est fourni en parametre par l'application au moment
* de l'appel.
*
* retourne :
- * - une chaine de caracteres avec un message d'erreur en cas d'erreur
* - TRUE en cas de succes
+ * - FALSE en cas d'erreur
+ *
+ * Si la methode retourne TRUE, l'application principale continuera
+ * son traitement normalement
+ *
+ * Si la methode retourne FALSE, l'application principale sera terminée,
+ * la requète ne sera pas traitée et un message d'erreur indiquera qu'une
+ * erreur s'est produite durant l'initialisation du plugin.
*
*/
- function install($env){
+ public function init($env){
return true;
}
/*
- * Cette methode sera appelee lors du clic sur le lien "desinstaller"
+ * Cette methode sera appelee lors du clic sur le lien "installer"
* dans l'administration, pour ce plugin.
*
* l'objet $env est fourni en parametre par l'application au moment
* - TRUE en cas de succes
*
*/
- function uninstall($env){
+ public function install($env){
return true;
}
/*
- * Cette methode sera appelee lors du clic sur le lien "activer"
+ * Cette methode sera appelee lors du clic sur le lien "desinstaller"
* dans l'administration, pour ce plugin.
*
* l'objet $env est fourni en parametre par l'application au moment
* - TRUE en cas de succes
*
*/
- function enable($env){
+ public function uninstall($env){
return true;
}
/*
- * Cette methode sera appelee lors du clic sur le lien "desctiver"
+ * Cette methode sera appelee lors du clic sur le lien "activer"
* dans l'administration, pour ce plugin.
*
* l'objet $env est fourni en parametre par l'application au moment
* - TRUE en cas de succes
*
*/
- function disable($env){
+ public function enable($env){
return true;
}
/*
- * Cette methode sera appelee a chaque requete, avant le traitement
- * de l'action demandee
+ * Cette methode sera appelee lors du clic sur le lien "desctiver"
+ * dans l'administration, pour ce plugin.
*
* l'objet $env est fourni en parametre par l'application au moment
* de l'appel.
*
* retourne :
- * - FALSE en cas d'erreur
+ * - une chaine de caracteres avec un message d'erreur en cas d'erreur
* - TRUE en cas de succes
*
*/
- function init($env){
+ public function disable($env){
return true;
}
}
-
-?>
\ No newline at end of file
projects / mw_minimal / blobdiff