開發文檔


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


組織和開發工具

本章包含在開始任何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

業務對象

請參閱 業務對象

菜單系統

請參閱 菜單.

選項卡系統

請參閱 選項卡.

主題系統

請參閱 主題.

消息框/widget小組件系統

請參閱 消息框/widget小組件.

身份認證系統

請參閱 認證.

權限系統

請參閱 用戶權限.

翻譯系統

請參閱 翻譯.

錯誤處理

請參閱 錯誤處理

畫布系統(屏幕重載)

畫布是一種開發功能,用於替換創建、更新或查看/展示表單(產品、合作方、聯繫人等)的屏幕顯示。例如,您可以將合作方輸入表單替換為您自己的輸入表單、編輯表單或查看/展示表單。

請參閱 畫布.

觸發器系統

觸發器是一種開發功能,用於在Dolibarr「業務操作」(創建發票、刪除用戶、更新合作方等)執行期間運行自定義代碼,僅適用於業務事件。要在其他場景中自定義代碼,請參閱 鈎子系統

請參閱 觸發器系統

鈎子系統

請參閱 鈎子系統

變量替換系統

請參閱 變量替換系統

Web服務

可以配置 Dolibarr 為外部系統提供可訪問的服務。

請參閱 提供REST API的Web服務模塊(開發者)

注意:提供SOAP API的Web服務模塊(開發者)已棄用。

文件/文檔的存儲管理

請參閱 生成的文件

編號模塊

對於在應用程序中創建的每個實體,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. 導出模塊

與其他應用程序的接口和鏈接

  1. Dolibarr到外部系統的接口 或 Dolibarr到Dolibarr的接口(Dolibarr觸發器或鈎子)
  2. 外部系統到Dolibarr的接口
  3. Web Services

將 Dolibarr 集成到自動化平台

FAQ

所有常見問題(FAQs)解答均可通過 FAQ 索引頁面 FAQ EN 獲取。