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

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

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

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)
 Ajoute destinataires dans table des cibles. 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

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

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

Constructor & Destructor Documentation

◆ __construct()

mailing_xinputfile::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from MailingTargets.

Definition at line 51 of file xinputfile.modules.php.

Member Function Documentation

◆ add_to_target()

mailing_xinputfile::add_to_target (   $mailing_id)

Ajoute destinataires dans table des cibles.

Parameters
int$mailing_idId of emailing
Returns
int Return integer < 0 si erreur, nb ajout si ok

Definition at line 129 of file xinputfile.modules.php.

◆ formFilter()

mailing_xinputfile::formFilter ( )

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

Returns
string Retourne zone select

Reimplemented from MailingTargets.

Definition at line 108 of file xinputfile.modules.php.

◆ getNbOfRecipients()

mailing_xinputfile::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
int|string Nb of recipient, or <0 if error, or '' if NA

Reimplemented from MailingTargets.

Definition at line 83 of file xinputfile.modules.php.

◆ getSqlArrayForStats()

mailing_xinputfile::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 65 of file xinputfile.modules.php.

◆ url()

mailing_xinputfile::url (   $id)

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

Parameters
int$idID
Returns
string Url lien

Definition at line 95 of file xinputfile.modules.php.


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