class InterfaceEventOrganization extends DolibarrTriggers (View source)

Class of triggered functions for agenda module

Constants

deprecated VERSION_DEVELOPMENT

deprecated VERSION_EXPERIMENTAL

deprecated VERSION_DOLIBARR

VERSIONS

Properties

protected DoliDB $db

Database handler

from  DolibarrTriggers
mixed|string $name

Name of the trigger

from  DolibarrTriggers
string $description

Description of the trigger

from  DolibarrTriggers
""|"development"|"dolibarr"|"experimental" $version

Version of the trigger

from  DolibarrTriggers
string $picto

Image of the trigger

from  DolibarrTriggers
string $family

Category of the trigger

from  DolibarrTriggers
$error

Error reported by the trigger

from  DolibarrTriggers
string[] $errors

Errors reported by the trigger

from  DolibarrTriggers
string[] $warnings

Warnings reported by the trigger

from  DolibarrTriggers

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

__construct(DoliDB $db)

Constructor

Parameters

DoliDB $db

Database handler

string getName()

Returns the name of the trigger file

Return Value

string

string getDesc()

Returns the description of trigger file

Return Value

string

string getVersion()

Returns the version of the trigger file

Return Value

string

Version of trigger file

void setErrorsFromObject(CommonObject|BlockedLog $object)

setErrorsFromObject

Parameters

CommonObject|BlockedLog $object Object

Return Value

void

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)

Following properties may be set before calling trigger. The may be completed by this trigger to be used for writing the event into database: $object->actiontypecode (translation action code: AC_OTH, ...) $object->actionmsg (note, long text) $object->actionmsg2 (label, short text) $object->sendtoid (id of contact or array of ids of contacts) $object->socid (id of thirdparty) $object->fk_project $object->fk_element (ID of object to link action event to) $object->elementtype (->element of object to link action to) $object->module (if defined, elementtype in llx_actioncomm will be elementtype@module)

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