dolibarr  17.0.0
Public Member Functions | Private Member Functions | List of all members
InterfaceWorkflowManager Class Reference

Class of triggers for workflow module. More...

Inheritance diagram for InterfaceWorkflowManager:
Inheritance graph
[legend]
Collaboration diagram for InterfaceWorkflowManager:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
 Function called when a Dolibarrr business event is done. More...
 
- Public Member Functions inherited from DolibarrTriggers
 __construct (DoliDB $db)
 Constructor. More...
 
 getName ()
 Returns the name of the trigger file. More...
 
 getDesc ()
 Returns the description of trigger file. More...
 
 getVersion ()
 Returns the version of the trigger file. More...
 

Private Member Functions

 shouldClassify ($conf, $totalonlinkedelements, $object_total_ht)
 

Detailed Description

Class of triggers for workflow module.

Definition at line 34 of file interface_20_modWorkflow_WorkflowManager.class.php.

Constructor & Destructor Documentation

◆ __construct()

InterfaceWorkflowManager::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 41 of file interface_20_modWorkflow_WorkflowManager.class.php.

References db, and name.

Member Function Documentation

◆ runTrigger()

InterfaceWorkflowManager::runTrigger (   $action,
  $object,
User  $user,
Translate  $langs,
Conf  $conf 
)

Function called when a Dolibarrr business event is done.

All functions "runTrigger" are triggered if file is inside directory htdocs/core/triggers or htdocs/module/code/triggers (and declared)

Parameters
string$actionEvent action code
Object$objectObject
User$userObject user
Translate$langsObject langs
conf$confObject conf
Returns
int <0 if KO, 0 if no triggered ran, >0 if OK

Reimplemented from DolibarrTriggers.

Definition at line 64 of file interface_20_modWorkflow_WorkflowManager.class.php.

◆ shouldClassify()

InterfaceWorkflowManager::shouldClassify (   $conf,
  $totalonlinkedelements,
  $object_total_ht 
)
private
Parameters
Object$confDolibarr settings object
float$totalonlinkedelementsSum of total amounts (excl VAT) of invoices linked to $object
float$object_total_htThe total amount (excl VAT) of the object (an order, a proposal, a bill, etc.)
Returns
bool True if the amounts are equal (rounded on total amount) True if the module is configured to skip the amount equality check False otherwise.

Definition at line 521 of file interface_20_modWorkflow_WorkflowManager.class.php.


The documentation for this class was generated from the following file: