開發:模塊 (開發者)

出自MoodleDocs
於 2008年12月3日 (三) 07:25 由 planetoid hsu對話 | 貢獻 所做的修訂 (add link to en version)
(差異) ←上個修訂 | 最新修訂 (差異) | 下個修訂→ (差異)
跳到:導覽、​搜尋

開發說明:組件
本說明來自Moodle文檔
激活的插件位於「mod」目錄下。每一個插件在一個獨立的子文件夾下,每個插件必須包括以下文件(其他文件可以自定義)
mod_form.php - 一個安裝或者升級這個組件的實例的方式
version.php - 版本定義
icon.gif - 16×16的組件圖標
db/install.xml - 定義所有類型的數據庫的表格結構。用於組件安裝。
db/upgrade.php - 定義數據庫結構升級模塊。用於組件升級。
db/access.php - 定義組件性能。
index.php - 組件首頁。
view.php - 察看某一特殊實例的頁面
lib.php - 所有的組件函數定義應當在這裏。若模塊名為「widget」,則需要包含的函數有:
widget_install() - 在安裝組件時將被調用
widget_add_instance() - 添加一個新實例的代碼
widget_update_instance() - 升級一個已存在實例的代碼
widget_delete_instance() - 刪除一個實例的代碼
widget_user_outline() - 給定一個實例,返回用戶基值的累計
widget_user_complete() - 給定一個實例,打印用戶基值的詳細信息
其他可用的但不是必需的函數有:
widget_delete_course() - 清除刪除所有實例後可能遺留的任何東西
widget_process_options() - 對組件設置中的表單數據進行預處理
widget_reset_course_form() and widget_delete_userdata() - 用於重置表單數據
為避免可能出現的衝突,任何模塊函數名都必須以widget_開頭,且任何常量必須以WIDGET_開頭
backuplib.php and restorelib.php (可選)
settings.php - (可選) 一個表單定義,用於安裝或升級模塊中全局變量(可選)
lang/en_utf8/widget.php - (可選) 最後,每一個自建會有包含各自字符串的某語種文件

重要: 創建一個新模塊時,新的模塊名不能包含數字和其他特殊字符
同時應保證活動的組件為組和元進程提供適當的支持