ilTestMailNotification Class Reference

Class ilTestMailNotification. More...

Inheritance diagram for ilTestMailNotification:

Collaboration diagram for ilTestMailNotification:

Public Member Functions
	__construct ()
	sendSimpleNotification ($owner_id, $title, $usr_data)
	Send a simple notification to the owner of the test. More...
	sendAdvancedNotification ($owner_id, $title, $usr_data, $file_names)
	send an advanced notification to the owner of the test More...
Public Member Functions inherited from ilMailNotification
	__construct (protected bool $is_in_wsp=false)
	setType (int $a_type)
	getType ()
	setSender (int $a_usr_id)
	getSender ()
	setRecipients (array $a_rcp)
	getRecipients ()
	setAttachments (array $a_att)
	getAttachments ()
	setLangModules (array $a_modules)
	getUserLanguage (int $a_usr_id)
	setRefId (int $a_id)
	getRefId ()
	getObjId ()
	setObjId (int $a_obj_id)
	getObjType ()
	setAdditionalInformation (array $a_info)
	getAdditionalInformation ()
	sendMail (array $a_rcp, bool $a_parse_recipients=true)
	getBlockBorder ()

Additional Inherited Members
Data Fields inherited from ilMailNotification
final const int	SUBJECT_TITLE_LENGTH = 60
Protected Member Functions inherited from ilMailNotification
	setSubject (string $a_subject)
	getSubject ()
	setBody (string $a_body)
	appendBody (string $a_body)
	getBody ()
	initLanguage (int $a_usr_id)
	initLanguageByIso2Code (string $a_code='')
	setLanguage (ilLanguage $a_language)
	getLanguage ()
	getLanguageText (string $a_keyword)
	getObjectTitle (bool $a_shorten=false)
	initMail ()
	getMail ()
	createPermanentLink (array $a_params=[], string $a_append='')
	userToString (int $a_usr_id)
	isRefIdAccessible (int $a_user_id, int $a_ref_id, string $a_permission='read')
Protected Attributes inherited from ilMailNotification
int	$type
int	$sender
ilMail	$mail = null
string	$subject = ''
string	$body = ''
array	$attachments = []
ilLanguage	$language
array	$lang_modules = []
array	$recipients = []
int	$ref_id
int	$obj_id = 0
string	$obj_type = ''
array	$additional_info = []
ilWorkspaceTree	$wsp_tree
ilWorkspaceAccessHandler	$wsp_access_handler

Detailed Description

Class ilTestMailNotification.

Author

Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de

Version

$Id:$ \

Definition at line 28 of file class.ilTestMailNotification.php.

Constructor & Destructor Documentation

__construct()

ilTestMailNotification::__construct

(

)

Definition at line 30 of file class.ilTestMailNotification.php.

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

sendAdvancedNotification()

ilTestMailNotification::sendAdvancedNotification	(		$owner_id,
			$title,
			$usr_data,
			$file_names
	)

send an advanced notification to the owner of the test

Parameters

int	$owner_id
string	$title
string	$usr_data
array	$file_names

Definition at line 76 of file class.ilTestMailNotification.php.

References ilMailNotification\appendBody(), ilDatePresentation\formatDate(), ilMailNotification\getLanguage(), ilMailNotification\getMail(), ilMail\getSalutation(), IL_CAL_UNIX, ilMailNotification\initLanguage(), ilMailNotification\initMail(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilMailNotification\sendMail(), ilMailNotification\setAttachments(), ilMailNotification\setBody(), ilMailNotification\setSubject(), and ilDatePresentation\setUseRelativeDates().

    {
        $this->initLanguage($owner_id);
        $this->language->loadLanguageModule('assessment');

        $this->initMail();
        $this->setSubject(sprintf($this->language->txt('tst_user_finished_test'), $title));
        $this->setBody(ilMail::getSalutation($owner_id, $this->getLanguage()));
        $this->appendBody("\n\n");
        $this->appendBody($this->language->txt('user_has_finished_a_test'));
        $this->appendBody("\n\n");

        $this->appendBody($this->language->txt('title') . ': ' . $title);
        $this->appendBody("\n");
        $this->appendBody($this->language->txt('tst_participant') . ': ' . $usr_data);
        $this->appendBody("\n");

        ilDatePresentation::setUseRelativeDates(false);
        $this->appendBody($this->language->txt('tst_finished') . ': ' . ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX)));
        $this->appendBody("\n\n");

        $this->appendBody($this->language->txt('tst_attached_xls_file'));
        $this->appendBody("\n\n");

        $this->appendBody($this->language->txt('tst_notification_explanation_admin'));
        $this->appendBody("\n");

        $this->setAttachments($file_names);
        $this->getMail()->appendInstallationSignature(true);

        $this->sendMail([$owner_id]);
    }

Here is the call graph for this function:

sendSimpleNotification()

ilTestMailNotification::sendSimpleNotification	(		$owner_id,
			$title,
			$usr_data
	)

Send a simple notification to the owner of the test.

Parameters

int	$owner_id
string	$title
string	$usr_data

Definition at line 42 of file class.ilTestMailNotification.php.

References ilMailNotification\appendBody(), ilDatePresentation\formatDate(), ilMailNotification\getLanguage(), ilMailNotification\getMail(), ilMail\getSalutation(), IL_CAL_UNIX, ilMailNotification\initLanguage(), ilMailNotification\initMail(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilMailNotification\sendMail(), ilMailNotification\setBody(), ilMailNotification\setSubject(), and ilDatePresentation\setUseRelativeDates().

    {
        $this->initLanguage($owner_id);
        $this->language->loadLanguageModule('assessment');
        $this->initMail();
        $this->setSubject(sprintf($this->language->txt('tst_user_finished_test'), $title));
        $this->setBody(ilMail::getSalutation($owner_id, $this->getLanguage()));
        $this->appendBody("\n\n");
        $this->appendBody($this->language->txt('user_has_finished_a_test'));
        $this->appendBody("\n\n");

        $this->appendBody($this->language->txt('title') . ': ' . $title);
        $this->appendBody("\n");
        $this->appendBody($this->language->txt('tst_participant') . ': ' . $usr_data);
        $this->appendBody("\n");

        ilDatePresentation::setUseRelativeDates(false);
        $this->appendBody($this->language->txt('tst_finished') . ': ' . ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX)));
        $this->appendBody("\n\n");

        $this->appendBody($this->language->txt('tst_notification_explanation_admin'));
        $this->appendBody("\n");
        $this->getMail()->appendInstallationSignature(true);

        $this->sendMail([$owner_id]);
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Test/classes/class.ilTestMailNotification.php