View source for 触发系统

<!-- BEGIN interlang links -->
<!-- Do NOT edit this section
     Links below are automatically managed by PolyglotBot
     You can edit links on the English source page : Triggers_system -->
[[en:Triggers_system]]
[[fr:Système de Triggers]]
[[es:Triggers-acciones]]
<!-- END interlang links -->

{{TemplateDocDevZh}}

=将您的代码添加到业务事件=
为了能够触发自定义代码以响应Dolibarr事件（创建/修改/删除、公司/发票/产品/用户或其他），Dolibarr提供了一种业务触发机制。例如，此机制允许您自定义工作流，以便Dolibarr的管理事件可以反映到另一个应用程序中。也没有什么可以阻止使用它来改变Dolibarr本身的行为：例如，在验证发票后自动创建合同、在删除记录时填写日志文件...

请注意，触发器是一项开发功能，仅限于CRUD业务事件（创建|读取|更新|删除）。还有另一个功能允许开发人员将自定义代码注入应用程序，名为 [[Hooks system]] 。

因此，要添加将由触发器触发的自己的代码，过程如下：

1)'''htdocs/modulebuilder/template/core/triggers/interface_99_modMyModule_MyModuleTriggers.class.php'''u文件复制一份，命名为 '''interface_99_all_''Xxx''.class.php''' 或 '''interface_99_mod''MyModule_Xxx''.class.php'''

其中 '''''Xxx''''' 是您选择的以大写字母开头的字符串；'''99'''是触发器的优先级号（01是最高优先级）；如果您希望触发器仅在 myModule 处于活动状态时才应激活，则'''''MyModule'''''是模块的名称；如果我们希望触发器始终处于活动状态，我们将使用'''all'''代替'''mod''MyModule'''''。此新文件必须保留在同一目录中。

注意：可用于 '''mod''MyModule''''' 的值在目录 ''htdocs/core/modules'' 中可见。

'''警告：所有'''这些参数都是检测触发器所必需的！例如，如果您忘记了优先级号，将无法检测到该触发器！

例如，我们可以将我们的新触发器命名为 ''htdocs/core/triggers/interface_99_modFacture_Myworkflow.class.php''

通过创建一个名为本例的文件，我们的新触发器将在每个Dolibarr业务事件中触发，前提是发票模块处于活动状态。

'''注意'''：使用Dolibarr 3.2+，还可以将触发器文件放置在模块的子文件夹中。例如：如果模块位于htdocs/mymodule/中，则可以将触发器放置在htdocs/mymodule/core/triggers/中。但在这种情况下，必须将触发器声明到模块的描述符文件（如： '''/mymodule/core/modules/modMyModule.class.php'''）中，才会找到触发器。

为此，请在数组 module_parts 中添加 'triggers' => 1

<syntaxhighlight lang="php">
// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)
$this->module_parts = array('triggers' => 1);
//$this->module_parts = array('triggers' => 1,
//              'login' => 0,
//              'substitutions' => 0,
//              'menus' => 0);
</syntaxhighlight>

然后停用并重新激活模块。这将在 [[Table llx_const|表llx_const]] 中添加一行记录，告诉Dolibarr必须在模块的目录 '''htdocs/mymodule/core/triggers/''' 中查找触发器。

2)编辑文件''interface_99_modMyModule_Myworkflow.class.php''，以便将''InterfaceDemo''类重命名为''InterfaceMyworkflow''

然后转到 '''主页->管理工具->关于Dolibarr->Triggers'''。您的触发器文件应显示在“可用的触发器”清单中，表明前面的操作已成功完成。

3) 现在返回编辑触发器文件，将代码添加到 ''run_trigger'' 函数中。此函数在每个Dolibarr业务事件中调用。根据您希望响应的事件放置代码，每个事件都由一个代码标识（代码列表请参阅下一章），您可以通过判断变量 '''$action''' 对给定事件做出反应，也可以不做出反应：

<syntaxhighlight lang="php">
  function run_trigger($action,$object,$user,$langs,$conf)
  {
        // Put here code to execute after an action
        // The type of Dolibarr business event is stored into $action
        // Data of action are stored into object $object
        // Setup, user and language are saved into $conf, $user and $lang
        if ($action == 'COMPANY_CREATE')
        {
            dol_syslog("Trigger for action '$action' launched. id=".$object->id);
        }
        elseif ($action == 'COMPANY_MODIFY')
        {        
            dol_syslog("Trigger for action '$action' launched. id=".$object->id);
        }
        elseif ($action == 'COMPANY_DELETE')
        ...
  }
</syntaxhighlight>

只要 ''run_trigger'' 函数根据以下原则返回一个返回代码，您就可以在这段代码中执行任何操作：

<0（如果ko），0（如果没有执行任何操作），>0（如果ok）

此外，在此函数中，您可以使用以下对象：

*'''$object''' 是操作所针对的对象（请参阅下一章）
*'''$user''' 是执行操作的dolibarr用户的对象
*'''$langs''' 是包含dolibarr用户语言的对象
*'''$conf''' 是包含整个Dolibarr配置的对象。

4) 代码开发完成后，只需在Dolibarr中触发触发事件即可进行测试。注意，函数 '''run_trigger''' 的调用被封装在事务中。如果触发器返回代码是 ko，调用函数可能会回滚事务（这取决于调用函数）。要在函数 '''run_trigger''' 中添加日志跟踪，用以确保代码运行良好。如果您愿意，可以使用函数 dol_syslog("my log message", LOG_DEBUG)；

=管理事件列表=

以下是导致触发器被搜索和执行的事件的快速视图。事件的特征在于事件代码 ''$action'' 的值，以及在 ''$object'' 中接收的对象类型。

注意：[[日程模块]] 和 [[Module Notification|通知模块]] 使用  [[Table llx c action trigger|表llx c action trigger]]  作为已知触发器的表。这避免了扫描磁盘以获取此信息，但此表仅包含非常有限的触发器列表。

通常，触发事件代码 ''$action'' 以模块名称开头，后跟字符 _ 。

{{TemplateListOfTriggers}}
此清单可能不完整。

=创建新的触发器事件=

要处理上述事件之外的其它事件，必须修改 Dolibarr 代码，以便在操作对象类的业务方法中添加以下序列：

<syntaxhighlight lang="php">
// Call trigger
//$this->context = array('paramX'=>$valueX);
$result = $this->call_trigger('XXXXX_YYYYY', $user);
if ($result <0) $error++;
// End call triggers
</syntaxhighlight>

然后，可以在任何触发器文件的 run_trigger 方法中添加一个 if 来管理该代码。run_trigger 方法的形式如下：

<syntaxhighlight lang="php">
function run_trigger($action,$object,$user,$lang,$conf)
{
      // Put here code to execute after an action
      // The type of Dolibarr business event is stored into $action
      // Data of action are stored into object $object
      // Setup, user and language are saved into $conf, $user and $lang
      if ($action == 'XXXXX_YYYYY')
      {
          dol_syslog("Trigger for action '$action' launched. id=".$object->id);
      }
      elseif ($action == 'COMPANY_CREATE')
      {
          dol_syslog("Trigger for action '$action' launched. id=".$object->id);
      }
      elseif ($action == 'COMPANY_MODIFY')
      {        
          dol_syslog("Trigger for action '$action' launched. id=".$object->id);
      }
      elseif ($action == 'COMPANY_DELETE')
      ...
}
</syntaxhighlight>

=结论=
因此，您可以在几分钟内添加一个Dolibarr到外部系统的接口，而不会有任何风险，因为我们没有接触 Dolibarr 代码，我们只是在触发器目录中放置了一个新的触发器文件。如果此接口对其他人有用，请毫不犹豫地将其打包为tgz文件（请参阅页面 [[模块开发#创建一个安装包来分发和安装您的模块]]），并将其提交到Dolibarr官网上的贡献下载空间。

=See also=

*[[Hooks system]]
*[[Dolibarr到外部系统的接口]]
*[[外部系统到Dolibarr的接口]]