Entwickler:Module: Unterschied zwischen den Versionen

Aktuelle Version vom 28. April 2009, 07:52 Uhr

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:

@@ Zeile 1: / Zeile 1: @@
-'''Activity modules''' reside in the 'mod' directory. Each module is in a separate subdirectory and consists of the following mandatory elements (plus extra scripts unique to each 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 [[:en:Development:Developer_documentation|Dokumentation für Entwickler]] verwiesen.
-* ''mod.html'' - a form to set up or update an instance of this module
+=== Lernaktivitäten-Module ===
-* ''version.php'' - defines some meta-info and provides upgrading code
+'''Lernaktivitäten-Module''' befinden sich im ''mod'' Unterverzeichnis des [[Moodle-Verzeichnis]]ses, wobei für jede [[Lernaktivitäten|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:
-* ''icon.gif'' - a 16x16 icon for the module
-* ''db/'' - SQL dumps of all the required db tables and data (for each database type)
-* ''index.php'' - a page to list all instances in a course
-* ''view.php'' - a page to view a particular instance
-* ''lib.php'' - any/all functions defined by the module should be in here. If the modulename is called widget, then the required functions include:
-:* widget_install() - will be called during the installation of the 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
-:** [[Development:Implementing Reset course functionality in a module|widget_reset_course_form() and widget_delete_userdata()]] - used to implement [[Reset course]] feature.
-:* 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
-* ''lang/en_utf8/resource_widget.php'' - (optional) 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!
+* ''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
+:** [[:en:Development:Implementing Reset course functionality in a module|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 <code>$defaults['_use_config_plugins']</code> 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.
-You should also make sure that your activity module provides appropriate support for groups and metacourses.
+=== 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:
+<pre>
+   id
+   course
+   name
+</pre>
+* Vergewissern Sie sich bitte, dass ihr Modul (in angemessener Weise) auch für die Verwendung innerhalb von Gruppen und Metakursen ausgelegt ist.
-==See also==
+==Siehe auch==
-* Tracker issue [http://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - including download link for new module template supporting roles, formslib etc. (unfinished)
+* Eigene [[Blöcke]] erstellen - siehe [[:en:Development:Blocks|Blocks]] (engl.)
-* http://download.moodle.org/plugins16/mod/NEWMODULE.zip - new module template for versions of Moodle prior to 1.7. Please follow the README instructions inside the zip.
+* Backup-Routine für eigene Module erstellen - siehe [[:en:Development:Backup|Backup]] (engl.)
-* Using Moodle [http://moodle.org/course/view.php?id=5 Activity modules] forum
+* Eintrag im Bug-Tracker [http://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!);
-* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=66165 A new resource type: where do I put the language strings?] forum discussion
+* 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.
-* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=65986 New Module Template Code for Moodle 1.7] forum discussion
+* [[:en:Development:NEWMODULE_Documentation|Dokumentation zur Entwicklung neuer Module]] (engl.)
+Diskussionsbeiträge im Kurs ''Using Moodle'' auf moodle.org:
+*[http://moodle.org/mod/forum/discuss.php?d=66165 A new resource type: where do I put the language strings?]
+*[http://moodle.org/mod/forum/discuss.php?d=65986 New Module Template Code for Moodle 1.7]
+*[http://moodle.org/mod/forum/discuss.php?d=90154 LEGACY roles and capabilities]
+[[Category:Entwickler]]
+[[en:Development:Modules]]