ilPRGMail Class Reference

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

Collaboration diagram for ilPRGMail:

Public Member Functions
	__construct (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)
	sendMail (ilObjStudyProgramme $prg, ilPRGAssignment $assignment, string $subject, string $body_template)

Protected Attributes
ilComponentLogger	$log
ilLanguage	$lng

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 Send mails to users (usually triggered by cron)

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

Constructor & Destructor Documentation

__construct()

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

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

References $lng, $log, and ILIAS\Repository\lng().

      {
        $this->log = $log;
        $this->lng = $lng;
        $this->lng->loadLanguageModule("prg");
        $this->lng->loadLanguageModule("mail");
    }

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 42 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:

resetExpiryInfoSentFor()

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

Definition at line 95 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 124 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 77 of file class.ilPRGMail.php.

References getAssignmentAndProgramme(), ILIAS\Repository\lng(), 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 = $this->lng->txt("info_to_re_assign_mail_subject");
        $body_template = $this->lng->txt("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 49 of file class.ilPRGMail.php.

References Vendor\Package\$e, $name, ANONYMOUS_USER_ID, ilObject\getTitle(), ilPRGAssignment\getUserInformation(), and ILIAS\Repository\lng().

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

     : bool {
        $user_info = $assignment->getUserInformation();
        $gender = $user_info->getGender() ?: 'anonymous';
        $name = $user_info->getFullname();
        $login = $user_info->getLogin();

        $body = sprintf(
            $body_template,
            $this->lng->txt("mail_salutation_" . $gender),
            $name,
            $prg->getTitle()
        );

        $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 134 of file class.ilPRGMail.php.

References getAssignmentAndProgramme(), ILIAS\Repository\lng(), 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;
        }

        $subject = $this->lng->txt("re_assigned_mail_subject");
        $body_template = $this->lng->txt("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 106 of file class.ilPRGMail.php.

References getAssignmentAndProgramme(), ILIAS\Repository\lng(), 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;
        }

        $subject = $this->lng->txt("risky_to_fail_mail_subject");
        $body_template = $this->lng->txt("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:

Field Documentation

$lng

ilLanguage ilPRGMail::$lng

protected

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

Referenced by __construct().

$log

ilComponentLogger ilPRGMail::$log

protected

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

Referenced by __construct().

---

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

• Modules/StudyProgramme/classes/Mail/class.ilPRGMail.php