mailing_xinputfile Class Reference

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

Inheritance diagram for mailing_xinputfile:

Collaboration diagram for mailing_xinputfile:

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)
	Provide the URL to the car of the source information of the recipient for the mailing.
	formFilter ()
	Display filter form shown on the mailing recipient selection page.
	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)
	Update the number of recipients.
	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 with Rule 'xinputfile'.

Definition at line 33 of file xinputfile.modules.php.

Constructor & Destructor Documentation

__construct()

mailing_xinputfile::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from MailingTargets.

Definition at line 61 of file xinputfile.modules.php.

Member Function Documentation

add_to_target()

mailing_xinputfile::add_to_target

(

$mailing_id

)

Ajoute destinataires dans table des cibles.

Parameters

int

$mailing_id

Id of emailing

Returns

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

Reimplemented from MailingTargets.

Definition at line 139 of file xinputfile.modules.php.

References $conf, dol_mkdir(), dol_move_uploaded_file(), dol_string_nohtmltag(), dol_syslog(), and isValidEmail().

formFilter()

mailing_xinputfile::formFilter

(

)

Display filter form shown on the mailing recipient selection page.

Returns

string HTML select zone

Reimplemented from MailingTargets.

Definition at line 118 of file xinputfile.modules.php.

References getMaxFileSizeArray().

getNbOfRecipients()

mailing_xinputfile::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 93 of file xinputfile.modules.php.

getSqlArrayForStats()

mailing_xinputfile::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 75 of file xinputfile.modules.php.

url()

mailing_xinputfile::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 105 of file xinputfile.modules.php.

References $id.

---

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

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