dolibarr  7.0.0-beta
Public Member Functions | List of all members
mailing_contacts1 Class Reference

Class to offer a selector of emailing targets from contacts. More...

+ Inheritance diagram for mailing_contacts1:
+ Collaboration diagram for mailing_contacts1:

Public Member Functions

 __construct ($db)
 Constructor. 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 ()
 Affiche formulaire de filtre qui apparait dans page de selection des destinataires de mailings. More...
 
 url ($id)
 Renvoie url lien vers fiche de la source du destinataire du mailing. More...
 
 add_to_target ($mailing_id, $filtersarray=array())
 Ajoute destinataires dans table des cibles. 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 offer a selector of emailing targets from contacts.

Definition at line 33 of file contacts1.modules.php.

Constructor & Destructor Documentation

mailing_contacts1::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

mailing_contacts1::add_to_target (   $mailing_id,
  $filtersarray = array() 
)

Ajoute destinataires dans table des cibles.

Parameters
int$mailing_idId of emailing
array$filtersarrayOptional filter data (deprecated)
Returns
int <0 si erreur, nb ajout si ok

Definition at line 334 of file contacts1.modules.php.

References $resql, dol_print_error(), dol_syslog(), GETPOST(), and url().

mailing_contacts1::formFilter ( )

Affiche formulaire de filtre qui apparait dans page de selection des destinataires de mailings.

Returns
string Retourne zone select

Definition at line 113 of file contacts1.modules.php.

References $resql, dol_escape_htmltag(), and dol_print_error().

mailing_contacts1::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

Definition at line 91 of file contacts1.modules.php.

mailing_contacts1::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

Definition at line 64 of file contacts1.modules.php.

mailing_contacts1::url (   $id)

Renvoie url lien vers fiche de la source du destinataire du mailing.

Parameters
int$idID
Returns
string Url lien

Definition at line 321 of file contacts1.modules.php.

References img_object().

Referenced by add_to_target().


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