mailing_fraise Class Reference

Class to generate targets according to the Fraise rule. More...

Inheritance diagram for mailing_fraise:

Collaboration diagram for mailing_fraise:

Public Member Functions
	__construct ($db)
	Constructor.
	getSqlArrayForStats ()
	In the main mailing area, there is a box with statistics.
	getNbOfRecipients ($sql='')
	Returns the number of distinct emails returned by your selector.
	formFilter ()
	Displays the filter form that appears on the mailing recipient selection page.
	url ($id)
	Provides the URL to the card of the source information of the recipient for the mailing.
	add_to_target ($mailing_id)
	Adds recipients to the targets 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)
	Update the number of recipients.
	addTargetsToDatabase ($mailing_id, $cibles)
	Add a list of targets into the database.
	clear_target ($mailing_id)
	Deletes all recipients from the targets table.

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

Detailed Description

Class to generate targets according to the Fraise rule.

Definition at line 35 of file fraise.modules.php.

Constructor & Destructor Documentation

__construct()

mailing_fraise::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from MailingTargets.

Definition at line 67 of file fraise.modules.php.

Member Function Documentation

add_to_target()

mailing_fraise::add_to_target

(

$mailing_id

)

Adds recipients to the targets table.

Parameters

int

$mailing_id

Id of emailing

Returns

int Returns integer < 0 if error, number added if successful

Reimplemented from MailingTargets.

Definition at line 243 of file fraise.modules.php.

References $conf, dol_mktime(), dol_now(), dol_print_date(), dol_syslog(), GETPOST(), GETPOSTINT(), and url().

formFilter()

mailing_fraise::formFilter

(

)

Displays the filter form that appears on the mailing recipient selection page.

Returns

string Returns the select area

Reimplemented from MailingTargets.

Definition at line 125 of file fraise.modules.php.

References $conf, ajax_combobox(), dol_print_error(), and dol_trunc().

getNbOfRecipients()

mailing_fraise::getNbOfRecipients

(

$sql = ''

)

Returns the 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

SQL query for counting

Returns

int|string Number of recipients, or <0 if error, or '' if N/A

Reimplemented from MailingTargets.

Definition at line 105 of file fraise.modules.php.

References $conf.

getSqlArrayForStats()

mailing_fraise::getSqlArrayForStats

(

)

In 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 requests that return two fields: One called "label", One called "nb".

Returns

string[] Array with SQL requests

Reimplemented from MailingTargets.

Definition at line 81 of file fraise.modules.php.

References getEntity().

url()

mailing_fraise::url

(

$id

)

Provides the URL to the card of the source information of the recipient for the mailing.

Parameters

int

$id

ID

Returns

string URL link

Definition at line 230 of file fraise.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/fraise.modules.php