dolibarr  20.0.0-alpha
Public Member Functions | List of all members
mailing_eventorganization Class Reference

Class to manage a list of personalised recipients for mailing feature. More...

Inheritance diagram for mailing_eventorganization:
Inheritance graph
[legend]
Collaboration diagram for mailing_eventorganization:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 add_to_target ($mailing_id)
 This is the main function that returns the array of emails. More...
 
 getSqlArrayForStats ()
 On the main mailing area, there is a box with statistics. More...
 
 getNbOfRecipients ($sql='')
 Return here number of distinct emails returned by your selector. More...
 
 formFilter ()
 This is to add a form filter to provide variant of selector If used, the HTML select must be called "filter". More...
 
 url ($id, $sourcetype='thirdparty')
 Can include an URL link on each record provided by selector shown on target page. More...
 
- Public Member Functions inherited from MailingTargets
 getDesc ()
 Return description of email selector. More...
 
 getNbOfRecords ()
 Return number of records for email selector. More...
 
 update_nb ($mailing_id)
 Met a jour nombre de destinataires. More...
 
 addTargetsToDatabase ($mailing_id, $cibles)
 Add a list of targets into the database. More...
 
 clear_target ($mailing_id)
 Supprime tous les destinataires de la table des cibles. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MailingTargets
static getEmailingSelectorsList ($forcedir=null)
 Return list of widget. More...
 

Detailed Description

Class to manage a list of personalised recipients for mailing feature.

Definition at line 27 of file eventorganization.modules.php.

Constructor & Destructor Documentation

◆ __construct()

mailing_eventorganization::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from MailingTargets.

Definition at line 50 of file eventorganization.modules.php.

Member Function Documentation

◆ add_to_target()

mailing_eventorganization::add_to_target (   $mailing_id)

This is the main function that returns the array of emails.

Parameters
int$mailing_idId of mailing. No need to use it.
Returns
int Return integer <0 if error, number of emails added if ok

Definition at line 66 of file eventorganization.modules.php.

◆ formFilter()

mailing_eventorganization::formFilter ( )

This is to add a form filter to provide variant of selector If used, the HTML select must be called "filter".

Returns
string A html select zone

Reimplemented from MailingTargets.

Definition at line 186 of file eventorganization.modules.php.

◆ getNbOfRecipients()

mailing_eventorganization::getNbOfRecipients (   $sql = '')

Return here number of distinct emails returned by your selector.

For example if this selector is used to extract 500 different emails from a text file, this function must return 500.

Parameters
string$sqlRequete sql de comptage
Returns
int|string Nb of recipient, or <0 if error, or '' if NA

Reimplemented from MailingTargets.

Definition at line 160 of file eventorganization.modules.php.

◆ getSqlArrayForStats()

mailing_eventorganization::getSqlArrayForStats ( )

On the main mailing area, there is a box with statistics.

If you want to add a line in this report you must provide an array of SQL request that returns two field: One called "label", One called "nb".

Returns
array Array with SQL requests

Definition at line 142 of file eventorganization.modules.php.

◆ url()

mailing_eventorganization::url (   $id,
  $sourcetype = 'thirdparty' 
)

Can include an URL link on each record provided by selector shown on target page.

Parameters
int$idID
string$sourcetypeSource type
Returns
string Url link

Definition at line 209 of file eventorganization.modules.php.


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