「モジュール (開発者)」の版間の差分

提供:MoodleDocs
移動先:案内検索
編集の要約なし
(H15i42 (トーク) の編集 ( 7331 版 ) を取り消し)
 
(3人の利用者による、間の21版が非表示)
1行目: 1行目:
作成中です - [[利用者:Mitsuhiro Yoshida|Mitsuhiro Yoshida]] 2006年12月7日 () 19:41 (CST)
'''活動モジュール'''は、'mod'ディレクトリ内にあります。それぞれのモジュールは、別々のサブディレクトリに分かれていて、次の必須要素を含みます (+ 各モジュール特有のスクリプト):


'''活動モジュール'''は、'mod'ディレクトリ内に入れられます。それぞれのモジュールは、分けられたディレクトリで、次の必須要素を含みます (+ それぞれのモジュール特有のスクリプト):
* ''mod.html'' - 本モジュールのインスタンスを生成・更新するためのフォーム
* ''version.php'' - メタ情報を定義し,アップグレード用コードを提供
* ''icon.gif'' - モジュールを表す 16x16 のアイコン
* ''db/'' - (各データベース形式毎の)必要な全てのDBテーブルとデータを生成するSQLコード
* ''index.php'' - コース内の全てのインスタンス一覧を表示するページ
* ''view.php'' - 特定のインスタンスを表示するページ
* ''lib.php'' - 本モジュールで定義されるあらゆる全ての関数はここに書く。例えばモジュール名が widget である場合,以下の関数が必須:


* ''mod.html'' - a form to set up or update an instance of this module
:* widget_install() - モジュールのインストール中に呼び出される
* ''version.php'' - defines some meta-info and provides upgrading code
:* widget_add_instance() - widget の新しいインスタンスを追加するためのコード
* ''icon.gif'' - a 16x16 icon for the module
:* widget_update_instance() - すでに存在するインスタンスを更新するためのコード
* ''db/'' - SQL dumps of all the required db tables and data (for each database type)
:* widget_delete_instance() - インスタンスを削除するためのコード
* ''index.php'' - a page to list all instances in a course
:* widget_user_outline() - 特定のインスタンスに対するユーザの貢献のサマリを返す
* ''view.php'' - a page to view a particular instance
:* widget_user_complete() - 特定のインスタンスに対するユーザの貢献の詳細を表示する
* ''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_add_instance() - code to add a new instance of widget
:** widget_delete_course() - すべてのインスタンスが削除された後に残る残骸をすべてきれいに消すコード
:* widget_update_instance() - code to update an existing instance
:** widget_process_options() - モジュール設定のフォームデータの前処理を行うコード
:* widget_delete_instance() - code to delete an instance
:** [[開発:コースのリセット機能をモジュールに実装する|widget_reset_course_form() と widget_delete_userdata()]] - [[コースのリセット]] 機能を実装するのに用いられる
:* widget_user_outline() - given an instance, return a summary of a user's contribution
:* モジュール同士の衝突を避けるために,すべてのモジュール関数の名前には頭に widget_ を付け,モジュール内で定義されるすべての定数の名前には頭に WIDGET_ を付けなければならない。
:* widget_user_complete() - given an instance, print details of a user's contribution
* ''config.html'' - (任意) 全インスタンスに共通の設定を指定・更新するためのフォーム
:* 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.


重要: When creating a new module, the new name of the module must not contain numbers or other special characters!
重要: 新たなモジュールを作るときは,そのモジュール名には番号や特殊な文字を含めないように!


You should also make sure that your activity module provides appropriate support for groups and metacourses.
また,あなたが作る活動モジュールが,グループやメタコースを適切にサポートするようにしてください。


==関連情報==
==関連情報==


* http://download.moodle.org/download.php/modules/NEWMODULE.zip - new module template for starting module development. Please follow the README instructions inside the zip.
* 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)
* 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.
* Using Moodle [http://moodle.org/course/view.php?id=5 Activity modules] forum
* Using Moodle [http://moodle.org/course/view.php?id=5 Activity modules] forum
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=66165 A new resource type: where do I put the language strings?] フォーラムでのディスカッション
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=65986 New Module Template Code for Moodle 1.7] フォーラムでのディスカッション


[[Category:開発者]]
[[Category:開発者]]
[[Category:モジュール]]
[[Category:モジュール]]
[[en:Development:Modules]]
[[es:Módulos de actividades (desarrollador)]]

2008年12月3日 (水) 14:54時点における最新版

活動モジュールは、'mod'ディレクトリ内にあります。それぞれのモジュールは、別々のサブディレクトリに分かれていて、次の必須要素を含みます (+ 各モジュール特有のスクリプト):

  • mod.html - 本モジュールのインスタンスを生成・更新するためのフォーム
  • version.php - メタ情報を定義し,アップグレード用コードを提供
  • icon.gif - モジュールを表す 16x16 のアイコン
  • db/ - (各データベース形式毎の)必要な全てのDBテーブルとデータを生成するSQLコード
  • index.php - コース内の全てのインスタンス一覧を表示するページ
  • view.php - 特定のインスタンスを表示するページ
  • lib.php - 本モジュールで定義されるあらゆる全ての関数はここに書く。例えばモジュール名が widget である場合,以下の関数が必須:
  • widget_install() - モジュールのインストール中に呼び出される
  • widget_add_instance() - widget の新しいインスタンスを追加するためのコード
  • widget_update_instance() - すでに存在するインスタンスを更新するためのコード
  • widget_delete_instance() - インスタンスを削除するためのコード
  • widget_user_outline() - 特定のインスタンスに対するユーザの貢献のサマリを返す
  • widget_user_complete() - 特定のインスタンスに対するユーザの貢献の詳細を表示する
  • 必須ではないが,使用可能なその他の関数:
  • モジュール同士の衝突を避けるために,すべてのモジュール関数の名前には頭に widget_ を付け,モジュール内で定義されるすべての定数の名前には頭に WIDGET_ を付けなければならない。
  • config.html - (任意) 全インスタンスに共通の設定を指定・更新するためのフォーム
  • 最後に,各モジュールにはそれぞれの言語ファイルが含まれている。

重要: 新たなモジュールを作るときは,そのモジュール名には番号や特殊な文字を含めないように!

また,あなたが作る活動モジュールが,グループやメタコースを適切にサポートするようにしてください。

関連情報