Entwickler:Module

Activity Modules

Activity modules befinden sich im 'mod' Verzeichnis, wobei für jedes Modul ein eigenes Unterverzeichnis existiert. Damit ein Modul von Moodle ordnungsgemäß eingebunden werden kann, ist es bei der Entwicklung eigener Module zwingend erforderlich, dass unterhalb des activity module-Verzeichnisses die folgenden Dateien vorhanden sind:

• mod_form.php - eine Eingabemaske, um das Modul zu konfigurieren
• version.php - Meta-Informationen des Moduls
• icon.gif - ein 16x16 Icon für das Modul
• db/install.xml - definiert die Struktur der Datenbanktabellen des Moduls. Verwendung während des Installationsvorgangs.
• db/upgrade.php - beinhaltet die Änderungen an der Datenbanktabellenstruktur des Moduls. Verwendung währung des Module-Upgradevorgangs.
• db/access.php - definiert Zugriffsrechte des Moduls
• index.php - eine Seite die alle Instanzen in einem Kurs auflistet
• view.php - eine Seite um eine bestimmte Instanz zu betrachten
• lib.php - alle modulspezifischen Funktionen sollten in diese Datei geschrieben werden. Wenn der Modulname widget sein sollte, dann ist die Implementation der folgenden Funktionen erforderlich:

• widget_install() - wird während der Installation aufgerufen
• widget_add_instance() - Code um eine neue Instanz dem widget hinzuzufügen
• widget_update_instance() - Code um eine existierende Instanz zu aktualisieren
• widget_delete_instance() - Code um eine Instanz zu löschen
• widget_user_outline() - erstellt eine Zusammenfassung eines Benutzerbeitrags für eine Modulinstanz
• widget_user_complete() - druckt Details zum Benutzerbeitrag für eine Modulinstanz aus
• Andere Funktionen, die optional implementiert werden können:
  • widget_delete_course() - Code, um alles zu beseitigen, das nach dem Löschen der Instanzen übrig bleibt
  • widget_process_options() - Code, um Moduleinstellungen (siehe mod_form.php) innerhalb eines Vorprozesses vorzuverarbeiten
  • widget_reset_course_form() und widget_delete_userdata() - wird dazu verwendet um die Kurs-zurücksetzen-Funktion auszuführen.
• Namenskonvention: Modulfunktionsnamen beginnen mit widget_ und Konstantennamen mit WIDGET_

• backuplib.php und restorelib.php - (optional)
• settings.php oder settingstree.php - (optional) Definition einer Konfigurationsseite für den Administrator. Ein einfaches Beispiel hierfür wäre: mod/assignment/settings.php. Ein komplexeres Beispiel hierfür ist: mod/quiz/settingstree.php.
• defaults.php - erlaubt die einfache Vorgabe von Defaultwerten für Konfigurationsparameter. Der Inhalt dieser Datei wird durch das Modul upgrade_activity_modules in lib/adminlib.php inkludiert und sollte ein Array namens $defaults enthalten. Die Werte innerhalb dieses Arrays werden in die Konfigurationstabelle geladen. Alternativ und die empfohlene Vorgehensweise (Best Practice) wäre allerdings, den Wert $defaults['_use_config_plugins'] auf true zu setzen, so dass die Vorgabewerte in die config_plugins Tabelle geschrieben werden. Codebeispiel hierfür: mod/quiz/defaults.php
• lang/en_utf8/resource_widget.php - (optional) Jedes Modul sollte Sprachdaten besitzen, die Übersetzungen für das Modul enthalten.

WICHTIG:

• Wenn Sie ein neues Modul anlegen, darf der Modulname keine Zahlen oder Sonderzeichen enthalten!
• Sie müssen eine sogenannte "data base table" erstellen mit dem gleichen Namen, den Sie auch Ihrem Modul gegeben haben. Diese Tabelle muss mindestens drei Datenbankfelder besitzen:
  1. id
  2. course
  3. name
• Vergewissern Sie sich bitte, dass ihr Modul (in angemessener Weise) auch für die Verwendung innerhalb von Gruppen und Metakursen ausgelegt ist.

Weiteres

• Tracker issue [https://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - enthält einen Downloadlink für Vorlagen für supporting roles, formslib etc. (nicht fertiggestellt)
• http://download.moodle.org/plugins16/mod/NEWMODULE.zip - neue Modulvorlage für Moodleversionen vor 1.7. Bitte folgen Sie dem README im zip-Verzeichnis.