Difference between revisions of "开发文档"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Tag: 2017 source edit
Line 72: Line 72:
  
 
==业务对象==
 
==业务对象==
[[业务对象]]
+
请参阅 [[业务对象]]
  
==菜单==
+
==菜单系统==
[[菜单]].
+
请参阅 [[菜单]].
  
==选项卡==
+
==选项卡系统==
[[选项卡]].
+
请参阅 [[选项卡]].
  
==主题==
+
==主题系统==
[[主题]].
+
请参阅 [[主题]].
  
==信息框==
+
==小部件系统==
[[信息框]].
+
请参阅 [[信息框]].
  
==身份认证==
+
==身份认证系统==
[[认证]].
+
请参阅 [[认证]].
  
==权限==
+
==权限系统==
[[用户权限]].
+
请参阅 [[用户权限]].
  
==翻译==
+
==翻译系统==
[[翻译]].
+
请参阅 [[翻译]].
  
==错误信息==
+
==错误管理==
[[Error reporting|Error reporting]].
+
请参阅 [[Error reporting|Error reporting]].
  
==画布==
+
==画布系统(屏幕重载)==
 
'''画布'''是替换屏幕显示的开发功能。
 
'''画布'''是替换屏幕显示的开发功能。
  
Line 105: Line 105:
 
例如,您可以替换掉系统自带的“新建合伙人”的窗体,或者“修改合伙人”的窗体,或者替换掉"查看合伙人"的模板。
 
例如,您可以替换掉系统自带的“新建合伙人”的窗体,或者“修改合伙人”的窗体,或者替换掉"查看合伙人"的模板。
 
   
 
   
[[画布]].
+
请参阅 [[画布]].
  
==触发器==
+
==触发器系统==
 
触发器是在Dolibarr“业务事件”(创建发票、删除用户、更新第三方等)中执行个性化代码的开发功能,仅用于业务事件。其他情景的个性化代码,请查看“钩子”章节。
 
触发器是在Dolibarr“业务事件”(创建发票、删除用户、更新第三方等)中执行个性化代码的开发功能,仅用于业务事件。其他情景的个性化代码,请查看“钩子”章节。
  
[[Interfaces Dolibarr toward foreign systems|this page]].
+
请参阅 [[Interfaces Dolibarr toward foreign systems|this page]].
  
 
==钩子==
 
==钩子==
[[钩子系统]].
+
请参阅 [[钩子系统]].
  
==变量代换==
+
==变量代换系统==
[[Variable substitution system]].
+
请参阅 [[Variable substitution system]].
  
 
==Web服务==
 
==Web服务==
 
Dolibarr可以设置提供一些服务。
 
Dolibarr可以设置提供一些服务。
  
[[Module Web Services]].
+
请参阅 [[Module Web Services]].
  
==文件存储==
+
==文件/文档的存储管理==
[[Generated documents]].
+
请参阅 [[Generated documents]].
  
 
==编号模块==
 
==编号模块==
Line 135: Line 135:
 
然而,仍然存在所提供的模块不满足需要的情况。在这种情况下,有必要开发自定义编号模块。
 
然而,仍然存在所提供的模块不满足需要的情况。在这种情况下,有必要开发自定义编号模块。
  
[[自动编号模块|自动编号模块]].
+
请参阅 [[自动编号模块|自动编号模块]].
  
==模板==
+
==文档模板和文档生成==
  
关于模板生成文档的更多文档见 [[创建PDF模板]] 或 [[Create an ODT document template]].
+
关于模板生成文档的更多文档,请参阅 [[创建PDF模板]] 或 [[Create an ODT document template]].
  
 
==附加字段==
 
==附加字段==
[[附加字段]].
+
请参阅 [[附加字段]].
  
 
==其他内部功能==
 
==其他内部功能==

Revision as of 01:54, 13 September 2023


页是与开发者文档相关的文章索引。有关使用者文档,请参阅 用户手册


组织和开发工具

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