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

Parent class of emailing target selectors modules. More...

+ Inheritance diagram for MailingTargets:

Public Member Functions

 __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

Parent class of emailing target selectors modules.

Definition at line 32 of file modules_mailings.php.

Constructor & Destructor Documentation

MailingTargets::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 44 of file modules_mailings.php.

Member Function Documentation

MailingTargets::add_to_target (   $mailing_id,
  $cibles 
)

Ajoute destinataires dans table des cibles.

Parameters
int$mailing_idId of emailing
array$ciblesArray with targets
Returns
int < 0 si erreur, nb ajout si ok

Definition at line 151 of file modules_mailings.php.

References dol_hash(), dol_syslog(), and update_nb().

MailingTargets::clear_target (   $mailing_id)

Supprime tous les destinataires de la table des cibles.

Parameters
int$mailing_idId of emailing
Returns
void

Definition at line 233 of file modules_mailings.php.

References dol_syslog(), and update_nb().

MailingTargets::formFilter ( )

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

Returns
string Retourne zone select

Definition at line 107 of file modules_mailings.php.

MailingTargets::getDesc ( )

Return description of email selector.

Returns
string Return translation of module label. Try translation of $this->name then translation of 'MailingModuleDesc'.$this->name, or $this->desc if not found

Definition at line 54 of file modules_mailings.php.

References $form.

MailingTargets::getNbOfRecipients (   $sql)

Retourne nombre de destinataires.

Parameters
string$sqlSql request to count
Returns
int Nb of recipient, or <0 if error

Definition at line 86 of file modules_mailings.php.

MailingTargets::getNbOfRecords ( )

Return number of records for email selector.

Returns
integer Example

Definition at line 75 of file modules_mailings.php.

MailingTargets::update_nb (   $mailing_id)

Met a jour nombre de destinataires.

Parameters
int$mailing_idId of emailing
Returns
int < 0 si erreur, nb destinataires si ok

Definition at line 118 of file modules_mailings.php.

References dol_syslog().

Referenced by add_to_target(), and clear_target().


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