InterfaceWebhookTriggers Class Reference

Class of triggers for Webhook module. More...

Inheritance diagram for InterfaceWebhookTriggers:

Collaboration diagram for InterfaceWebhookTriggers:

Public Member Functions
	__construct ($db)
	Constructor.
	runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
	Function called when a Dolibarr 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.
	setErrorsFromObject ($object)
	setErrorsFromObject

Private Member Functions
	removeDbFromPayload (&$payload, $depth=0)
	Remove the db property from a payload, including the objects nested into its arrays.

Detailed Description

Class of triggers for Webhook module.

Definition at line 35 of file interface_95_modWebhook_WebhookTriggers.class.php.

Constructor & Destructor Documentation

__construct()

InterfaceWebhookTriggers::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 42 of file interface_95_modWebhook_WebhookTriggers.class.php.

References description, and name.

Member Function Documentation

removeDbFromPayload()

InterfaceWebhookTriggers::removeDbFromPayload ( & $payload, $depth = 0 )

private

Remove the db property from a payload, including the objects nested into its arrays.

Parameters

	object|array<mixed>	$payload Payload to clean, modified in place
int	$depth	Current recursion depth, used as a safety stop

Returns

void

Definition at line 211 of file interface_95_modWebhook_WebhookTriggers.class.php.

References removeDbFromPayload().

Referenced by removeDbFromPayload(), and runTrigger().

runTrigger()

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

Function called when a Dolibarr business event is done.

All functions "runTrigger" are triggered if file of function is inside directory core/triggers.

Parameters

string	$action	Event action code
CommonObject	$object	Object
User	$user	Object user
Translate	$langs	Object langs
Conf	$conf	Object conf

Returns

int Return integer <0 if KO, 0 if no triggered ran, >0 if OK

Reimplemented from DolibarrTriggers.

Definition at line 65 of file interface_95_modWebhook_WebhookTriggers.class.php.

References $object, dol_clone_in_array(), dol_syslog(), getDolGlobalString(), getDoliDBInstance(), getURLContent(), isModEnabled(), name, and removeDbFromPayload().

---

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

• dolibarr_23.0/htdocs/core/triggers/interface_95_modWebhook_WebhookTriggers.class.php