DolibarrTriggers Class Reference

Class that all triggers must inherit. More...

Inheritance diagram for DolibarrTriggers:

Collaboration diagram for DolibarrTriggers:

Public Member Functions
	__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
	runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
	Function called when a Dolibarr business event is done.

Detailed Description

Class that all triggers must inherit.

Definition at line 24 of file dolibarrtriggers.class.php.

Constructor & Destructor Documentation

__construct()

DolibarrTriggers::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented in InterfaceLogevents.

Definition at line 117 of file dolibarrtriggers.class.php.

References description, and name.

Member Function Documentation

getDesc()

DolibarrTriggers::getDesc

(

)

Returns the description of trigger file.

Returns

string

Definition at line 144 of file dolibarrtriggers.class.php.

getName()

DolibarrTriggers::getName

(

)

Returns the name of the trigger file.

Returns

string

Definition at line 134 of file dolibarrtriggers.class.php.

getVersion()

DolibarrTriggers::getVersion

(

)

Returns the version of the trigger file.

Returns

string Version of trigger file

Definition at line 154 of file dolibarrtriggers.class.php.

runTrigger()

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

abstract

Function called when a Dolibarr 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
CommonObject	$object	CommonObject
User	$user	Object user
Translate	$langs	Object langs
Conf	$conf	Object conf

Returns

int if KO: <0 || if no trigger ran: 0 || if OK: >0

Reimplemented in InterfaceActionsAuto, InterfaceContactRoles, InterfaceEventOrganization, InterfaceLogevents, InterfaceMailmanSpipsynchro, InterfaceMyModuleTriggers, InterfaceNotification, InterfaceStripe, InterfaceWebhookTriggers, and InterfaceZapierTriggers.

setErrorsFromObject()

DolibarrTriggers::setErrorsFromObject

(

$object

)

setErrorsFromObject

Parameters

CommonObject | BlockedLog

$object

Object

Returns

void

Definition at line 176 of file dolibarrtriggers.class.php.

References $object.

---

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

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