dolibarr  7.0.0-beta
Public Member Functions | List of all members
InterfaceActionsAuto Class Reference

Class of triggered functions for agenda module. More...

+ Inheritance diagram for InterfaceActionsAuto:
+ Collaboration diagram for InterfaceActionsAuto:

Public Member Functions

 runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
 Function called when a Dolibarrr business event is done. More...
 
- Public Member Functions inherited from DolibarrTriggers
 __construct (DoliDB $db)
 Constructor. More...
 
 getName ()
 Returns the name of the trigger file. More...
 
 getDesc ()
 Returns the description of trigger file. More...
 
 getVersion ()
 Returns the version of the trigger file. More...
 
 runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
 Function called when a Dolibarrr business event is done. More...
 

Detailed Description

Class of triggered functions for agenda module.

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

Member Function Documentation

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

Function called when a Dolibarrr 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) $object->socid (id of thirdparty) $object->fk_project $object->fk_element $object->elementtype

Parameters
string$actionEvent action code
Object$objectObject
User$userObject user
Translate$langsObject langs
conf$confObject conf
Returns
int <0 if KO, 0 if no triggered ran, >0 if OK

Definition at line 63 of file interface_50_modAgenda_ActionsAuto.class.php.

References dol_concatdesc(), dol_copy(), dol_mkdir(), dol_now(), dol_print_date(), dol_syslog(), Translate\load(), name, and Translate\transnoentities().


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