ilIndividualAssessmentPrimitiveInternalNotificator Class Reference

Notifies user, using internal mail system. More...

Inheritance diagram for ilIndividualAssessmentPrimitiveInternalNotificator:

Collaboration diagram for ilIndividualAssessmentPrimitiveInternalNotificator:

Public Member Functions
	__construct ()
	withReceiver (ilIndividualAssessmentMember $member)
	Define the member, that should receive the message. More...
	withOccasionFailed ()
	Set message mode to failed. More...
	withOccasionCompleted ()
	Set message mode to complete. More...
	send ()
	Send message. 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 ()
	withReceiver (ilIndividualAssessmentMember $member)
	Define the member, that should receive the message. More...
	withOccasionFailed ()
	Set message mode to failed. More...
	withOccasionCompleted ()
	Set message mode to complete. More...
	send ()
	Send message. More...

Data Fields
const	OCCASION_FAILED = 0
const	OCCASION_COMPLETED = 1
Data Fields inherited from ilMailNotification
final const int	SUBJECT_TITLE_LENGTH = 60

Protected Attributes
int	$occasion
ilIndividualAssessmentMember	$receiver
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

Additional Inherited Members
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')

Detailed Description

Notifies user, using internal mail system.

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

Constructor & Destructor Documentation

__construct()

ilIndividualAssessmentPrimitiveInternalNotificator::__construct

(

)

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

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

References ILIAS\GlobalScreen\Provider\__construct(), and ilMailNotification\setLangModules().

Here is the call graph for this function:

Member Function Documentation

send()

ilIndividualAssessmentPrimitiveInternalNotificator::send

(

)

Send message.

Implements ilIndividualAssessmentNotificator.

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

                          : void
    {
        if (
            !$this->receiver instanceof ilIndividualAssessmentMember ||
            !in_array($this->occasion, array(self::OCCASION_COMPLETED, self::OCCASION_FAILED))
        ) {
            throw new ilIndividualAssessmentException('can\'t notify');
        }
        $this->initLanguage($this->receiver->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->receiver->assessment()->getTitle();
        $this->setSubject(
            sprintf($subject, $assessment_title)
        );
        $this->setBody(ilMail::getSalutation($this->receiver->id(), $this->getLanguage()));
        $this->appendBody("\n\n");
        $this->appendBody(sprintf($message, $assessment_title));
        $this->appendBody("\n\n");
        $this->appendBody($this->receiver->record());
        $this->appendBody("\n\n");
        $this->appendBody($this->createPermanentLink());
        $this->getMail()->appendInstallationSignature(true);
        $this->sendMail(array($this->receiver->id()));
    }

References $message, and ilMail\getSalutation().

Here is the call graph for this function:

withOccasionCompleted()

ilIndividualAssessmentPrimitiveInternalNotificator::withOccasionCompleted

(

)

Set message mode to complete.

Implements ilIndividualAssessmentNotificator.

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

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

withOccasionFailed()

ilIndividualAssessmentPrimitiveInternalNotificator::withOccasionFailed

(

)

Set message mode to failed.

Implements ilIndividualAssessmentNotificator.

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

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

withReceiver()

ilIndividualAssessmentPrimitiveInternalNotificator::withReceiver

(

ilIndividualAssessmentMember

$member

)

Define the member, that should receive the message.

Implements ilIndividualAssessmentNotificator.

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

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

Field Documentation

$occasion

int ilIndividualAssessmentPrimitiveInternalNotificator::$occasion

protected

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

$receiver

ilIndividualAssessmentMember ilIndividualAssessmentPrimitiveInternalNotificator::$receiver

protected

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

OCCASION_COMPLETED

const ilIndividualAssessmentPrimitiveInternalNotificator::OCCASION_COMPLETED = 1

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

OCCASION_FAILED

const ilIndividualAssessmentPrimitiveInternalNotificator::OCCASION_FAILED = 0

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

---

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

• components/ILIAS/IndividualAssessment/classes/Notification/class.ilIndividualAssessmentPrimitiveInternalNotificator.php