dolibarr 21.0.0-alpha
mailing_mailing_mymodule_selector1 Class Reference

mailing_mailinglist_mymodule More...

Inheritance diagram for mailing_mailing_mymodule_selector1:
Collaboration diagram for mailing_mailing_mymodule_selector1:

Public Member Functions

 __construct ($db)
 Constructor.
 
 formFilter ()
 Display the filter form that appears in the mailing recipient selection page.
 
 url ($id)
 Return URL link to file of the source of the recipient of the mailing.
 
 add_to_target ($mailing_id)
 This is the main function that returns the array of emails.
 
 getSqlArrayForStats ()
 On the main mailing area, there is a box with statistics.
 
 getNbOfRecipients ($sql='')
 Return the number of distinct emails returned by your selector.
 
- Public Member Functions inherited from MailingTargets
 getDesc ()
 Return description of email selector.
 
 getNbOfRecords ()
 Return number of records for email selector.
 
 update_nb ($mailing_id)
 Met a jour nombre de destinataires.
 
 addTargetsToDatabase ($mailing_id, $cibles)
 Add a list of targets into the database.
 
 clear_target ($mailing_id)
 Supprime tous les destinataires de la table des cibles.
 

Additional Inherited Members

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

Detailed Description

mailing_mailinglist_mymodule

Definition at line 19 of file mailing_mymodule_selector1.modules.php.

Constructor & Destructor Documentation

◆ __construct()

mailing_mailing_mymodule_selector1::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from MailingTargets.

Definition at line 55 of file mailing_mymodule_selector1.modules.php.

Member Function Documentation

◆ add_to_target()

mailing_mailing_mymodule_selector1::add_to_target ( $mailing_id)

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

Parameters
int$mailing_idId of emailing
Returns
int<-1,max> Return integer <0 if error, number of emails added if ok

Definition at line 107 of file mailing_mymodule_selector1.modules.php.

References dol_syslog(), and GETPOST().

◆ formFilter()

mailing_mailing_mymodule_selector1::formFilter ( )

Display the filter form that appears in the mailing recipient selection page.

Returns
string Return select zone

Reimplemented from MailingTargets.

Definition at line 67 of file mailing_mymodule_selector1.modules.php.

◆ getNbOfRecipients()

mailing_mailing_mymodule_selector1::getNbOfRecipients ( $sql = '')

Return the 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$sqlNot used here
Returns
int<-1,max> Nb of recipients or -1 if KO

Reimplemented from MailingTargets.

Definition at line 195 of file mailing_mymodule_selector1.modules.php.

◆ getSqlArrayForStats()

mailing_mailing_mymodule_selector1::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
string[] Array with SQL requests

Reimplemented from MailingTargets.

Definition at line 176 of file mailing_mymodule_selector1.modules.php.

◆ url()

mailing_mailing_mymodule_selector1::url ( $id)

Return URL link to file of the source of the recipient of the mailing.

Parameters
int$idID
Returns
string Url link

Definition at line 94 of file mailing_mymodule_selector1.modules.php.

References $id, and img_object().


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