ilExerciseMailNotification Class Reference

Inheritance diagram for ilExerciseMailNotification:

Collaboration diagram for ilExerciseMailNotification:

Public Member Functions
	__construct ()
	setAssignmentId ($a_val)
	Set assignment id. More...
	getAssignmentId ()
	Get assignment id. More...
	send ()
	Send notifications. More...
Public Member Functions inherited from ilMailNotification
	__construct ($a_is_personal_workspace=false)
	setType ($a_type)
	Set notification type. More...
	getType ()
	Get notification type. More...
	setSender ($a_usr_id)
	Set sender of mail. More...
	getSender ()
	get sender of mail More...
	setRecipients (array $a_rcp)
	getRecipients ()
	get array of recipients More...
	setAttachments ($a_att)
	Set attachments. More...
	getAttachments ()
	Get attachments. More...
	setLangModules (array $a_modules)
	Set lang modules. More...
	getUserLanguage ($a_usr_id)
	Get user language. More...
	setRefId ($a_id)
	getRefId ()
	getObjId ()
	setObjId ($a_obj_id)
	getObjType ()
	Get object type. More...
	setAdditionalInformation (array $a_info)
	Additional information for creating notification mails. More...
	getAdditionalInformation ()
	sendMail (array $a_rcp, $a_parse_recipients=true)
	getBlockBorder ()
	Get (ascii) block border. More...

Data Fields
const	TYPE_FEEDBACK_FILE_ADDED = 20
const	TYPE_SUBMISSION_UPLOAD = 30
const	TYPE_FEEDBACK_TEXT_ADDED = 40
Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	initLanguage ($a_usr_id)
	Add language module exc. More...
Protected Member Functions inherited from ilMailNotification
	setSubject ($a_subject)
	getSubject ()
	setBody ($a_body)
	appendBody ($a_body)
	Append body text. More...
	getBody ()
	initLanguage ($a_usr_id)
	Init language. More...
	initLanguageByIso2Code ($a_code='')
	Init language by ISO2 code. More...
	setLanguage ($a_language)
	getLanguage ()
	getLanguageText ($a_keyword)
	getObjectTitle ($a_shorten=false)
	initMail ()
	getMail ()
	createPermanentLink ($a_params=array(), $a_append='')
	userToString ($a_usr_id)
	isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
	Check if ref id is accessible for user. More...

Protected Attributes
	$user
Protected Attributes inherited from ilMailNotification
	$type = null
	$sender = null
	$mail = null
	$subject = ''
	$body = ''
	$attachments = array()
	$language = null
	$lang_modules = array()
	$recipients = array()
	$ref_id = null
	$obj_id = null
	$obj_type = null
	$additional_info = array()
	$is_in_wsp
	$wsp_tree
	$wsp_access_handler

Detailed Description

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilExerciseMailNotification::__construct

(

)

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

    {
        global $DIC;
 
        $this->user = $DIC->user();
        parent::__construct();
    }

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

Here is the call graph for this function:

Member Function Documentation

getAssignmentId()

ilExerciseMailNotification::getAssignmentId

(

)

Get assignment id.

Returns

int assignment id

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

    {
        return $this->ass_id;
    }

Referenced by send().

Here is the caller graph for this function:

initLanguage()

ilExerciseMailNotification::initLanguage (   $a_usr_id )

protected

Add language module exc.

Parameters

object

$a_usr_id

Returns

Reimplemented from ilMailNotification.

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

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

References ilMailNotification\getLanguage().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilExerciseMailNotification::send

(

)

Send notifications.

Returns

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

    {
        $ilUser = $this->user;
        // 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->createPermanentLink(array(), '_' . $this->getAssignmentId()) .
                        '#fb' . $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->createPermanentLink()
                    ));
 
                    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->createPermanentLink(array(), "_" . $this->getAssignmentId() . "_" . $ilUser->getId() . "_setdownload")
                        ));
                        //}
                        //else
                        //{
                        //      $this->appendBody(sprintf($this->getLanguageText('exc_submission_downloads_notification_link'),
                        //              $this->getLanguageText("exc_submission_no_new_files")));
                        //}
                    }
 
                    $this->appendBody("\n\n");
                    $this->appendBody(sprintf(
                        $this->getLanguageText('exc_submission_and_grades_notification_link'),
                        $this->createPermanentLink(array(), "_" . $this->getAssignmentId() . "_grades")
                    ));
 
                    $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->createPermanentLink(array(), '_' . $this->getAssignmentId()) .
                        '#fb' . $this->getAssignmentId());
                    $this->getMail()->appendInstallationSignature(true);
                                        
                    $this->sendMail(array($rcp));
                }
                break;
        }
        return true;
    }

References $ilUser, $user, ilMailNotification\appendBody(), ilMailNotification\createPermanentLink(), getAssignmentId(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilMailNotification\getObjectTitle(), ilMailNotification\getRecipients(), ilMail\getSalutation(), ilMailNotification\getType(), initLanguage(), ilMailNotification\initMail(), ilExAssignment\lookupTitle(), ilExAssignment\lookupType(), ilMailNotification\sendMail(), ilMailNotification\setBody(), ilMailNotification\setSubject(), TYPE_FEEDBACK_FILE_ADDED, TYPE_FEEDBACK_TEXT_ADDED, TYPE_SUBMISSION_UPLOAD, and ilExAssignment\TYPE_UPLOAD.

Here is the call graph for this function:

setAssignmentId()

ilExerciseMailNotification::setAssignmentId

(

$a_val

)

Set assignment id.

Parameters

int	assignment id

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

    {
        $this->ass_id = $a_val;
    }

Field Documentation

$user

ilExerciseMailNotification::$user

protected

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

Referenced by send().

TYPE_FEEDBACK_FILE_ADDED

const ilExerciseMailNotification::TYPE_FEEDBACK_FILE_ADDED = 20

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

Referenced by send(), and ilObjExercise\sendFeedbackFileNotification().

TYPE_FEEDBACK_TEXT_ADDED

const ilExerciseMailNotification::TYPE_FEEDBACK_TEXT_ADDED = 40

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

Referenced by send(), and ilObjExercise\sendFeedbackFileNotification().

TYPE_SUBMISSION_UPLOAD

const ilExerciseMailNotification::TYPE_SUBMISSION_UPLOAD = 30

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

Referenced by ilExSubmissionBaseGUI\handleNewUpload(), ilExAssTypeWikiTeam\handleNewUpload(), and send().

---

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

• Modules/Exercise/classes/class.ilExerciseMailNotification.php