mailing_partnership Class Reference

Class to manage a list of personalised recipients for mailing feature. More...

Inheritance diagram for mailing_partnership:

Collaboration diagram for mailing_partnership:

Public Member Functions
	__construct ($db)
	Constructor.
	add_to_target ($mailing_id)
	This is the main function that returns the array of emails.
	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 ()
	This is to add a form filter to provide variant of selector If used, the HTML select must be called "filter".
	url ($id, $sourcetype='thirdparty')
	Can include an URL link on each record provided by selector shown on target page.
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.

Detailed Description

Class to manage a list of personalised recipients for mailing feature.

Definition at line 27 of file partnership.modules.php.

Constructor & Destructor Documentation

__construct()

mailing_partnership::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from MailingTargets.

Definition at line 50 of file partnership.modules.php.

Member Function Documentation

add_to_target()

mailing_partnership::add_to_target

(

$mailing_id

)

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

Parameters

int

$mailing_id

Id of mailing. No need to use it.

Returns

int Return integer <0 if error, number of emails added if ok

Definition at line 66 of file partnership.modules.php.

References dol_syslog(), GETPOST(), and GETPOSTINT().

formFilter()

mailing_partnership::formFilter

(

)

This is to add a form filter to provide variant of selector If used, the HTML select must be called "filter".

Returns

string A html select zone

Reimplemented from MailingTargets.

Definition at line 216 of file partnership.modules.php.

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

getNbOfRecipients()

mailing_partnership::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 182 of file partnership.modules.php.

getSqlArrayForStats()

mailing_partnership::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 164 of file partnership.modules.php.

url()

mailing_partnership::url	(		$id,
			$sourcetype = 'thirdparty' )

Can include an URL link on each record provided by selector shown on target page.

Parameters

int	$id	ID
string	$sourcetype	Source type

Returns

string Url link

Definition at line 277 of file partnership.modules.php.

References img_object().

---

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

• dolibarr_19.0/htdocs/core/modules/mailings/partnership.modules.php