ilPRGMail Class Reference

Send mails to users (usually triggered by cron) More...

Collaboration diagram for ilPRGMail:

Public Member Functions
	__construct (protected ilComponentLogger $log, ilLanguage $lng)
	sendInformToReAssignMail (int $assignment_id, int $root_prg_id)
	resetExpiryInfoSentFor (int $assignment_id, int $root_prg_id)
	sendRiskyToFailMail (int $assignment_id, int $root_prg_id)
	resetRiskyToFailSentFor (int $assignment_id, int $root_prg_id)
	sendReAssignedMail (int $assignment_id, int $root_prg_id)

Protected Member Functions
	getAssignmentAndProgramme (int $assignment_id, int $root_prg_id)
	getUserLanguage (int $usr_id)
	txt (string $identifier, string $lang)
	sendMail (ilObjStudyProgramme $prg, ilPRGAssignment $assignment, string $subject, string $body_template)

Protected Attributes
const	LANGMODULE = 'prg'
array	$languages
	var <string, ilLanguage> $languages More...

Detailed Description

Send mails to users (usually triggered by cron)

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

Constructor & Destructor Documentation

__construct()

ilPRGMail::__construct	(	protected ilComponentLogger	$log,
		ilLanguage	$lng
	)

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

References $lng, ilLanguage\getLangKey(), and ilLanguage\loadLanguageModule().

      {
        $lng->loadLanguageModule(self::LANGMODULE);
        $lng->loadLanguageModule("mail");
        $this->languages[$lng->getLangKey()] = $lng;
    }

Here is the call graph for this function:

Member Function Documentation

getAssignmentAndProgramme()

ilPRGMail::getAssignmentAndProgramme ( int  $assignment_id, int  $root_prg_id  )

protected

Returns

array [ilPRGAssignment, ilObjStudyProgramme]

Definition at line 45 of file class.ilPRGMail.php.

References ilObjStudyProgramme\getInstanceByObjId().

Referenced by resetExpiryInfoSentFor(), resetRiskyToFailSentFor(), sendInformToReAssignMail(), sendReAssignedMail(), and sendRiskyToFailMail().

                                                                                      : array
    {
        $prg = ilObjStudyProgramme::getInstanceByObjId($root_prg_id);
        $ass = $prg->getSpecificAssignment($assignment_id);
        return [$ass, $prg];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserLanguage()

ilPRGMail::getUserLanguage ( int  $usr_id )

protected

Definition at line 52 of file class.ilPRGMail.php.

Referenced by sendMail(), sendReAssignedMail(), and sendRiskyToFailMail().

                                                   : string
    {
        return \ilObjUser::_getPreferences($usr_id)['language'];
    }

Here is the caller graph for this function:

resetExpiryInfoSentFor()

ilPRGMail::resetExpiryInfoSentFor	(	int	$assignment_id,
		int	$root_prg_id
	)

Definition at line 122 of file class.ilPRGMail.php.

References getAssignmentAndProgramme().

                                                                                : void
    {
        list($ass, $prg) = $this->getAssignmentAndProgramme($assignment_id, $root_prg_id);
        $now = new \DateTimeImmutable();
        $vq = $ass->getProgressTree()->getValidityOfQualification();

        if ($vq && $vq > $now) {
            $prg->resetExpiryInfoSentFor($ass);
        }
    }

Here is the call graph for this function:

resetRiskyToFailSentFor()

ilPRGMail::resetRiskyToFailSentFor	(	int	$assignment_id,
		int	$root_prg_id
	)

Definition at line 152 of file class.ilPRGMail.php.

References getAssignmentAndProgramme().

                                                                                 : void
    {
        list($ass, $prg) = $this->getAssignmentAndProgramme($assignment_id, $root_prg_id);
        $now = new \DateTimeImmutable();
        $deadline = $ass->getProgressTree()->getDeadline();
        if ($deadline && $deadline > $now) {
            $prg->resetRiskyToFailSentFor($ass);
        }
    }

Here is the call graph for this function:

sendInformToReAssignMail()

ilPRGMail::sendInformToReAssignMail	(	int	$assignment_id,
		int	$root_prg_id
	)

Definition at line 104 of file class.ilPRGMail.php.

References getAssignmentAndProgramme(), and sendMail().

                                                                                  : void
    {
        list($ass, $prg) = $this->getAssignmentAndProgramme($assignment_id, $root_prg_id);

        if (! $prg->getSettings()->getAutoMailSettings()->getReminderNotRestartedByUserDays() > 0) {
            $this->log->write("Send info to re-assign mail is deactivated in study programme settings");
            return;
        }

        $subject = "info_to_re_assign_mail_subject";
        $body_template = "info_to_re_assign_mail_body";
        $sent = $this->sendMail($prg, $ass, $subject, $body_template);

        if ($sent) {
            $prg->storeExpiryInfoSentFor($ass);
        }
    }

Here is the call graph for this function:

sendMail()

ilPRGMail::sendMail ( ilObjStudyProgramme  $prg, ilPRGAssignment  $assignment, string  $subject, string  $body_template  )

protected

Definition at line 69 of file class.ilPRGMail.php.

References Vendor\Package\$e, $lang, ilLink\_getStaticLink(), ANONYMOUS_USER_ID, ilObjStudyProgramme\getRefIdFor(), ilPRGAssignment\getRootId(), ilObject\getTitle(), ilPRGAssignment\getUserId(), ilPRGAssignment\getUserInformation(), getUserLanguage(), and txt().

Referenced by sendInformToReAssignMail(), sendReAssignedMail(), and sendRiskyToFailMail().

     : bool {
        $user_info = $assignment->getUserInformation();
        $gender = $user_info->getGender() ?: 'anonymous';
        $name = implode(' ', [$user_info->getFirstname(), $user_info->getLastname()]);
        $login = $user_info->getLogin();
        $prg_link = \ilLink::_getStaticLink(ilObjStudyProgramme::getRefIdFor($assignment->getRootId()), 'prg');

        $lang = $this->getUserLanguage($assignment->getUserId());
        $salutation = $this->txt("mail_salutation_" . $gender, $lang);
        $subject = $this->txt($subject, $lang);
        $body_template = $this->txt($body_template, $lang);

        $body = sprintf(
            $body_template,
            $salutation,
            $name,
            $prg->getTitle()
        )
        . '<br /><br />' . $prg_link;

        $mail = new ilMail(ANONYMOUS_USER_ID);
        try {
            $mail->enqueue($login, '', '', $subject, $body, []);
            return true;
        } catch (Exception $e) {
            $this->log->write($e->getMessage());
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendReAssignedMail()

ilPRGMail::sendReAssignedMail	(	int	$assignment_id,
		int	$root_prg_id
	)

Definition at line 162 of file class.ilPRGMail.php.

References $lang, getAssignmentAndProgramme(), getUserLanguage(), and sendMail().

                                                                            : bool
    {
        list($ass, $prg) = $this->getAssignmentAndProgramme($assignment_id, $root_prg_id);

        if (! $prg->getSettings()->getAutoMailSettings()->getSendReAssignedMail()) {
            $this->log->write("Send re assign mail is deactivated in study programme settings");
            return false;
        }

        $lang = $this->getUserLanguage($ass->getUserId());
        $subject = "re_assigned_mail_subject";
        $body_template = "re_assigned_mail_body";
        $sent = $this->sendMail($prg, $ass, $subject, $body_template);

        return $sent;
    }

Here is the call graph for this function:

sendRiskyToFailMail()

ilPRGMail::sendRiskyToFailMail	(	int	$assignment_id,
		int	$root_prg_id
	)

Definition at line 133 of file class.ilPRGMail.php.

References $lang, getAssignmentAndProgramme(), getUserLanguage(), and sendMail().

                                                                             : void
    {
        list($ass, $prg) = $this->getAssignmentAndProgramme($assignment_id, $root_prg_id);

        if (! $prg->getSettings()->getAutoMailSettings()->getProcessingEndsNotSuccessfulDays() > 0) {
            $this->log->write("Send risky to fail mail is deactivated in study programme settings");
            return;
        }

        $lang = $this->getUserLanguage($ass->getUserId());
        $subject = "risky_to_fail_mail_subject";
        $body_template = "risky_to_fail_mail_body";
        $sent = $this->sendMail($prg, $ass, $subject, $body_template);

        if ($sent) {
            $prg->storeRiskyToFailSentFor($ass);
        }
    }

Here is the call graph for this function:

txt()

ilPRGMail::txt ( string  $identifier, string  $lang  )

protected

Definition at line 57 of file class.ilPRGMail.php.

References $lang, and $lng.

Referenced by sendMail().

                                                            : string
    {
        if(!array_key_exists($lang, $this->languages)) {
            $lng = new \ilLanguage($lang);
            $lng->loadLanguageModule(self::LANGMODULE);
            $lng->loadLanguageModule("mail");
            $this->languages[$lang] = $lng;
        }
        $lng = $this->languages[$lang];
        return $lng->txtlng(self::LANGMODULE, $identifier, $lang);
    }

Here is the caller graph for this function:

Field Documentation

$languages

array ilPRGMail::$languages

protected

var <string, ilLanguage> $languages

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

LANGMODULE

const ilPRGMail::LANGMODULE = 'prg'

protected

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

---

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

• components/ILIAS/StudyProgramme/classes/Mail/class.ilPRGMail.php