DolibarrTriggers

abstract class DolibarrTriggers (View source)

Class that all triggers must inherit

Constants

deprecated VERSION_DEVELOPMENT

deprecated VERSION_EXPERIMENTAL

deprecated VERSION_DOLIBARR

VERSIONS

Properties

protected DoliDB $db

Database handler
mixed|string $name

Name of the trigger
string $description

Description of the trigger
""|"development"|"dolibarr"|"experimental" $version

Version of the trigger
string $picto

Image of the trigger
string $family

Category of the trigger
$error

Error reported by the trigger
string[] $errors

Errors reported by the trigger
string[] $warnings

Warnings reported by the trigger

Methods

__construct(DoliDB $db)

Constructor

string
getName()

Returns the name of the trigger file

string
getDesc()

Returns the description of trigger file

string
getVersion()

Returns the version of the trigger file

void
setErrorsFromObject(CommonObject|BlockedLog $object)

setErrorsFromObject

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

Function called when a Dolibarr business event is done.

Details

at line 117
__construct(DoliDB $db)

Constructor

Parameters

DoliDB $db

Database handler

at line 134
string getName()

Returns the name of the trigger file

Return Value

string

at line 144
string getDesc()

Returns the description of trigger file

Return Value

string

at line 154
string getVersion()

Returns the version of the trigger file

Return Value

string

Version of trigger file

at line 176
void setErrorsFromObject(CommonObject|BlockedLog $object)

setErrorsFromObject

Parameters

CommonObject|BlockedLog $object Object

Return Value

void

at line 205
abstract runTrigger(string $action, $object, User $user, Translate $langs, Conf $conf)

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 @param CommonObject $object CommonObject @param User $user Object user @param Translate $langs Object langs @param Conf $conf Object conf @return int if KO: <0 || if no trigger ran: 0 || if OK: >0
$object
User $user
Translate $langs
Conf $conf