ilTestManScoringParticipantNotification Class Reference

Inheritance diagram for ilTestManScoringParticipantNotification:

Collaboration diagram for ilTestManScoringParticipantNotification:

Public Member Functions
	__construct ($userId, $testRefId)
	send ()
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 ()

Private Member Functions
	buildSubject ()
	buildBody ()
	setRecipient ($userId)
	getRecipient ()
	convertFeedbackForMail ($feedback)

Additional Inherited Members
Data Fields inherited from ilMailNotification
final const	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

Definition at line 21 of file class.ilTestManScoringParticipantNotification.php.

Constructor & Destructor Documentation

__construct()

ilTestManScoringParticipantNotification::__construct	(		$userId,
			$testRefId
	)

Definition at line 23 of file class.ilTestManScoringParticipantNotification.php.

References ILIAS\GlobalScreen\Provider\__construct(), ilMailNotification\getLanguage(), getRecipient(), ilMailNotification\initLanguage(), ilMailNotification\initMail(), setRecipient(), and ilMailNotification\setRefId().

    {
        parent::__construct();

        $this->setRecipient($userId);
        $this->setRefId($testRefId);

        $this->initLanguage($this->getRecipient());
        $this->getLanguage()->loadLanguageModule('assessment');

        $this->initMail();
    }

Here is the call graph for this function:

Member Function Documentation

buildBody()

ilTestManScoringParticipantNotification::buildBody ( )

private

Definition at line 54 of file class.ilTestManScoringParticipantNotification.php.

References ilMailNotification\appendBody(), convertFeedbackForMail(), ilMailNotification\getAdditionalInformation(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), getRecipient(), ilMail\getSalutation(), and ilMailNotification\setBody().

Referenced by send().

                                : void
    {
        //      Salutation

        $this->setBody(
            ilMail::getSalutation($this->getRecipient(), $this->getLanguage())
        );
        $this->appendBody("\n\n");

        //      Message (What has happened?)

        $this->appendBody($this->getLanguageText('tst_notify_manscoring_done_body_msg_topic'));
        $this->appendBody("\n\n");

        $info = $this->getAdditionalInformation();

        $this->appendBody($this->getLanguageText('obj_tst') . ': ' . $info['test_title']);
        $this->appendBody("\n");
        $this->appendBody($this->getLanguageText('pass') . ': ' . $info['test_pass']);
        $this->appendBody("\n\n");

        foreach ($info['questions_gui_list'] as $questionId => $questionGui) {
            $points = $info['questions_scoring_data'][$questionId]['points'];
            $feedback = $info['questions_scoring_data'][$questionId]['feedback'];

            $feedback = $this->convertFeedbackForMail($feedback);

            $this->appendBody($this->getLanguageText('tst_question') . ': ' . $questionGui->getObject()->getTitleForHTMLOutput());
            $this->appendBody("\n");
            $this->appendBody($this->getLanguageText('tst_reached_points') . ': ' . $points);
            $this->appendBody("\n");
            $this->appendBody($this->getLanguageText('set_manual_feedback') . ":\n" . $feedback);
            $this->appendBody("\n\n");
        }

        //      Task (What do I have to do?

        /* NOTHING REQUIRED FOR PARTICIPANT */

        //      Explanation (Why do I receive the following message?)

        $this->appendBody("\n");
        $this->appendBody($this->getLanguageText('tst_notify_manscoring_done_body_msg_reason'));

        //      Signature

        $this->getMail()->appendInstallationSignature(true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildSubject()

ilTestManScoringParticipantNotification::buildSubject ( )

private

Definition at line 47 of file class.ilTestManScoringParticipantNotification.php.

References ilMailNotification\getAdditionalInformation(), ilMailNotification\getLanguageText(), and ilMailNotification\setSubject().

Referenced by send().

                                   : void
    {
        $info = $this->getAdditionalInformation();

        $this->setSubject(sprintf($this->getLanguageText('tst_notify_manscoring_done_body_msg_subject'), $info['test_title']));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

convertFeedbackForMail()

ilTestManScoringParticipantNotification::convertFeedbackForMail (   $feedback )

private

Definition at line 113 of file class.ilTestManScoringParticipantNotification.php.

Referenced by buildBody().

                                                      : ?string
    {
        if (strip_tags($feedback) != $feedback) {
            $feedback = preg_replace('/<br(.*\/)>/m', "\n", $feedback);
            $feedback = strip_tags($feedback);
        }

        return $feedback;
    }

Here is the caller graph for this function:

getRecipient()

ilTestManScoringParticipantNotification::getRecipient ( )

private

Definition at line 108 of file class.ilTestManScoringParticipantNotification.php.

References ilMailNotification\getRecipients().

Referenced by __construct(), and buildBody().

    {
        return current($this->getRecipients());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilTestManScoringParticipantNotification::send

(

)

Definition at line 36 of file class.ilTestManScoringParticipantNotification.php.

References buildBody(), buildSubject(), ilMailNotification\getRecipients(), and ilMailNotification\sendMail().

                          : void
    {
        $this->buildSubject();

        $this->buildBody();

        $this->sendMail(
            $this->getRecipients()
        );
    }

Here is the call graph for this function:

setRecipient()

ilTestManScoringParticipantNotification::setRecipient (   $userId )

private

Definition at line 103 of file class.ilTestManScoringParticipantNotification.php.

References ilMailNotification\setRecipients().

Referenced by __construct().

                                          : void
    {
        $this->setRecipients([$userId]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Test/classes/Notifications/class.ilTestManScoringParticipantNotification.php