mailing_xinputuser Class Reference

Class to offer a selector of emailing targets with Rule 'xinputuser'. More...

Inheritance diagram for mailing_xinputuser:

Collaboration diagram for mailing_xinputuser:

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.
	url ($id)
	Renvoie url lien vers fiche de la source du destinataire du mailing.
	formFilter ()
	Affiche formulaire de filtre qui apparait dans page de selection des destinataires de mailings.
	add_to_target ($mailing_id)
	Ajoute destinataires dans table des cibles.
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 offer a selector of emailing targets with Rule 'xinputuser'.

Definition at line 31 of file xinputuser.modules.php.

Constructor & Destructor Documentation

__construct()

mailing_xinputuser::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from MailingTargets.

Definition at line 51 of file xinputuser.modules.php.

Member Function Documentation

add_to_target()

mailing_xinputuser::add_to_target

(

$mailing_id

)

Ajoute destinataires dans table des cibles.

Parameters

int

$mailing_id

Id of emailing

Returns

int < 0 si erreur, nb ajout si ok

Definition at line 122 of file xinputuser.modules.php.

References GETPOST().

formFilter()

mailing_xinputuser::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 106 of file xinputuser.modules.php.

getNbOfRecipients()

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

Sql request to count

Returns

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

Reimplemented from MailingTargets.

Definition at line 83 of file xinputuser.modules.php.

getSqlArrayForStats()

mailing_xinputuser::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 65 of file xinputuser.modules.php.

url()

mailing_xinputuser::url

(

$id

)

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

Parameters

int

$id

ID

Returns

string Url lien

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

---

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

• dolibarr_18.0/htdocs/core/modules/mailings/xinputuser.modules.php