« Développement:Modules » : différence entre les versions
De MoodleDocs
Aucun résumé des modifications |
Aucun résumé des modifications |
||
| Ligne 1 : | Ligne 1 : | ||
'''Les modules d'activités ''' se | '''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'' - | * ''mod.html'' - une page web pour configurer ou modifier une instance du module | ||
* ''version.php'' - précise | * ''version.php'' - précise des méta-informations, par exemple les numéros de versions | ||
* ''icon.gif'' - | * ''icon.gif'' - une icône 16x16 pour le module | ||
* ''db/'' - les commandes SQL pour les | * ''db/'' - les commandes SQL pour les tables de la DB nécessaire au module | ||
* ''index.php'' - une liste des instances pour un cours spécifique ( | * ''index.php'' - une liste des instances pour un cours spécifique (par exemple tous les forums) | ||
* ''view.php'' - une page pour visualiser une instance | * ''view.php'' - une page pour visualiser une instance | ||
* ''lib.php'' - | * ''lib.php'' - toutes les fonctions de ce module. | ||
Supposons qu'un module s'appelle ''widget'' : | |||
:* widget_add_instance() - | :* widget_add_instance() - fonction pour ajouter une nouvelle instance de ''widget'' | ||
:* widget_update_instance() - | :* widget_update_instance() - fonction pour mettre à jour une instance | ||
:* widget_delete_instance() - | :* widget_delete_instance() - fonction pour supprimer une instance | ||
:* widget_user_outline() - pour chaque instance, retourne un résumé des | :* widget_user_outline() - pour chaque instance, retourne un résumé des contributions | ||
:* widget_user_complete() - pour | :* widget_user_complete() - pour une instance, affiche les details des contributions d'un utilisateur | ||
:* Autres fonctions | :* Autres fonctions (optionnelles) : | ||
:** widget_delete_course() - code pour nettoyer les | :** 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 | :** 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) | * ''config.html'' - (optionnel) une page permettant la configuration du module | ||
* Enfin, chaque module disposera de fichiers de langue qui contiennent les | * 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 | Par ailleurs, vous devez vous assurer que votre module d'activité supporte les groupes et les méta-cours. | ||
==Voir aussi== | == Voir aussi == | ||
* http://download.moodle.org/download.php/modules/NEWMODULE.zip - un | * [http://download.moodle.org/download.php/modules/NEWMODULE.zip NEWMODULE.zip] - un modèle de module pour construire un nouveau module. Lisez les instructions du fichier README contenu dans l'archive. | ||
* | * Forum [http://moodle.org/course/view.php?id=5 Activity modules] du cours ''Using Moodle'' (en anglais) | ||
[[Category:Développeur]] | |||
[[en:Modules (developer)]] | |||
Version du 14 août 2006 à 21:01
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
- 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écessaire 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 details 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.
Voir aussi
- NEWMODULE.zip - un modèle de module pour construire un nouveau module. Lisez les instructions du fichier README contenu dans l'archive.
- Forum Activity modules du cours Using Moodle (en anglais)
