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

mailing_mailinglist_mymodule More...

+ Inheritance diagram for mailing_mailinglist_mymodule_myobject:
+ Collaboration diagram for mailing_mailinglist_mymodule_myobject:

Public Member Functions

 __construct ($db)
 Constructor. 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())
 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 ($filter=1, $option='')
 Return here number of distinct emails returned by your selector. 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

mailing_mailinglist_mymodule

Definition at line 18 of file mailinglist_mymodule_myobject.modules.php.

Constructor & Destructor Documentation

mailing_mailinglist_mymodule_myobject::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 38 of file mailinglist_mymodule_myobject.modules.php.

Member Function Documentation

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

This is the main function that returns the array of emails.

Parameters
int$mailing_idId of emailing
array$filtersarrayRequete sql de selection des destinataires
Returns
int <0 if error, number of emails added if ok

Definition at line 98 of file mailinglist_mymodule_myobject.modules.php.

References dol_syslog().

mailing_mailinglist_mymodule_myobject::formFilter ( )

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

Returns
string Retourne zone select

Definition at line 55 of file mailinglist_mymodule_myobject.modules.php.

References $form.

mailing_mailinglist_mymodule_myobject::getNbOfRecipients (   $filter = 1,
  $option = '' 
)

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$filterFilter
string$optionOptions
Returns
int Nb of recipients or -1 if KO

Definition at line 191 of file mailinglist_mymodule_myobject.modules.php.

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

Definition at line 171 of file mailinglist_mymodule_myobject.modules.php.

mailing_mailinglist_mymodule_myobject::url (   $id)

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

Parameters
int$idID
Returns
string Url lien

Definition at line 85 of file mailinglist_mymodule_myobject.modules.php.

References img_object().


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