InterfaceLdapsynchro

class InterfaceLdapsynchro extends DolibarrTriggers (View source)

Class of triggers for ldap 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

from  DolibarrTriggers
string
getDesc()

Returns the description of trigger file

from  DolibarrTriggers
string
getVersion()

Returns the version of the trigger file

from  DolibarrTriggers
void
setErrorsFromObject(CommonObject|BlockedLog $object)

setErrorsFromObject

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

Function called when a Dolibarr business event is done.

Details

at line 41
__construct(DoliDB $db)

Constructor

Parameters

DoliDB $db

Database handler

in DolibarrTriggers at line 134
string getName()

Returns the name of the trigger file

Return Value

string

in DolibarrTriggers at line 144
string getDesc()

Returns the description of trigger file

Return Value

string

in DolibarrTriggers at line 154
string getVersion()

Returns the version of the trigger file

Return Value

string

Version of trigger file

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

setErrorsFromObject

Parameters

CommonObject|BlockedLog $object Object

Return Value

void

at line 63
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