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

Class to offer a selector of emailing targets with Rule 'xinputuser'. More...

+ Inheritance diagram for mailing_xinputuser:
+ Collaboration diagram for mailing_xinputuser:

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...
 
 url ($id)
 Renvoie url lien vers fiche de la source du destinataire du mailing. More...
 
 formFilter ()
 Affiche formulaire de filtre qui apparait dans page de selection des destinataires de mailings. 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 with Rule 'xinputuser'.

Definition at line 31 of file xinputuser.modules.php.

Constructor & Destructor Documentation

mailing_xinputuser::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 47 of file xinputuser.modules.php.

Member Function Documentation

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

Ajoute destinataires dans table des cibles.

Parameters
int$mailing_idId of emailing
array$filtersarrayRequete sql de selection des destinataires
Returns
int < 0 si erreur, nb ajout si ok

Definition at line 118 of file xinputuser.modules.php.

References GETPOST().

mailing_xinputuser::formFilter ( )

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

Returns
string Retourne zone select

Definition at line 102 of file xinputuser.modules.php.

mailing_xinputuser::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$sqlSql request to count
Returns
string '' means NA

Definition at line 79 of file xinputuser.modules.php.

mailing_xinputuser::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 61 of file xinputuser.modules.php.

mailing_xinputuser::url (   $id)

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

Parameters
int$idID
Returns
string Url lien

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


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