« Développement:Modules » : différence entre les versions

Dernière version du 2 mai 2008 à 22:06

Les modules d'activités se trouvent dans le dossier mod. Chaque module dispose de son propre sous-dossier qui inclut les éléments suivants obligatoires (avec des scripts supplémentaires spécifiques à chaque module) :

mod.html - une page web pour configurer ou modifier une instance du module (depuis la version 1.8 et l'adjonction de l'API de formulaire, ce fichier est de plus en plus souvent remplacé par un fichier mod_form.php).
version.php - précise des méta-informations, par exemple les numéros de versions
icon.gif - une icône 16x16 pour le module
db/ - les commandes SQL pour les tables de la DB nécessaires au module
index.php - une liste des instances pour un cours spécifique (par exemple tous les forums)
view.php - une page pour visualiser une instance
lib.php - toutes les fonctions de ce module.

Supposons qu'un module s'appelle widget :

widget_add_instance() - fonction pour ajouter une nouvelle instance de widget
widget_update_instance() - fonction pour mettre à jour une instance
widget_delete_instance() - fonction pour supprimer une instance
widget_user_outline() - pour chaque instance, retourne un résumé des contributions
widget_user_complete() - pour une instance, affiche les détails des contributions d'un utilisateur
Autres fonctions (optionnelles) :
- widget_delete_course() - code pour nettoyer les éléments restant après la suppression de toutes les instances
- widget_process_options() - code pour traiter les informations de configuration
Le nom de toutes les fonctions du module doit commencer par widget_ et le nom de toutes les constantes définies débute avec WIDGET_

config.html - (optionnel) une page permettant la configuration du module
Enfin, chaque module disposera de fichiers de langue qui contiennent les chaînes de caractères appropriées.

Important : quand vous créez un nouveau module, son nom ne doit pas contenir de chiffres.

Par ailleurs, vous devez vous assurer que votre module d'activité supporte les groupes et les méta-cours.

Processus de développement

Voir aussi

NEWMODULE.zip - un modèle de module pour construire un nouveau module avec les versions récentes de Moodle. Lisez les instructions du fichier README contenu dans l'archive. Il existe aussi une version de NEWMODULE.zip valable jusqu'à Moodle 1.6.
Forum Activity modules du cours Using Moodle (en anglais)

@@ Ligne 1 : / Ligne 1 : @@
-'''Les modules d'activités ''' se trouve dans le répertoire 'mod'.  Chaque module dispose de son propre sous-répertoire qui présente les éléments suivants obligatoires (avec des scripts suppléméntaires spécifiques à chaque module):
+'''Les modules d'activités ''' se trouvent dans le dossier ''mod''. Chaque module dispose de son propre sous-dossier qui inclut les éléments suivants obligatoires (avec des scripts supplémentaires spécifiques à chaque module) :
-* ''mod.html'' - un formulaire pour mettre-à-jour un instance de ce module
+* ''mod.html'' - une page web pour configurer ou modifier une instance du module (depuis la version 1.8 et l'adjonction de l'API de formulaire, ce fichier est de plus en plus souvent remplacé par un fichier mod_form.php).
-* ''version.php'' - precise les informations méta comme les versions
+* ''version.php'' - précise des méta-informations, par exemple les numéros de versions
-* ''icon.gif'' - un icône 16x16 pour ce module
+* ''icon.gif'' - une icône 16x16 pour le module
-* ''db/'' - Les commandes SQL pour les tableaux de ce module
+* ''db/'' - les commandes SQL pour les tables de la DB nécessaires au module
-* ''index.php'' - une liste des instances pour un cours spécifique ( ex: tous les forums)
+* ''index.php'' - une liste des instances pour un cours spécifique (par exemple tous les forums)
-* ''view.php'' - une page pour visulaiser une instance
+* ''view.php'' - une page pour visualiser une instance
-* ''lib.php'' - Toutes les fonctions de ce module. sui ce module s'appelle widget :
+* ''lib.php'' - toutes les fonctions de ce module.
-:* widget_add_instance() - code to add a new instance of widget
-:* widget_update_instance() - code to update an existing instance
-:* widget_delete_instance() - code to delete an instance
-:* widget_user_outline() - given an instance, return a summary of a user's contribution
-:* widget_user_complete() - given an instance, print details of a user's contribution
-:* Other functions available but not required are:
-:** widget_delete_course() - code to clean up anything that would be leftover after all instances are deleted
-:** widget_process_options() - code to pre-process the form data from module settings
-:* To avoid possible conflict, any module functions should be named starting with widget_ and any constants you define should start with WIDGET_
-* ''config.html'' - (optional) a form to set up or update global settings of this module
-* Lastly, each module will have some language files that contain strings for that module.
-IMPORTANT: When creating a new module, the new name of the module must not contain numbers or other special characters!
+Supposons qu'un module s'appelle ''widget'' :
-You should also make sure that your activity module provides appropriate support for groups and metacourses.
+:* widget_add_instance() - fonction pour ajouter une nouvelle instance de ''widget''
+:* widget_update_instance() - fonction pour mettre à jour une instance
+:* widget_delete_instance() - fonction pour supprimer une instance
+:* widget_user_outline() - pour chaque instance, retourne un résumé des contributions
+:* widget_user_complete() - pour une instance, affiche les détails des contributions d'un utilisateur
+:* Autres fonctions (optionnelles) :
+:** widget_delete_course() - code pour nettoyer les éléments restant après la suppression de toutes les instances
+:** widget_process_options() - code pour traiter les informations de configuration
+:* Le nom de toutes les fonctions du module doit commencer par ''widget_'' et le nom de toutes les constantes définies débute avec ''WIDGET_''
+* ''config.html'' - (optionnel) une page permettant la configuration du module
+* Enfin, chaque module disposera de fichiers de langue qui contiennent les chaînes de caractères appropriées.
-==Voir aussi==
+'''Important''' : quand vous créez un nouveau module, son nom ne doit pas contenir de chiffres.
-* http://download.moodle.org/download.php/modules/NEWMODULE.zip - un modele de module  pour construire un nouveau module. Lisez les instructions dans le fichier README dans les fichiers comprimés.
+Par ailleurs, vous devez vous assurer que votre module d'activité supporte les groupes et les méta-cours.
-* Using Moodle [http://moodle.org/course/view.php?id=5 Activity modules] forum
+== Processus de développement ==
+* [[Developpement de module : Etape 1|1ère étape : la décision de créer un module]]
+* [[Developpement de module : Etape 2|2ème étape : la préparation]]
+* [[Developpement de module : Etape 3|3ème étape : la constitution du modèle de données]]
+* [[Developpement de module : Etape 4|4ème étape : pénétrer plus profondément la structure d'un module]]
+* [[Developpement de module : Etape 5|5ème étape : organiser la stratégie de navigation, commutation de pages, etc.]]
+* [[Developpement de module : Etape 6|6ème étape : organiser la sauvegarde/restauration.]]
+== Voir aussi ==
+* [http://download.moodle.org/plugins/mod/NEWMODULE.zip NEWMODULE.zip] - un modèle de module pour construire un nouveau module avec les versions récentes de Moodle. Lisez les instructions du fichier README contenu dans l'archive. Il existe aussi une version de [http://download.moodle.org/plugins16/mod/NEWMODULE.zip NEWMODULE.zip] valable jusqu'à Moodle 1.6.
+* Forum [http://moodle.org/course/view.php?id=5 Activity modules] du cours ''Using Moodle'' (en anglais)
+[[Category:Développeur]]
+[[Category:Modules]]
+[[en:Modules (developer)]]

Documentation

« Développement:Modules » : différence entre les versions

Dernière version du 2 mai 2008 à 22:06

Processus de développement

Voir aussi

« Développement:Modules » : différence entre les versions