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.
	formFilter ()
	Displays the filter form that appears in the mailing recipient selection page.
	url ($id)
	Returns url link to file of the source of the recipient of the mailing.
	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.
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

mailing_mailinglist_mymodule

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

Constructor & Destructor Documentation

__construct()

mailing_mailinglist_mymodule_myobject::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from MailingTargets.

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

Member Function Documentation

add_to_target()

mailing_mailinglist_mymodule_myobject::add_to_target

(

$mailing_id

)

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

Parameters

int

$mailing_id

Id of emailing

Returns

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

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

References dol_syslog(), and GETPOST().

formFilter()

mailing_mailinglist_mymodule_myobject::formFilter

(

)

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

Returns

string Return select zone

Reimplemented from MailingTargets.

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

getNbOfRecipients()

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

Not use here

Returns

int Nb of recipients or -1 if KO

Reimplemented from MailingTargets.

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

getSqlArrayForStats()

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 170 of file mailinglist_mymodule_myobject.modules.php.

url()

mailing_mailinglist_mymodule_myobject::url

(

$id

)

Returns url link to file of the source of the recipient of the mailing.

Parameters

int

$id

ID

Returns

string Url lien

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

References img_object().

---

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

• dolibarr_19.0/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php