Notificate user using internal mail system. More...

Inheritance diagram for ilIndividualAssessmentPrimitiveInternalNotificator:

Collaboration diagram for ilIndividualAssessmentPrimitiveInternalNotificator:

Public Member Functions

__construct ()

withReciever (ilIndividualAssessmentMember $member)

Define the member, that should recieve the message.

Parameters

ilIndividualAssessmentMember $member

Returns: ilIndividualAssessmentNotificator $this

More...

withOccasionFailed ()

Set message mode to failed.

Returns: ilIndividualAssessmentNotificator $this

More...

withOccasionCompleted ()

Set message mode to completed.

Returns: ilIndividualAssessmentNotificator $this

More...

send ()

Send message. 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_type, $a_parse_recipients=true)

getBlockBorder ()

Get (ascii) block border. More...

withReciever (ilIndividualAssessmentMember $member)

Define the member, that should recieve the message. More...

withOccasionFailed ()

Set message mode to failed. More...

withOccasionCompleted ()

Set message mode to completed. More...

send ()

Send message. More...

Data Fields
const	OCCASION_FAILED = 0

const	OCCASION_COMPLETED = 1

Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Protected Attributes
	$occasion

	$reciever

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

Additional Inherited Members
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...

Detailed Description

Notificate user using internal mail system.

Definition at line 8 of file class.ilIndividualAssessmentPrimitiveInternalNotificator.php.

Constructor & Destructor Documentation

◆ __construct()

ilIndividualAssessmentPrimitiveInternalNotificator::__construct ( )

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

    {
        parent::__construct();
        $this->setLangModules(array('iass'));
    }

References ilMailNotification\setLangModules().

Here is the call graph for this function:

Member Function Documentation

◆ send()

ilIndividualAssessmentPrimitiveInternalNotificator::send ( )

Send message.

Implements ilIndividualAssessmentNotificator.

Definition at line 56 of file class.ilIndividualAssessmentPrimitiveInternalNotificator.php.

    {
        if (!$this->reciever instanceof ilIndividualAssessmentMember || !in_array($this->occasion, array(self::OCCASION_COMPLETED,self::OCCASION_FAILED))) {
            throw new ilIndividualAssessmentException('can\'t notify');
        }
        $this->initLanguage($this->reciever->id());
        $this->initMail();
        $subject = $this->occasion === self::OCCASION_COMPLETED
            ? $this->getLanguageText('iass_subj_notification_completed')
            : $this->getLanguageText('iass_subj_notification_failed');
        $message = $this->occasion === self::OCCASION_COMPLETED
            ? $this->getLanguageText('iass_mess_notification_completed')
            : $this->getLanguageText('iass_mess_notification_failed');
        $assessment_title = $this->reciever->assessment()->getTitle();
        $this->setSubject(
            sprintf($subject, $assessment_title)
        );
        $this->setBody(ilMail::getSalutation($rcp, $this->getLanguage()));
        $this->appendBody("\n\n");
        $this->appendBody(sprintf($message, $assessment_title));
        $this->appendBody("\n\n");
        $this->appendBody($this->reciever->record());
        $this->appendBody("\n\n");
        $this->appendBody($this->createPermanentLink());
        $this->getMail()->appendInstallationSignature(true);
        $this->sendMail(array($this->reciever->id()), array('system'));
    }

References $message, ilMailNotification\$subject, ilMailNotification\appendBody(), ilMailNotification\createPermanentLink(), ilMailNotification\getLanguage(), ilMailNotification\getLanguageText(), ilMailNotification\getMail(), ilMail\getSalutation(), ilMailNotification\initLanguage(), ilMailNotification\initMail(), ilMailNotification\sendMail(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

Here is the call graph for this function:

◆ withOccasionCompleted()

ilIndividualAssessmentPrimitiveInternalNotificator::withOccasionCompleted ( )

Set message mode to completed.

Returns: ilIndividualAssessmentNotificator $this

Implements ilIndividualAssessmentNotificator.

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

    {
        $clone = clone $this;
        $clone->occasion = self::OCCASION_COMPLETED;
        return $clone;
    }

References OCCASION_COMPLETED.

◆ withOccasionFailed()

ilIndividualAssessmentPrimitiveInternalNotificator::withOccasionFailed ( )

Set message mode to failed.

Returns: ilIndividualAssessmentNotificator $this

Implements ilIndividualAssessmentNotificator.

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

    {
        $clone = clone $this;
        $clone->occasion = self::OCCASION_FAILED;
        return $clone;
    }

References OCCASION_FAILED.

◆ withReciever()

ilIndividualAssessmentPrimitiveInternalNotificator::withReciever ( ilIndividualAssessmentMember $member )

Define the member, that should recieve the message.

Parameters

ilIndividualAssessmentMember $member

Returns: ilIndividualAssessmentNotificator $this

Implements ilIndividualAssessmentNotificator.

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

    {
        $clone = clone $this;
        $clone->reciever = $member;
        $clone->ref_id = $member->assessment()->getRefId();
        return $clone;
    }