dolibarr  21.0.0-alpha
Public Member Functions | List of all members
mailing_mailing_mymodule_selector1 Class Reference

mailing_mailinglist_mymodule More...

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

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 formFilter ()
 Displays the filter form that appears in the mailing recipient selection page. More...
 
 url ($id)
 Returns url link to file of the source of the recipient of the mailing. 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...
 
- 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

mailing_mailinglist_mymodule

Definition at line 18 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 47 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 Return integer <0 if error, number of emails added if ok

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

◆ formFilter()

mailing_mailing_mymodule_selector1::formFilter ( )

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

Returns
string Return select zone

Reimplemented from MailingTargets.

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

◆ getNbOfRecipients()

mailing_mailing_mymodule_selector1::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$sqlNot use here
Returns
int Nb of recipients or -1 if KO

Reimplemented from MailingTargets.

Definition at line 187 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
array

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

◆ url()

mailing_mailing_mymodule_selector1::url (   $id)

Returns url link to file of the source of the recipient of the mailing.

Parameters
int$idID
Returns
string Url lien

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


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