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

Collaboration diagram for ilExAssignmentReminder:

Public Member Functions
	__construct (int $a_exc_id=0, int $a_ass_id=0, string $a_type="")

	getReminderType ()

	setReminderStatus (?bool $a_status)
	Set reminder for users without submission. More...

	getReminderStatus ()

	setReminderStart (int $a_num_days)

	getReminderStart ()

	setReminderEnd (int $a_date)

	getReminderEnd ()

	setReminderFrequency (int $a_num_days)

	getReminderFrequency ()

	setReminderLastSend (int $a_timestamp)

	getReminderLastSend ()

	setReminderMailTemplate (int $a_tpl_id)

	getReminderMailTemplate ()

	save ()

	update ()

	read ()

	getReminders (string $a_type="")
	Get reminders available by date/frequence. More...

	parseGradeReminders (array $a_reminders)

	parsePeerReminders (array $a_reminders)

	checkReminders ()

	deleteReminders (int $a_ass_id)

Data Fields
const	SUBMIT_REMINDER = "submit"

const	GRADE_REMINDER = "grade"

const	FEEDBACK_REMINDER = "peer"

Protected Member Functions
	initFromDB (array $a_set)

	sentReminderPlaceholders (string $a_message, array $a_reminder_data, string $a_reminder_type)

	updateRemindersLastDate (array $a_reminders)

Protected Attributes
ilDBInterface	$db

ilTree	$tree

bool	$rmd_status = null

int	$rmd_start = 0

int	$rmd_end = 0

int	$rmd_frequency = 0

int	$rmd_last_send = 0

int	$rmd_tpl_id = 0

int	$ass_id = 0

int	$exc_id = 0

string	$rmd_type = ""

ilLogger	$log

ilAccessHandler	$access

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

TODO: import/export reminder data with the exercise/assignment. TODO: Delete reminders from exc_ass_reminders when the assignment is deleted.

Exercise Assignment Reminders

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilExAssignmentReminder::__construct	(	int	$a_exc_id = `0`,
		int	$a_ass_id = `0`,
		string	$a_type = `""`
	)

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

References $DIC, ILIAS\Repository\access(), ilLoggerFactory\getLogger(), and read().

       {
         global $DIC;
         $this->db = $DIC->database();
         $this->tree = $DIC->repositoryTree();
         $this->access = $DIC->access();
         $this->log = ilLoggerFactory::getLogger("exc");
 
         if ($a_ass_id) {
             $this->ass_id = $a_ass_id;
         }
         if ($a_exc_id) {
             $this->exc_id = $a_exc_id;
         }
         if ($a_type) {
             $this->rmd_type = $a_type;
         }
         if ($a_exc_id and $a_ass_id and $a_type) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkReminders()

ilExAssignmentReminder::checkReminders ( )

Returns: int number of reminders sent

Exceptions

ilExcUnknownAssignmentTypeException
Exception

Definition at line 458 of file class.ilExAssignmentReminder.php.

References $DIC, $message, $rmd_type, $tpl, ilLanguageFactory\_getLanguageOfUser(), ilLink\_getLink(), ilObjUser\_lookupFullname(), ilObjUser\_lookupLogin(), ilObject\_lookupTitle(), ANONYMOUS_USER_ID, getReminders(), ilExAssignment\lookupTitle(), parseGradeReminders(), parsePeerReminders(), sentReminderPlaceholders(), and updateRemindersLastDate().

                                     : int
     {
         $submit_reminders = $this->getReminders(self::SUBMIT_REMINDER);
         $parsed_submit_reminders = $this->parseSubmissionReminders($submit_reminders);
 
         $grade_reminders = $this->getReminders(self::GRADE_REMINDER);
         $parsed_grade_reminders = $this->parseGradeReminders($grade_reminders);
 
         $peer_reminders = $this->getReminders(self::FEEDBACK_REMINDER);
         $parsed_peer_reminders = $this->parsePeerReminders($peer_reminders);
 
         /* //DEBUG
         $this->log->debug("ALL SUBMIT REMINDERS");
         $this->log->dump($submit_reminders);
         $this->log->debug("PARSED SUBMIT REMINDERS");
         $this->log->dump($parsed_submit_reminders);
         $this->log->debug("GRADE REMINDERS ARRAY");
         $this->log->dump($grade_reminders);
         $this->log->debug("PARSED GRADE REMINDERS");
         $this->log->dump($parsed_grade_reminders);
         $this->log->debug("PEER REMINDERS ARRAY");
         $this->log->dump($peer_reminders);
         $this->log->debug("PARSED PEER REMINDERS");
         $this->log->dump($parsed_peer_reminders);
         */
 
         $reminders = array_merge($parsed_submit_reminders, $parsed_grade_reminders, $parsed_peer_reminders);
 
         return $this->sendReminders($reminders);
     }

Here is the call graph for this function:

◆ deleteReminders()

ilExAssignmentReminder::deleteReminders ( int $a_ass_id )

Definition at line 622 of file class.ilExAssignmentReminder.php.

                                                   : void
     {
         $sql = "DELETE FROM exc_ass_reminders" .
             " WHERE ass_id = " . $a_ass_id;
 
         $this->db->manipulate($sql);
     }

◆ getReminderEnd()

ilExAssignmentReminder::getReminderEnd ( )

Definition at line 113 of file class.ilExAssignmentReminder.php.

References $rmd_end.

Referenced by save(), and update().

                                     : int
     {
         return $this->rmd_end;
     }

Here is the caller graph for this function:

◆ getReminderFrequency()

ilExAssignmentReminder::getReminderFrequency ( )

Definition at line 124 of file class.ilExAssignmentReminder.php.

References $rmd_frequency.

Referenced by save(), and update().

                                           : int
     {
         return $this->rmd_frequency;
     }

Here is the caller graph for this function:

◆ getReminderLastSend()

ilExAssignmentReminder::getReminderLastSend ( )

Definition at line 134 of file class.ilExAssignmentReminder.php.

References $rmd_last_send.

Referenced by save(), and update().

                                          : int
     {
         return $this->rmd_last_send;
     }

Here is the caller graph for this function:

◆ getReminderMailTemplate()

ilExAssignmentReminder::getReminderMailTemplate ( )

Definition at line 144 of file class.ilExAssignmentReminder.php.

References $rmd_tpl_id.

Referenced by save(), and update().

                                              : int
     {
         return $this->rmd_tpl_id;
     }

Here is the caller graph for this function:

◆ getReminders()

ilExAssignmentReminder::getReminders ( string $a_type = "" )

Get reminders available by date/frequence.

Exceptions

Exception

Definition at line 218 of file class.ilExAssignmentReminder.php.

References $query, ilObject\_getAllReferences(), ILIAS\Repository\access(), and ilExcAssMemberState\getInstanceByIds().

Referenced by checkReminders().

                                                      : array
     {
         $now = time();
         $today = date("Y-m-d");
 
         $this->log->debug("Get reminders $a_type.");
 
         //remove time from the timestamp (86400 = 24h)
         //$now = floor($now/86400)*86400;
         $and_type = "";
         if ($a_type == self::SUBMIT_REMINDER || $a_type == self::GRADE_REMINDER || $a_type == self::FEEDBACK_REMINDER) {
             $and_type = " AND type = '" . $a_type . "'";
         }
 
         $query = "SELECT last_send_day, ass_id, exc_id, status, start, freq, end, type, last_send, template_id" .
             " FROM exc_ass_reminders" .
             " WHERE status = 1" .
             " AND start <= " . $now .
             " AND end > " . ($now - 86400) .
             $and_type;
 
 
         $result = $this->db->query($query);
 
         $array_data = array();
         while ($rec = $this->db->fetchAssoc($result)) {
             $rem = array(
                 "ass_id" => $rec["ass_id"],
                 "exc_id" => $rec["exc_id"],
                 "start" => $rec["start"],
                 "end" => $rec["end"],
                 "freq" => $rec["freq"],
                 "type" => $rec["type"],
                 "last_send" => $rec["last_send"],
                 "last_send_day" => $rec["last_send_day"],
                 "template_id" => $rec["template_id"]
             );
 
             $end_day = date("Y-m-d", $rec["end"]);
 
             //frequency
             $next_send = "";
             if ($rec["last_send_day"] != "") {
                 $date = new DateTime($rec["last_send_day"]);
                 $date->add(new DateInterval('P' . $rec["freq"] . 'D'));
                 $next_send = $date->format('Y-m-d');
             }
             $this->log->debug("ass: " . $rec["ass_id"] . ", last send: " . $rec["last_send_day"] .
                 ", freq: " . $rec["freq"] . ", end_day: $end_day, today: " . $today . ", next send: $next_send");
             if ($rec["last_send_day"] == "" || $next_send <= $today) {
                 if ($end_day >= $today) {
                     $this->log->debug("included");
                     $array_data[] = $rem;
                 }
             }
         }
 
         return $array_data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReminderStart()

ilExAssignmentReminder::getReminderStart ( )

Definition at line 103 of file class.ilExAssignmentReminder.php.

References $rmd_start.

Referenced by save(), and update().

                                       : int
     {
         return $this->rmd_start;
     }

Here is the caller graph for this function:

◆ getReminderStatus()

ilExAssignmentReminder::getReminderStatus ( )

Definition at line 92 of file class.ilExAssignmentReminder.php.

References $rmd_status.

Referenced by ilExAssignmentEditorGUI\getAssignmentValues(), save(), ilExAssignmentEditorGUI\saveReminderData(), and update().

                                        : ?bool
     {
         return $this->rmd_status;
     }

Here is the caller graph for this function:

◆ getReminderType()

ilExAssignmentReminder::getReminderType ( )

Definition at line 78 of file class.ilExAssignmentReminder.php.

References $rmd_type.

Referenced by ilExAssignmentEditorGUI\saveReminderData().

                                      : string
     {
         return $this->rmd_type;
     }

Here is the caller graph for this function:

◆ initFromDB()

ilExAssignmentReminder::initFromDB ( array $a_set )

protected

Definition at line 201 of file class.ilExAssignmentReminder.php.

References setReminderEnd(), setReminderFrequency(), setReminderLastSend(), setReminderMailTemplate(), setReminderStart(), and setReminderStatus().

Referenced by read().

                                                : void
     {
         $this->setReminderStatus((bool) $a_set["status"]);
         $this->setReminderStart((int) $a_set["start"]);
         $this->setReminderEnd((int) $a_set["end"]);
         $this->setReminderFrequency((int) $a_set["freq"]);
         $this->setReminderLastSend((int) $a_set["last_send"]);
         $this->setReminderMailTemplate((int) $a_set["template_id"]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseGradeReminders()

ilExAssignmentReminder::parseGradeReminders ( array $a_reminders )

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 362 of file class.ilExAssignmentReminder.php.

References ilObject\_getAllReferences(), ILIAS\Repository\access(), ilNotification\getNotificationsForObject(), ilExerciseManagementGUI\GRADE_NOT_GRADED, and ilNotification\TYPE_EXERCISE_SUBMISSION.

Referenced by checkReminders().

                                                            : array
     {
         $reminders = $a_reminders;
         $users_to_remind = array();
 
         $has_pending_to_grade = false;
 
         foreach ($reminders as $rem) {
             //$this->log->debug("---- parse grade reminder with values -> ",$rem);
             $ass_obj = new ilExAssignment($rem["ass_id"]);
             $members_data = $ass_obj->getMemberListData();
 
             //$this->log->debug("--- get members list data  => ",$members_data);
             foreach ($members_data as $assignment_data) {
                 if ($assignment_data["status"] == ilExerciseManagementGUI::GRADE_NOT_GRADED) {
                     //at least there is one submission pending to grade.
                     $has_pending_to_grade = true;
                 }
             }
 
             if ($has_pending_to_grade) {
                 //get tutor of this exercise.
                 $users = ilNotification::getNotificationsForObject(ilNotification::TYPE_EXERCISE_SUBMISSION, $rem["exc_id"]);
 
                 foreach ($users as $user_id) {
                     $exc_refs = ilObject::_getAllReferences($rem["exc_id"]);
                     $unike_usr_id = array();
                     foreach ($exc_refs as $exc_ref) {
                         if ($this->access->checkAccessOfUser($user_id, "write", "", $exc_ref)) {
                             if (!in_array($user_id, $unike_usr_id)) {
                                 $member_data = array(
                                     "exc_id" => $rem["exc_id"],
                                     "exc_ref" => $exc_ref,
                                     "ass_id" => $rem["ass_id"],
                                     "member_id" => $user_id,
                                     "reminder_type" => $rem["type"],
                                     "template_id" => $rem["template_id"]
                                 );
                                 $users_to_remind[] = $member_data;
                                 $unike_usr_id[] = $user_id;
                             }
                         }
                     }
                 }
             }
         }
 
         return $users_to_remind;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parsePeerReminders()

ilExAssignmentReminder::parsePeerReminders ( array $a_reminders )

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 415 of file class.ilExAssignmentReminder.php.

References ilObject\_getAllReferences(), ILIAS\Repository\access(), ilExcAssMemberState\getInstanceByIds(), and ilExPeerReview\lookupGiversWithPendingFeedback().

Referenced by checkReminders().

                                                           : array
     {
         $reminders = $a_reminders;
         $users_to_remind = array();
 
         $this->log->debug("Peer Reminders: " . count($a_reminders));
 
         foreach ($reminders as $reminder) {
             $this->log->debug("Init peer review: " . $reminder["ass_id"]);
             $pr = new ilExPeerReview(new ilExAssignment($reminder["ass_id"]));
             $pr->initPeerReviews();
             $giver_ids = array_unique(ilExPeerReview::lookupGiversWithPendingFeedback($reminder["ass_id"]));
             foreach ($giver_ids as $giver_id) {
                 $state = ilExcAssMemberState::getInstanceByIds($reminder["ass_id"], $giver_id);
                 $days_diff = (($state->getPeerReviewDeadline() - time()) / (60 * 60 * 24));
 
                 if ($state->isPeerReviewAllowed() && $days_diff < $reminder["start"]) {
                     $exc_refs = ilObject::_getAllReferences($reminder["exc_id"]);
                     foreach ($exc_refs as $exc_ref) {
                         if ($this->access->checkAccessOfUser($giver_id, "read", "", $exc_ref)) {
                             $member_data = array(
                                 "exc_id" => $reminder["exc_id"],
                                 "exc_ref" => $exc_ref,
                                 "ass_id" => $reminder["ass_id"],
                                 "member_id" => $giver_id,
                                 "reminder_type" => $reminder["type"],
                                 "template_id" => $reminder["template_id"]
                             );
                             $users_to_remind[] = $member_data;
                         }
                     }
                 }
             }
         }
 
         return $users_to_remind;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilExAssignmentReminder::read ( )

Definition at line 185 of file class.ilExAssignmentReminder.php.

References initFromDB().

Referenced by __construct().

                           : void
     {
         $set = $this->db->queryF(
             "SELECT status, start, freq, end, last_send, template_id" .
             " FROM exc_ass_reminders" .
             " WHERE type = %s AND ass_id = %s AND exc_id = %s",
             ["text", "integer", "integer"],
             [$this->rmd_type, $this->ass_id, $this->exc_id]
         );
 
         $rec = $this->db->fetchAssoc($set);
         if (is_array($rec)) {
             $this->initFromDB($rec);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilExAssignmentReminder::save ( )

Definition at line 149 of file class.ilExAssignmentReminder.php.

References getReminderEnd(), getReminderFrequency(), getReminderLastSend(), getReminderMailTemplate(), getReminderStart(), and getReminderStatus().

                           : void
     {
         $this->db->insert("exc_ass_reminders", array(
             "type" => array("text", $this->rmd_type),
             "ass_id" => array("integer", $this->ass_id),
             "exc_id" => array("integer", $this->exc_id),
             "status" => array("integer", $this->getReminderStatus()),
             "start" => array("integer", $this->getReminderStart()),
             "end" => array("integer", $this->getReminderEnd()),
             "freq" => array("integer", $this->getReminderFrequency()),
             "last_send" => array("integer", $this->getReminderLastSend()),
             "template_id" => array("integer", $this->getReminderMailTemplate())
         ));
     }

Here is the call graph for this function:

◆ sentReminderPlaceholders()

ilExAssignmentReminder::sentReminderPlaceholders	(	string	$a_message,
		array	$a_reminder_data,
		string	$a_reminder_type
	)

protected

Definition at line 573 of file class.ilExAssignmentReminder.php.

References $context, Vendor\Package\$e, exit, FEEDBACK_REMINDER, ilLoggerFactory\getLogger(), ilMailTemplateContextService\getTemplateContextById(), GRADE_REMINDER, ilExcMailTemplateSubmitReminderContext\ID, ilExcMailTemplatePeerReminderContext\ID, ilExcMailTemplateGradeReminderContext\ID, and SUBMIT_REMINDER.

Referenced by checkReminders().

      : string {
         // see ilMail::replacePlaceholders()
         try {
             switch ($a_reminder_type) {
                 case ilExAssignmentReminder::SUBMIT_REMINDER:
                     $context = ilMailTemplateContextService::getTemplateContextById(ilExcMailTemplateSubmitReminderContext::ID);
                     break;
                 case ilExAssignmentReminder::GRADE_REMINDER:
                     $context = ilMailTemplateContextService::getTemplateContextById(ilExcMailTemplateGradeReminderContext::ID);
                     break;
                 case ilExAssignmentReminder::FEEDBACK_REMINDER:
                     $context = ilMailTemplateContextService::getTemplateContextById(ilExcMailTemplatePeerReminderContext::ID);
                     break;
                 default:
                     exit();
             }
 
             $user = new ilObjUser($a_reminder_data["member_id"]);
 
             $processor = new ilMailTemplatePlaceholderResolver($context, $a_message);
             $a_message = $processor->resolve($user, $a_reminder_data);
         } catch (Exception $e) {
             ilLoggerFactory::getLogger('mail')->error(__METHOD__ . ' has been called with invalid context.');
         }
 
         return $a_message;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReminderEnd()

ilExAssignmentReminder::setReminderEnd ( int $a_date )

Definition at line 108 of file class.ilExAssignmentReminder.php.

Referenced by initFromDB(), and ilExAssignmentEditorGUI\saveReminderData().

                                                : void
     {
         $this->rmd_end = $a_date;
     }

Here is the caller graph for this function:

◆ setReminderFrequency()

ilExAssignmentReminder::setReminderFrequency ( int $a_num_days )

Definition at line 119 of file class.ilExAssignmentReminder.php.

Referenced by initFromDB(), and ilExAssignmentEditorGUI\saveReminderData().

                                                          : void
     {
         $this->rmd_frequency = $a_num_days;
     }

Here is the caller graph for this function:

◆ setReminderLastSend()

ilExAssignmentReminder::setReminderLastSend ( int $a_timestamp )

Definition at line 129 of file class.ilExAssignmentReminder.php.

Referenced by initFromDB().

                                                          : void
     {
         $this->rmd_last_send = $a_timestamp;
     }

Here is the caller graph for this function:

◆ setReminderMailTemplate()

ilExAssignmentReminder::setReminderMailTemplate ( int $a_tpl_id )

Definition at line 139 of file class.ilExAssignmentReminder.php.

Referenced by initFromDB(), and ilExAssignmentEditorGUI\saveReminderData().

                                                           : void
     {
         $this->rmd_tpl_id = $a_tpl_id;
     }

Here is the caller graph for this function:

◆ setReminderStart()

ilExAssignmentReminder::setReminderStart ( int $a_num_days )

Definition at line 98 of file class.ilExAssignmentReminder.php.

Referenced by initFromDB(), and ilExAssignmentEditorGUI\saveReminderData().

                                                      : void
     {
         $this->rmd_start = $a_num_days;
     }

Here is the caller graph for this function:

◆ setReminderStatus()

ilExAssignmentReminder::setReminderStatus ( ?bool $a_status )

Set reminder for users without submission.

Parameters

bool $a_status activated?

Definition at line 87 of file class.ilExAssignmentReminder.php.

Referenced by ilExAssignment\cloneAssignmentsOfExercise(), initFromDB(), and ilExAssignmentEditorGUI\saveReminderData().

                                                       : void
     {
         $this->rmd_status = $a_status;
     }

Here is the caller graph for this function:

◆ update()

ilExAssignmentReminder::update ( )

Definition at line 164 of file class.ilExAssignmentReminder.php.

References getReminderEnd(), getReminderFrequency(), getReminderLastSend(), getReminderMailTemplate(), getReminderStart(), and getReminderStatus().

                             : void
     {
         $this->db->update(
             "exc_ass_reminders",
             array(
             "status" => array("integer", $this->getReminderStatus()),
             "start" => array("integer", $this->getReminderStart()),
             "end" => array("integer", $this->getReminderEnd()),
             "freq" => array("integer", $this->getReminderFrequency()),
             "last_send" => array("integer", $this->getReminderLastSend()),
             "template_id" => array("integer", $this->getReminderMailTemplate())
         ),
             array(
             "type" => array("text", $this->rmd_type),
             "exc_id" => array("integer", $this->exc_id),
             "ass_id" => array("integer", $this->ass_id)
         )
         );
     }

Here is the call graph for this function:

◆ updateRemindersLastDate()

ilExAssignmentReminder::updateRemindersLastDate ( array $a_reminders )

protected

Definition at line 606 of file class.ilExAssignmentReminder.php.

Referenced by checkReminders().

                                                                   : void
     {
         $today = date("Y-m-d");
         foreach ($a_reminders as $reminder) {
             $sql = "UPDATE exc_ass_reminders" .
                 " SET last_send = " . $this->db->quote(time(), 'integer') .
                 " , last_send_day = " . $this->db->quote($today, 'date') .
                 " WHERE type = " . $this->db->quote($reminder["reminder_type"], 'text') .
                 " AND ass_id = " . $this->db->quote($reminder["ass_id"], 'integer') .
                 " AND exc_id = " . $this->db->quote($reminder["exc_id"], 'integer');
 
             $this->db->manipulate($sql);
         }
     }