ModuleBuilder用戶手冊


啟用ModuleBuilder

從Dolibarr 10.0.0 開始,可以使用ModuleBuilder創建模塊,為激活ModuleBuilder,按以下步驟:

  • 主頁-設置-模塊中激活 ModuleBuilder.

 

  • 點擊右上角的『Bug』圖標開始使用(或者在瀏覽器中輸入'yourhost/modulebuilder')

 

  • 運行的ModuleBuilder界面如下:

 

使用ModuleBuilder創建主模塊文件

在下圖『模塊名』處填入模塊名,然後點擊右側的『創建』按鍵,完成創建模塊主文件。

  • 改變模塊ID值: $this->numero = 100000(將此100000變更為你為模塊設置的ID值)。為了避免與其他模塊發生衝突,您可以查閱列出已保留ID號的頁面: List of modules id.
  • 修改構造函數中定義的其他變量 (參考主模塊代碼框架中的注釋內容).
  • 您的模塊主文件已準備就緒。

 

使用ModuleBuilder生成PHP DAO類文件

  • 使用ModuleBuilder生成PHP DAO類文件,簡單至在下圖中選對'對象'選項卡,輸入'對象名',然後點擊創建,即可生成相關一切文檔。

 

  • 創建完成後,仍可繼續創建受模塊管理的其他「對象」
  • 「對象」選頂卡的界面如下:

 

如圖所示,ModuleBuilder自動幫我們建好了以下文件:

* PHP DAO CRUD类的文件 : mymodule/class/myobject.class.php 
* PHP API类的文件 : mymodule/class/api_mymodule.class.php 
* PHP单元测试类的文件 : mymodule/test/phpunit/MyObjectTest.php
* PHP库的文件 : mymodule/lib/myobject.lib.php
* Image : mymodule/img/object_myobject.png
* Sql文件 : mymodule/sql/llx_mymodule_myobject.sql
* Sql文件用于附加字段 : mymodule/sql/llx_mymodule_myobject_extrafields.sql 
* Sql文件(创建索引) : mymodule/sql/llx_mymodule_myobject.key.sql
* 用于显示记录列表的PHP页面 : mymodule/myobject_list.php
* 用于创建/编辑/查看记录的PHP页面 : mymodule/myobject_card.php?action=create(mymodule/myobject_card.php)
* 事件选项卡的PHP页面 : mymodule/myobject_agenda.php 
* 文档选项卡的PHP页面 : mymodule/myobject_document.php 
* 注释选项卡的PHP页面 : mymodule/myobject_note.php 
* ScriptFile : mymodule/scripts/myobject.php 

點擊每一條右側的圖標,即可以MB中編輯該文件,按下方保存按鍵保存。

另有「重新生成類文件和SQL文件」「生成丟失文件」兩按鍵可以使用。

「對象」選項卡的最下方,就是對象包含的字段。每行一個字段,可以增加名刪除字段。

 

為模塊添加語言文件

打開ModuleBuilder,選中模塊。

選中"語言",在語言框中選擇"zh_CN - 中文",然後點擊添加語言文件。 如圖: