開發文檔

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search


頁是與開發者文檔相關的文章索引。有關使用者文檔,請參閱 用戶手冊


組織和開發工具

本章包含在開始任何Dolibarr開發行動之前需要閱讀的一般信息。

  1. 項目組織
  2. 在開始開發之前要了解的信息
  3. 環境和開發工具
  4. 外部庫和依賴項
  5. 獲取、更新版本的原始碼

編碼規則和最佳實踐

  1. 先決條件
  2. 開發語言和標準(PHP, SQL, HTML)
  3. 數據庫表清單
  4. 核心文件和類樹結構請參閱: doxygen生成的文檔

模塊清單

特定於Dolibarr標準功能模塊的技術文檔在每個模塊的開發文檔頁上定義。請選擇要訪問的頁面:

為 GUI 開發新的模塊/擴展

本章介紹如何開發影響 Dolibarr 用戶界面的新模塊。可以是屏幕、外觀(主題)、代碼(CSS樣式表)或數據。

腳本開發不在此範圍內,將在下一章中進行描述。

要開發自己的Dolibarr擴展模塊,請前往教程:模塊開發

開發命令行或批處理腳本

本章描述了開發自己的批處理腳本以在Dolibarr中執行任務處理(讀、寫等)的過程。

對圖形用戶界面(GUI)進行變更不屬於此範圍。請參閱上一章。

要開發腳本,如 cron 處理腳本或從其他系統導入數據的腳本,請參閱:腳本開發

Dolibarr的技術組件

文件樹

當前版本的文件層次結構請參閱:原始碼的 doxygen generated documentation (生成文檔的樣式為「javadoc」)。

創建新模塊時用於添加文件的路徑在新模塊開發文檔中描述(請參閱 模塊開發)。

配置文件

  • /main.inc.php 定義Dolibarr GUI 環境(腳本不需要引用)
  • /master.inc.php 定義Dolibarr所有進程的環境,不管是頁面還是腳本。文件記取conf文件,初始化 $lang, $db和空的$user
  • /filefunc.inc.php 引用 conf.php 文件和其他通用庫文件,比如: functions.lib.php
  • /core/lib/function.inc.php 函數庫,包括了引用數據庫的函數。
  • /core/class/html.formother.class.php 其他HTML部件的預先配置文件

配置Dolibarr系統

Dolibarr中有3個級別的配置。

  • Dolibarr的技術配置(應用程式身份驗證模式、數據庫驗證信息和文件存儲位置)僅在 conf/conf.php 配置文件中定義。相關的更多信息,請參閱 Configuration file
  • 功能配置存儲在 表llx_const 中。相關的更多信息,請參閱 Constants
  • 特定於用戶的配置存儲在 表llx_user_param 中。相關的更多信息,請參閱 Constants

業務對象

請參閱 業務對象

菜單系統

請參閱 菜單.

選項卡系統

請參閱 選項卡.

主題系統

請參閱 主題.

小部件系統

請參閱 信息框.

身份認證系統

請參閱 認證.

權限系統

請參閱 用戶權限.

翻譯系統

請參閱 翻譯.

錯誤管理

請參閱 Error reporting.

畫布系統(屏幕重載)

畫布是替換屏幕顯示的開發功能。

以新模板替換老模板來'創建'、'編輯'或'顯示'記錄(產品,合伙人,聯繫人,…)。

例如,您可以替換掉系統自帶的「新建合伙人」的窗體,或者「修改合伙人」的窗體,或者替換掉"查看合伙人"的模板。

請參閱 畫布.

觸發器系統

觸發器是在Dolibarr「業務事件」(創建發票、刪除用戶、更新第三方等)中執行個性化代碼的開發功能,僅用於業務事件。其他情景的個性化代碼,請查看「鈎子」章節。

請參閱 this page.

鈎子

請參閱 鈎子系統.

變量代換系統

請參閱 Variable substitution system.

Web服務

Dolibarr可以設置提供一些服務。

請參閱 Module Web Services.

文件/文檔的存儲管理

請參閱 Generated documents.

編號模塊

對於在系統中創建的每個實體,Dolibarr自動分配引用。

為了適應任何使用的參考,Dolibarr使用模塊來定義引用生成規則。

系統提供了幾個標準模塊。有些是通用的,用於定義數字掩碼(字符有幾位數,有或沒有前綴,是否包括日期,等等),它們可以滿足大多數需要。

然而,仍然存在所提供的模塊不滿足需要的情況。在這種情況下,有必要開發自定義編號模塊。

請參閱 自動編號模塊.

文檔模板和文檔生成

關於模板生成文檔的更多文檔,請參閱 創建PDF模板Create an ODT document template.

附加字段

請參閱 附加字段.

在線支付系統

請參閱 附加字段.

其他內部功能

您的代碼可以使用許多內部庫。

您可以在functions.lib.php、functions2.lib.php或admin.lib.php中找到大量的函數。也可以使用在htdocs/core/lib/*.lib文件中找到的任何函數。


根據Dolibarr版本號指定需求

例如,為了創建一個Dolibarr版本>3.5的環境,可以使用admin.lib.php中發現的versioncompare和versiondolibarrarray:

if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
 ...
}

批量導出/導入

  1. 批量導入
  2. Mass exports

與其他應用程式的接口和連結

  1. Interfaces Dolibarr toward foreign systems or toward Dolibarr (Dolibarr Triggers)
  2. Interfaces from foreign systems toward Dolibarr
  3. Web Services

FAQ

All FAQs are available through the FAQ index page FAQ EN

--Roger-QQ12464313 09:00, 19 July 2018 (UTC)