This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilExerciseMailNotification:

Collaboration diagram for ilExerciseMailNotification:

Public Member Functions
	__construct ()

	setAssignmentId (int $a_val)

	getAssignmentId ()

	setPeerId (int $a_val)

	getPeerId ()

	setAdditionalText (string $a_val)

	getAdditionalText ()

	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 ()

Data Fields
const	TYPE_FEEDBACK_FILE_ADDED = 20

const	TYPE_SUBMISSION_UPLOAD = 30

const	TYPE_FEEDBACK_TEXT_ADDED = 40

const	TYPE_GRADING_DONE = 70

const	TYPE_MESSAGE_FROM_PF_GIVER = 50

const	TYPE_MESSAGE_FROM_PF_RECIPIENT = 60

const	TYPE_DEADLINE_REQUESTED = 70

const	TYPE_IDL_DEADLINE_SET = 80

Data Fields inherited from ilMailNotification
final const int	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	addOpenSubmission ()

	sendExerciseNotification (int $rcp, string $subject, string $text, string $link="")

	initLanguage (int $a_usr_id)
	Add language module exc. More...

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
ILIAS Exercise InternalDomainService	$domain

string	$additional_text = ""

int	$peer_id = 0

ILIAS Exercise PermanentLink PermanentLinkManager	$permanent_link

ilObjUser	$user

int	$ass_id

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 22 of file class.ilExerciseMailNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilExerciseMailNotification::__construct ( )

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

    {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->domain = $DIC->exercise()->internal()->domain();
        $this->permanent_link = $DIC->exercise()->internal()->gui()->permanentLink();
        parent::__construct();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addOpenSubmission()

ilExerciseMailNotification::addOpenSubmission ( )

protected

Definition at line 60 of file class.ilExerciseMailNotification.php.

                                          : void
    {
        $ass = new ilExAssignment($this->getAssignmentId());
        $types = ilExAssignmentTypes::getInstance();
        $type = $types->getById($ass->getType());
        if ($type->supportsWebDirAccess()) {
            $submission = new ilExSubmission($ass, $this->user->getId());
            if ($submission->hasSubmittedPrintVersion()) {
                $this->appendBody("\n\n");
                $this->appendBody(sprintf(
                    $this->getLanguageText('exc_submission_open_notification_link'),
                    $this->permanent_link->getOpenSubmissionsLink($this->ref_id, $this->getAssignmentId(), $this->user->getId())
                ));
            }
        }
    }

References ilMailNotification\$type, ilMailNotification\appendBody(), getAssignmentId(), ilExAssignmentTypes\getInstance(), ilMailNotification\getLanguageText(), and ILIAS\Repository\user().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalText()

ilExerciseMailNotification::getAdditionalText ( )

Definition at line 92 of file class.ilExerciseMailNotification.php.

                                       : string
    {
        return $this->additional_text;
    }

References $additional_text.

Referenced by send().

Here is the caller graph for this function:

◆ getAssignmentId()

ilExerciseMailNotification::getAssignmentId ( )

Definition at line 55 of file class.ilExerciseMailNotification.php.

                                     : int
    {
        return $this->ass_id;
    }

References $ass_id.

Referenced by addOpenSubmission(), and send().

Here is the caller graph for this function:

◆ getPeerId()

ilExerciseMailNotification::getPeerId ( )

Definition at line 82 of file class.ilExerciseMailNotification.php.

                               : int
    {
        return $this->peer_id;
    }

References $peer_id.

◆ initLanguage()

ilExerciseMailNotification::initLanguage ( int $a_usr_id )

protected

Add language module exc.

Reimplemented from ilMailNotification.

Definition at line 380 of file class.ilExerciseMailNotification.php.

                                                  : void
    {
        parent::initLanguage($a_usr_id);
        $this->getLanguage()->loadLanguageModule('exc');
    }

References getLanguage().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send()

ilExerciseMailNotification::send ( )

Definition at line 97 of file class.ilExerciseMailNotification.php.

                          : bool
    {
        $ilUser = $this->user;
        $perma = $this->permanent_link;
        // parent::send();
 
        switch ($this->getType()) {
            case self::TYPE_FEEDBACK_FILE_ADDED:
 
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf(
                            $this->getLanguageText('exc_msg_new_feedback_file_uploaded'),
                            $this->getObjectTitle(true)
                        )
                    );
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        $this->getLanguageText('exc_msg_new_feedback_file_uploaded2')
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('obj_exc') . ": " . $this->getObjectTitle(true)
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('exc_assignment') . ": " .
                        ilExAssignment::lookupTitle($this->getAssignmentId())
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody($this->getLanguageText('exc_mail_permanent_link'));
                    $this->appendBody("\n");
                    $this->appendBody($this->permanent_link->getPermanentLink($this->ref_id, $this->getAssignmentId()));
                    $this->getMail()->appendInstallationSignature(true);
 
                    $this->sendMail(array($rcp));
                }
                break;
 
            case self::TYPE_SUBMISSION_UPLOAD:
 
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf(
                            $this->getLanguageText('exc_submission_notification_subject'),
                            $this->getObjectTitle(true)
                        )
                    );
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        sprintf($this->getLanguageText('exc_submission_notification_body'), $this->getObjectTitle(true))
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('exc_assignment') . ": " .
                        ilExAssignment::lookupTitle($this->getAssignmentId())
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('user') . ": " .
                        $ilUser->getFullname()
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody(sprintf(
                        $this->getLanguageText('exc_submission_notification_link'),
                        $this->permanent_link->getPermanentLink($this->ref_id, $this->getAssignmentId())
                    ));
 
                    if (ilExAssignment::lookupType($this->getAssignmentId()) == ilExAssignment::TYPE_UPLOAD) {
                        $this->appendBody("\n\n");
 
                        //new files uploaded
                        //$assignment = new ilExAssignment($this->getAssignmentId());
                        //$submission = new ilExSubmission($assignment, $ilUser->getId());
 
                        // since mails are sent immediately after upload the files should always be new
                        //if($submission->lookupNewFiles($submission->getTutor()))
                        //{
                        $this->appendBody(sprintf(
                            $this->getLanguageText('exc_submission_downloads_notification_link'),
                            $this->permanent_link->getDownloadSubmissionLink($this->ref_id, $this->getAssignmentId(), $ilUser->getId())
                        ));
                        //}
                        //else
                        //{
                        //      $this->appendBody(sprintf($this->getLanguageText('exc_submission_downloads_notification_link'),
                        //              $this->getLanguageText("exc_submission_no_new_files")));
                        //}
                    }
                    $this->addOpenSubmission();
 
                    $this->appendBody("\n\n");
                    $this->appendBody(sprintf(
                        $this->getLanguageText('exc_submission_and_grades_notification_link'),
                        $this->permanent_link->getGradesLink($this->ref_id, $this->getAssignmentId())
                    ));
 
                    $this->getMail()->appendInstallationSignature(true);
 
                    $this->sendMail(array($rcp));
                }
                break;
 
            case self::TYPE_FEEDBACK_TEXT_ADDED:
 
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf(
                            $this->getLanguageText('exc_msg_new_feedback_text_uploaded'),
                            $this->getObjectTitle(true)
                        )
                    );
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        $this->getLanguageText('exc_msg_new_feedback_text_uploaded2')
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('obj_exc') . ": " . $this->getObjectTitle(true)
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('exc_assignment') . ": " .
                        ilExAssignment::lookupTitle($this->getAssignmentId())
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody($this->getLanguageText('exc_mail_permanent_link'));
                    $this->appendBody("\n");
                    $this->appendBody($this->permanent_link->getPermanentLink($this->ref_id, $this->getAssignmentId()));
                    $this->getMail()->appendInstallationSignature(true);
 
                    $this->sendMail(array($rcp));
                }
                break;
 
            case self::TYPE_GRADING_DONE:
 
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->initMail();
                    $this->setSubject(
                        sprintf(
                            $this->getLanguageText('exc_msg_grading_done'),
                            $this->getObjectTitle(true)
                        )
                    );
                    $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
                    $this->appendBody("\n\n");
                    $this->appendBody(
                        sprintf(
                            $this->getLanguageText('exc_msg_grading_done_body'),
                            $this->getObjectTitle(false)
                        )
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('obj_exc') . ": " . $this->getObjectTitle(true)
                    );
                    $this->appendBody("\n");
                    $this->appendBody(
                        $this->getLanguageText('exc_assignment') . ": " .
                        ilExAssignment::lookupTitle($this->getAssignmentId())
                    );
                    $this->appendBody("\n\n");
                    $this->appendBody($this->getLanguageText('exc_mail_permanent_link'));
                    $this->appendBody("\n");
                    $this->appendBody($this->permanent_link->getPermanentLink($this->ref_id, $this->getAssignmentId()));
                    $this->getMail()->appendInstallationSignature(true);
 
                    $this->sendMail(array($rcp));
                }
                break;
 
            case self::TYPE_MESSAGE_FROM_PF_GIVER:
 
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->sendExerciseNotification(
                        $rcp,
                        sprintf(
                            $this->getLanguageText('exc_msg_new_message_from_pf_giver'),
                            $this->getObjectTitle(true)
                        ),
                        $this->getLanguageText('exc_msg_new_message_from_pf_giver2') .
                        "\n\n" . $this->getAdditionalText(),
                        $perma->getReceivedFeedbackLink($this->ref_id, $this->getAssignmentId())
                    );
                }
                break;
 
            case self::TYPE_MESSAGE_FROM_PF_RECIPIENT:
 
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->sendExerciseNotification(
                        $rcp,
                        sprintf(
                            $this->getLanguageText('exc_msg_new_message_from_pf_recipient'),
                            $this->getObjectTitle(true)
                        ),
                        $this->getLanguageText('exc_msg_new_message_from_pf_recipient2') .
                        "\n\n" . $this->getAdditionalText(),
                        $perma->getGivenFeedbackLink($this->ref_id, $this->getAssignmentId(), $this->getPeerId())
                    );
                }
                break;
 
            case self::TYPE_DEADLINE_REQUESTED:
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->sendExerciseNotification(
                        $rcp,
                        sprintf(
                            $this->getLanguageText('exc_msg_deadline_request_subject'),
                            $this->getObjectTitle(true)
                        ),
                        $this->getLanguageText('exc_msg_deadline_request_body') .
                        "\n\n" . $this->getLanguageText('user') . ": " .
                            $ilUser->getFullname(),
                        $perma->getGradesLink($this->ref_id, $this->getAssignmentId())
                    );
                }
                break;
 
            case self::TYPE_IDL_DEADLINE_SET:
                foreach ($this->getRecipients() as $rcp) {
                    $this->initLanguage($rcp);
                    $this->sendExerciseNotification(
                        $rcp,
                        sprintf(
                            $this->getLanguageText('exc_msg_idl_set_subject'),
                            $this->getObjectTitle(true)
                        ),
                        $this->getLanguageText('exc_msg_idl_set_body'),
                        $perma->getPermanentLink($this->ref_id, $this->getAssignmentId())
                    );
                }
                break;
        }
        return true;
    }

Here is the call graph for this function:

◆ sendExerciseNotification()

ilExerciseMailNotification::sendExerciseNotification	(	int	$rcp,
		string	$subject,
		string	$text,
		string	$link = `""`
	)

protected

Definition at line 348 of file class.ilExerciseMailNotification.php.

     : void {
        $this->initLanguage($rcp);
        $this->initMail();
        $this->setSubject($subject);
        $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
        $this->appendBody("\n\n" . $text);
        $this->appendBody(
            "\n\n" . $this->getLanguageText('obj_exc') . ": " . $this->getObjectTitle(true)
        );
        $this->appendBody("\n");
        if ($this->getAssignmentId() > 0) {
            $this->appendBody(
                $this->getLanguageText('exc_assignment') . ": " .
                ilExAssignment::lookupTitle($this->getAssignmentId())
            );
        }
        $this->appendBody("\n\n");
        $this->appendBody($this->getLanguageText('exc_mail_permanent_link'));
        $this->appendBody("\n");
        $this->appendBody($link);
        $this->getMail()->appendInstallationSignature(true);
        $this->sendMail(array($rcp));
    }

Referenced by send().

Here is the caller graph for this function:

◆ setAdditionalText()

ilExerciseMailNotification::setAdditionalText ( string $a_val )

Definition at line 87 of file class.ilExerciseMailNotification.php.

                                                    : void
    {
        $this->additional_text = $a_val;
    }

◆ setAssignmentId()

ilExerciseMailNotification::setAssignmentId ( int $a_val )

Definition at line 50 of file class.ilExerciseMailNotification.php.

                                               : void
    {
        $this->ass_id = $a_val;
    }

◆ setPeerId()

ilExerciseMailNotification::setPeerId ( int $a_val )

Definition at line 77 of file class.ilExerciseMailNotification.php.

                                         : void
    {
        $this->peer_id = $a_val;
    }

Field Documentation

◆ $additional_text

string ilExerciseMailNotification::$additional_text = ""

protected

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

Referenced by getAdditionalText().

◆ $ass_id

int ilExerciseMailNotification::$ass_id

protected

Definition at line 38 of file class.ilExerciseMailNotification.php.

Referenced by getAssignmentId().

◆ $domain

ILIAS Exercise InternalDomainService ilExerciseMailNotification::$domain

protected

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

◆ $peer_id

int ilExerciseMailNotification::$peer_id = 0

protected

Definition at line 34 of file class.ilExerciseMailNotification.php.

Referenced by getPeerId().

◆ $permanent_link

ILIAS Exercise PermanentLink PermanentLinkManager ilExerciseMailNotification::$permanent_link

protected

Definition at line 35 of file class.ilExerciseMailNotification.php.

Referenced by send().

◆ $user

ilObjUser ilExerciseMailNotification::$user

protected

Definition at line 37 of file class.ilExerciseMailNotification.php.

Referenced by send().

◆ TYPE_DEADLINE_REQUESTED

const ilExerciseMailNotification::TYPE_DEADLINE_REQUESTED = 70

Definition at line 31 of file class.ilExerciseMailNotification.php.

Referenced by send(), and ILIAS\Exercise\Notification\NotificationManager\sendDeadlineRequestNotification().

◆ TYPE_FEEDBACK_FILE_ADDED

const ilExerciseMailNotification::TYPE_FEEDBACK_FILE_ADDED = 20

Definition at line 24 of file class.ilExerciseMailNotification.php.

Referenced by send().

◆ TYPE_FEEDBACK_TEXT_ADDED

const ilExerciseMailNotification::TYPE_FEEDBACK_TEXT_ADDED = 40

Definition at line 26 of file class.ilExerciseMailNotification.php.

Referenced by send().

◆ TYPE_GRADING_DONE

const ilExerciseMailNotification::TYPE_GRADING_DONE = 70

Definition at line 27 of file class.ilExerciseMailNotification.php.

Referenced by send(), and ilExerciseManagementGUI\sendGradingNotificationObject().

◆ TYPE_IDL_DEADLINE_SET

const ilExerciseMailNotification::TYPE_IDL_DEADLINE_SET = 80

Definition at line 32 of file class.ilExerciseMailNotification.php.

Referenced by send(), and ILIAS\Exercise\Notification\NotificationManager\sendDeadlineSetNotification().

◆ TYPE_MESSAGE_FROM_PF_GIVER

const ilExerciseMailNotification::TYPE_MESSAGE_FROM_PF_GIVER = 50

Definition at line 29 of file class.ilExerciseMailNotification.php.

Referenced by send().

◆ TYPE_MESSAGE_FROM_PF_RECIPIENT

const ilExerciseMailNotification::TYPE_MESSAGE_FROM_PF_RECIPIENT = 60

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

Referenced by send().

◆ TYPE_SUBMISSION_UPLOAD

const ilExerciseMailNotification::TYPE_SUBMISSION_UPLOAD = 30

Definition at line 25 of file class.ilExerciseMailNotification.php.

Referenced by send(), and ILIAS\Exercise\Notification\NotificationManager\sendUploadNotification().

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

components/ILIAS/Exercise/Notification/class.ilExerciseMailNotification.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addOpenSubmission()

◆ getAdditionalText()

◆ getAssignmentId()

◆ getPeerId()

◆ initLanguage()

◆ send()

◆ sendExerciseNotification()

◆ setAdditionalText()

◆ setAssignmentId()

◆ setPeerId()

Field Documentation

◆ $additional_text

◆ $ass_id

◆ $domain

◆ $peer_id

◆ $permanent_link

◆ $user

◆ TYPE_DEADLINE_REQUESTED

◆ TYPE_FEEDBACK_FILE_ADDED

◆ TYPE_FEEDBACK_TEXT_ADDED

◆ TYPE_GRADING_DONE

◆ TYPE_IDL_DEADLINE_SET

◆ TYPE_MESSAGE_FROM_PF_GIVER

◆ TYPE_MESSAGE_FROM_PF_RECIPIENT

◆ TYPE_SUBMISSION_UPLOAD