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.
	getSqlArrayForStats ()
	On the main mailing area, there is a box with statistics.
	getNbOfRecipients ($sql='')
	Return here number of distinct emails returned by your selector.
	formFilter ()
	Affiche formulaire de filtre qui apparait dans page de selection des destinataires de mailings.
	url ($id)
	Provide the URL to the car of the source information of the recipient for the mailing.
	add_to_target ($mailing_id)
	Add some recipients into target table.
Public Member Functions inherited from MailingTargets
	getDesc ()
	Return description of email selector.
	getNbOfRecords ()
	Return number of records for email selector.
	update_nb ($mailing_id)
	Met a jour nombre de destinataires.
	addTargetsToDatabase ($mailing_id, $cibles)
	Add a list of targets into the database.
	clear_target ($mailing_id)
	Supprime tous les destinataires de la table des cibles.

Additional Inherited Members
Static Public Member Functions inherited from MailingTargets
static	getEmailingSelectorsList ($forcedir=null)
	Return list of widget.

Detailed Description

Class to offer a selector of emailing targets from contacts.

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

Constructor & Destructor Documentation

__construct()

mailing_contacts1::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from MailingTargets.

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

Member Function Documentation

add_to_target()

mailing_contacts1::add_to_target

(

$mailing_id

)

Add some recipients into target table.

Parameters

int

$mailing_id

Id of emailing

Returns

int Return integer <0 si erreur, nb ajout si ok

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

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

formFilter()

mailing_contacts1::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 120 of file contacts1.modules.php.

References ajax_combobox(), dol_escape_htmltag(), dol_print_error(), getDolGlobalInt(), GETPOST(), and img_picto().

getNbOfRecipients()

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

$sql

Requete sql de comptage

Returns

int|string Nb of recipient, or <0 if error, or '' if NA

Reimplemented from MailingTargets.

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

getSqlArrayForStats()

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

Reimplemented from MailingTargets.

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

url()

mailing_contacts1::url

(

$id

)

Provide the URL to the car of the source information of the recipient for the mailing.

Parameters

int

$id

ID

Returns

string URL link

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

References $id, and img_object().

Referenced by add_to_target().

---

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

• dolibarr_dev/htdocs/core/modules/mailings/contacts1.modules.php