InterfaceTicketEmail Class Reference

Class of triggers for ticket module. More...

Inheritance diagram for InterfaceTicketEmail:

Collaboration diagram for InterfaceTicketEmail:

Public Member Functions
	__construct ($db)
	Constructor.
	runTrigger ($action, $object, User $user, Translate $langs, Conf $conf)
	Function called when a Dolibarr business event is done.
Public Member Functions inherited from DolibarrTriggers
	__construct (DoliDB $db)
	Constructor.
	getName ()
	Returns the name of the trigger file.
	getDesc ()
	Returns the description of trigger file.
	getVersion ()
	Returns the version of the trigger file.
	setErrorsFromObject (CommonObject $object)
	setErrorsFromObject

Private Member Functions
	composeAndSendAdminMessage ($sendto, $base_subject, $body, Ticket $object, Translate $langs)
	Composes and sends a message concerning a ticket, to be sent to admin address.
	composeAndSendCustomerMessage ($sendto, $base_subject, $body, $see_ticket, Ticket $object, Translate $langs)
	Composes and sends a message concerning a ticket, to be sent to customer addresses.
	composeAndSendAssigneeMessage ($sendto, $base_subject, $body, $see_ticket, Ticket $object, Translate $langs)
	Composes and sends a message concerning a ticket, to be sent to user assigned to the ticket.

Detailed Description

Class of triggers for ticket module.

Definition at line 33 of file interface_50_modTicket_TicketEmail.class.php.

Constructor & Destructor Documentation

__construct()

InterfaceTicketEmail::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 40 of file interface_50_modTicket_TicketEmail.class.php.

References description, and name.

Member Function Documentation

composeAndSendAdminMessage()

InterfaceTicketEmail::composeAndSendAdminMessage ( $sendto, $base_subject, $body, Ticket $object, Translate $langs )

private

Composes and sends a message concerning a ticket, to be sent to admin address.

Parameters

string	$sendto	Addresses to send the mail, format "first@address.net, second@address.net," etc.
string	$base_subject	email subject. Non-translated string.
string	$body	email body (first line). Non-translated string.
Ticket	$object	the ticket thet the email refers to
Translate	$langs	the translation object

Returns

void

Definition at line 321 of file interface_50_modTicket_TicketEmail.class.php.

References $conf, $object, dol_nl2br(), dol_syslog(), dol_textishtml(), and getDolGlobalString().

Referenced by runTrigger().

composeAndSendAssigneeMessage()

InterfaceTicketEmail::composeAndSendAssigneeMessage ( $sendto, $base_subject, $body, $see_ticket, Ticket $object, Translate $langs )

private

Composes and sends a message concerning a ticket, to be sent to user assigned to the ticket.

Parameters

string	$sendto	Addresses to send the mail, format "first@address.net, second@address.net, " etc.
string	$base_subject	email subject. Non-translated string.
string	$body	email body (first line). Non-translated string.
string	$see_ticket	string indicating the ticket public address
Ticket	$object	the ticket thet the email refers to
Translate	$langs	the translation object

Returns

void

Definition at line 490 of file interface_50_modTicket_TicketEmail.class.php.

References $conf, $object, dol_nl2br(), dol_now(), dolGetFirstLastname(), getDolGlobalString(), getDolUserString(), and setEventMessages().

Referenced by runTrigger().

composeAndSendCustomerMessage()

InterfaceTicketEmail::composeAndSendCustomerMessage ( $sendto, $base_subject, $body, $see_ticket, Ticket $object, Translate $langs )

private

Composes and sends a message concerning a ticket, to be sent to customer addresses.

Parameters

string	$sendto	Addresses to send the mail, format "first@address.net, second@address.net, " etc.
string	$base_subject	email subject. Non-translated string.
string	$body	email body (first line). Non-translated string.
string	$see_ticket	string indicating the ticket public address
Ticket	$object	the ticket thet the email refers to
Translate	$langs	the translation object

Returns

void

Definition at line 394 of file interface_50_modTicket_TicketEmail.class.php.

References $conf, $object, dol_buildpath(), dol_eval(), dol_nl2br(), dol_now(), dol_syslog(), dol_textishtml(), and getDolGlobalString().

Referenced by runTrigger().

runTrigger()

InterfaceTicketEmail::runTrigger	(		$action,
			$object,
		User	$user,
		Translate	$langs,
		Conf	$conf )

Function called when a Dolibarr business event is done.

All functions "runTrigger" are triggered if file is inside directory htdocs/core/triggers

Parameters

string	$action	Event action code
Ticket	$object	Object
User	$user	Object user
Translate	$langs	Object langs
conf	$conf	Object conf

Returns

int Return integer <0 if KO, 0 if no triggered ran, >0 if OK

Reimplemented from DolibarrTriggers.

Definition at line 62 of file interface_50_modTicket_TicketEmail.class.php.

References $conf, $object, composeAndSendAdminMessage(), composeAndSendAssigneeMessage(), composeAndSendCustomerMessage(), dol_syslog(), getDolGlobalString(), getDolUserString(), GETPOST(), name, and setEventMessages().

---

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

• dolibarr_dev/htdocs/core/triggers/interface_50_modTicket_TicketEmail.class.php