dolibarr  9.0.0
Public Member Functions | List of all members
Notify Class Reference

Class to manage notifications. More...

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 confirmMessage ($action, $socid, $object)
 Return message that say how many notification (and to which email) will occurs on requested event. More...
 
 getNotificationsArray ($notifcode, $socid=0, $object=null, $userid=0, $scope=array('thirdparty', 'user', 'global'))
 Return number of notifications activated for action code (and third party) More...
 
 send ($notifcode, $object, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array())
 Check if notification are active for couple action/company. More...
 

Detailed Description

Class to manage notifications.

Definition at line 32 of file notify.class.php.

Constructor & Destructor Documentation

◆ __construct()

Notify::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 93 of file notify.class.php.

Member Function Documentation

◆ confirmMessage()

Notify::confirmMessage (   $action,
  $socid,
  $object 
)

Return message that say how many notification (and to which email) will occurs on requested event.

This is to show confirmation messages before event is recorded.

Parameters
string$actionId of action in llx_c_action_trigger
int$socidId of third party
Object$objectObject the notification is about
Returns
string Message

Definition at line 108 of file notify.class.php.

◆ getNotificationsArray()

Notify::getNotificationsArray (   $notifcode,
  $socid = 0,
  $object = null,
  $userid = 0,
  $scope = array('thirdparty', 'user', 'global') 
)

Return number of notifications activated for action code (and third party)

Parameters
string$notifcodeCode of action in llx_c_action_trigger (new usage) or Id of action in llx_c_action_trigger (old usage)
int$socidId of third party or 0 for all thirdparties or -1 for no thirdparties
Object$objectObject the notification is about (need it to check threshold value of some notifications)
int$useridId of user or 0 for all users or -1 for no users
array$scopeScope where to search
Returns
array|int <0 if KO, array of notifications to send if OK

Definition at line 149 of file notify.class.php.

◆ send()

Notify::send (   $notifcode,
  $object,
  $filename_list = array(),
  $mimetype_list = array(),
  $mimefilename_list = array() 
)

Check if notification are active for couple action/company.

If yes, send mail and save trace into llx_notify.

Parameters
string$notifcodeCode of action in llx_c_action_trigger (new usage) or Id of action in llx_c_action_trigger (old usage)
Object$objectObject the notification deals on
array$filename_listList of files to attach (full path of filename on file system)
array$mimetype_listList of MIME type of attached files
array$mimefilename_listList of attached file name in message
Returns
int <0 if KO, or number of changes if OK

Definition at line 312 of file notify.class.php.


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