Entwickler:Module

Anmerkung: Dieser Artikel gehört zur Dokumentation für Entwickler. Da es sich bei Moodle um eine Open-Source-Software mit einer internationalen Community und einem internationalen Entwicklerteam handelt, ist die gemeinsame Sprache Englisch. Die Übersetzung der Dokumentation für Entwickler steht daher nicht im Vordergrund. Stattdessen sei auf die englische Dokumentation für Entwickler verwiesen.

Lernaktivitäten-Module

Lernaktivitäten-Module befinden sich im mod Unterverzeichnis des Moodle-Verzeichnisses, wobei für jede Lernaktivität ein eigenes Unterverzeichnis existiert. Damit ein Modul von Moodle ordnungsgemäß eingebunden werden kann, ist es bei der Entwicklung eigener Module zwingend erforderlich, dass im Verzeichnis mod/IhrModul 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ährend des Aktualisierungsvorgangs
• db/access.php - definiert Zugriffsrechte des Moduls
• index.php - eine Seite, die alle Instanzen in einem Kurs auflistet
• view.php - eine Seite, um eine Instanz des Moduls zu betrachten
• lib.php - alle modulspezifischen Funktionen sollten in diese Datei geschrieben werden;

Beispiel: Wenn der Modulname widget ist, dann ist die Implementierung der folgenden Funktionen erforderlich:

• widget_install() - wird während der Installation aufgerufen
• widget_add_instance() - Code, um eine neue Instanz von 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 Nutzerbeitrags für eine Modulinstanz
• widget_user_complete() - druckt Details zum Nutzerbeitrag 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 Datei mod_form.php) innerhalb eines Vorprozesses vorzuverarbeiten
  • widget_reset_course_form() und widget_reset_userdata() - wird verwendet, um die Kurs zurücksetzen-Funktionalität zu implementieren
• 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 Standardwerten für Konfigurationsparameter. Der Inhalt dieser Datei wird durch das Modul upgrade_activity_modules in lib/adminlib.php eingebunden 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.

Wichtige Hinweise

• Wenn Sie ein neues Modul anlegen, darf der Modulname keine Zahlen oder Sonderzeichen enthalten!
• Sie müssen eine sogenannte Tabelle in der Moodle-Datenbank erstellen mit dem gleichen Namen, den Sie auch Ihrem Modul gegeben haben. Diese Tabelle muss mindestens drei Datenbankfelder besitzen:

   id 
   course 
   name

• Vergewissern Sie sich bitte, dass ihr Modul (in angemessener Weise) auch für die Verwendung innerhalb von Gruppen und Metakursen ausgelegt ist.

Siehe auch

• Eigene Blöcke erstellen - siehe Blocks (engl.)
• Backup-Routine für eigene Module erstellen - siehe Backup (engl.)
• Eintrag im Bug-Tracker [https://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - enthält einen Download-Link zu einer neuen Vorlage für ein Modul (mit Unterstützung von Rollen, Formularbibliothek usw., unvollständig!);
• http://download.moodle.org/plugins16/mod/NEWMODULE.zip - neue Vorlage für Module vor Moodle 1.7; beachten Sie die README-Anleitungen innerhalb der zip-Datei.
• Dokumentation zur Entwicklung neuer Module (engl.)

Diskussionsbeiträge im Kurs Using Moodle auf moodle.org:

• A new resource type: where do I put the language strings?
• New Module Template Code for Moodle 1.7
• LEGACY roles and capabilities