InterfaceWorkflowManager Class Reference

Class of triggers for workflow module. More...

Inheritance diagram for InterfaceWorkflowManager:

Collaboration diagram for InterfaceWorkflowManager:

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

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

$db

Database handler

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

References description, 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	$action	Event action code
Object	$object	Object
User	$user	Object user
Translate	$langs	Object langs
conf	$conf	Object 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.

References dol_syslog(), getDolGlobalInt(), getDolGlobalString(), name, setEventMessage(), setEventMessages(), shouldClassify(), CommandeFournisseur\STATUS_ACCEPTED, Propal\STATUS_BILLED, Commande\STATUS_CLOSED, CommandeFournisseur\STATUS_ORDERSENT, CommandeFournisseur\STATUS_RECEIVED_COMPLETELY, CommandeFournisseur\STATUS_RECEIVED_PARTIALLY, Commande\STATUS_SHIPMENTONPROCESS, Propal\STATUS_SIGNED, SupplierProposal\STATUS_SIGNED, Commande\STATUS_VALIDATED, and Expedition\STATUS_VALIDATED.

shouldClassify()

InterfaceWorkflowManager::shouldClassify ( $conf, $totalonlinkedelements, $object_total_ht )

private

Parameters

Object	$conf	Dolibarr settings object
float	$totalonlinkedelements	Sum of total amounts (excl VAT) of invoices linked to $object
float	$object_total_ht	The 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 526 of file interface_20_modWorkflow_WorkflowManager.class.php.

References price2num().

Referenced by runTrigger().

---

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

• dolibarr_18.0/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php