Class to manage a list of personalised recipients for mailing feature. More...
Inheritance diagram for mailing_thirdparties:
Collaboration diagram for mailing_thirdparties:
Public Member Functions | |
| __construct ($db) | |
| Constructor. More... | |
| add_to_target ($mailing_id, $filtersarray=array()) | |
| 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) | |
| Can include an URL link on each record provided by selector shown on target page. More... | |
| Public Member Functions inherited from MailingTargets | |
| __construct ($db) | |
| Constructor. More... | |
| getDesc () | |
| Return description of email selector. More... | |
| getNbOfRecords () | |
| Return number of records for email selector. More... | |
| getNbOfRecipients ($sql) | |
| Retourne nombre de destinataires. More... | |
| formFilter () | |
| Affiche formulaire de filtre qui apparait dans page de selection des destinataires de mailings. More... | |
| update_nb ($mailing_id) | |
| Met a jour nombre de destinataires. More... | |
| add_to_target ($mailing_id, $cibles) | |
| Ajoute destinataires dans table des cibles. More... | |
| clear_target ($mailing_id) | |
| Supprime tous les destinataires de la table des cibles. More... | |
Detailed Description
Class to manage a list of personalised recipients for mailing feature.
Definition at line 25 of file thirdparties.modules.php.
Constructor & Destructor Documentation
◆ __construct()
| mailing_thirdparties::__construct | ( | $db | ) |
Constructor.
Definition at line 46 of file thirdparties.modules.php.
Member Function Documentation
◆ add_to_target()
| mailing_thirdparties::add_to_target | ( | $mailing_id, | |
$filtersarray = array() |
|||
| ) |
This is the main function that returns the array of emails.
- Parameters
-
int $mailing_id Id of mailing. No need to use it. array $filtersarray If you used the formFilter function. Empty otherwise.
- Returns
- int <0 if error, number of emails added if ok
Definition at line 63 of file thirdparties.modules.php.
◆ formFilter()
| mailing_thirdparties::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
Definition at line 242 of file thirdparties.modules.php.
◆ getNbOfRecipients()
| mailing_thirdparties::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 $sql Requete sql de comptage
- Returns
- int Nb of recipients
Definition at line 222 of file thirdparties.modules.php.
◆ getSqlArrayForStats()
| mailing_thirdparties::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 204 of file thirdparties.modules.php.
◆ url()
| mailing_thirdparties::url | ( | $id | ) |
Can include an URL link on each record provided by selector shown on target page.
- Parameters
-
int $id ID
- Returns
- string Url link
Definition at line 323 of file thirdparties.modules.php.
The documentation for this class was generated from the following file:
- htdocs/core/modules/mailings/thirdparties.modules.php