Calendar: remove future absence when deleting participant or editing the date

Author: ali-ichk

CHANGELOG.txt

@@ -43,6 +43,7 @@ v31.0.00
         Attendance: student attendance history now ordered by timetable period
         Attendance: fixed the Consecutive Absences check to only count the final status for each day
         Calendar: switched default sorting of Manage Events to newest first
+        Calendar: remove future absence when deleting participant or editing the date
         Formal Assessment: added the feature for teachers to view unpublished internal assessments
         Library: updated automatic shelf lists so that lists are queried dynamically in Browse Library
         Library: added the option to edit the category and sub-category for an automatic shelf

modules/Calendar/calendar_event_edit.php

@@ -40,6 +40,10 @@
     if (empty($gibbonCalendarEventID) && isset($_GET['editID'])) {
         $page->return->setEditLink($session->get('absoluteURL').'/index.php?q=/modules/Calendar/calendar_event_edit.php&gibbonCalendarEventID='.$_GET['editID']);
     }
+
+    $page->return->addReturns([
+        'warning9' => __('Your request was completed successfully, but previous future absences for students in this event have been removed because the event date or time changed. Please set up future absences again.'),
+    ]);
 
     $calendarEventGateway = $container->get(CalendarEventGateway::class);
     $calendarEventPersonGateway = $container->get(CalendarEventPersonGateway::class);

modules/Calendar/calendar_event_editProcess.php

@@ -18,6 +18,7 @@
 */
 
 use Gibbon\Data\Validator;
+use Gibbon\Domain\Attendance\AttendanceLogPersonGateway;
 use Gibbon\Domain\Calendar\CalendarEventGateway;
 use Gibbon\Domain\Calendar\CalendarEventPersonGateway;
 use Gibbon\Support\Facades\Access;
@@ -40,6 +41,7 @@
 
     $calendarEventGateway = $container->get(CalendarEventGateway::class);
     $calendarEventPersonGateway = $container->get(CalendarEventPersonGateway::class);
+    $attendanceLogPersonGateway = $container->get(AttendanceLogPersonGateway::class);
 
     // Get event details
     $event = $calendarEventGateway->getEventDetailsByID($gibbonCalendarEventID, $session->get('gibbonPersonID'));
@@ -92,23 +94,26 @@
         header("Location: {$URL}");
     }
 
+    // Check if the date or time has changed compared to the existing event
+    $dateTimeChanged = $data['dateStart'] !== $event['dateStart'] || $data['dateEnd'] !== $event['dateEnd'] || $data['timeStart'] !== $event['timeStart'] || $data['timeEnd'] !== $event['timeEnd'];
+
     // Update the record
     if (!$calendarEventGateway->update($gibbonCalendarEventID, $data)) {
         $URL .= '&return=error2';
         header("Location: {$URL}");
     }
 
-     $organiser = $calendarEventPersonGateway->selectBy(['gibbonCalendarEventID' => $gibbonCalendarEventID, 'role' => 'Organiser', 'gibbonPersonID' => $gibbonPersonIDOrganiser])->fetch();
+    $organiser = $calendarEventPersonGateway->selectBy(['gibbonCalendarEventID' => $gibbonCalendarEventID, 'role' => 'Organiser', 'gibbonPersonID' => $gibbonPersonIDOrganiser])->fetch();
 
      if (empty($organiser)) {
          $organiserData = [
-            'gibbonCalendarEventID' => $gibbonCalendarEventID,
-            'gibbonPersonID'   => $gibbonPersonIDOrganiser,
-            'role'    => 'Organiser',
-            'gibbonPersonIDModified' => $session->get('gibbonPersonID') ?? '',
-            'timestampModified' => date('Y-m-d H:i:s'),
-            'timestampCreated'        => date('Y-m-d H:i:s'),
-            'gibbonPersonIDCreated'   => $session->get('gibbonPersonID') ?? '',
+            'gibbonCalendarEventID'     => $gibbonCalendarEventID,
+            'gibbonPersonID'            => $gibbonPersonIDOrganiser,
+            'role'                      => 'Organiser',
+            'gibbonPersonIDModified'    => $session->get('gibbonPersonID') ?? '',
+            'timestampModified'         => date('Y-m-d H:i:s'),
+            'timestampCreated'          => date('Y-m-d H:i:s'),
+            'gibbonPersonIDCreated'     => $session->get('gibbonPersonID') ?? '',
         ];
 
         $inserted = $calendarEventPersonGateway->insertAndUpdate($organiserData, $organiserData);
@@ -135,9 +140,40 @@
         $inserted = $calendarEventPersonGateway->insertAndUpdate($personData, $personData);
         $partialFail &= !$inserted;
     }
-    
-    $URL .= $partialFail
-        ? "&return=warning1"
-        : "&return=success0&editID=$gibbonCalendarEventID";
-    header("Location: {$URL}");    
+
+    // If event date or time changed, remove future absences for all student participants using the OLD dates
+    $absencesRemoved = false;
+    if ($dateTimeChanged) {
+        $criteria = $calendarEventPersonGateway->newQueryCriteria()
+            ->sortBy(['roleCategory', 'surname', 'preferredName']);
+
+        $participants = $calendarEventPersonGateway->queryEventAttendees($criteria, $gibbonCalendarEventID);
+
+        $studentPersonIDs = array_reduce($participants->toArray(), function ($group, $item) {
+            if ($item['roleCategory'] == 'Student') $group[] = $item['gibbonPersonID'];
+            return $group;
+        }, []);
+
+        if (!empty($studentPersonIDs)) {
+            // Query using the OLD event dates/times before the update
+            $futureAbsences = $event['allDay'] == 'Y' ? $attendanceLogPersonGateway->selectFutureAttendanceLogsByDate($event['dateStart'], $event['dateEnd'])->fetchAll() : $attendanceLogPersonGateway->selectFutureAttendanceLogsByDateAndTime($event['dateStart'], $event['dateEnd'], $event['timeStart'], $event['timeEnd'])->fetchAll();
+
+            foreach ($futureAbsences as $absence) {
+                if (in_array($absence['groupBy'], $studentPersonIDs)) {
+                    $futureAbsenceDeleted = $attendanceLogPersonGateway->delete($absence['gibbonAttendanceLogPersonID']);
+                    $absencesRemoved = true;
+                }
+            }
+        }
+    }
+
+    if ($absencesRemoved) {
+        $URL .= "&return=warning9&editID=$gibbonCalendarEventID";
+    } elseif ($partialFail) {
+        $URL .= "&return=warning1";
+    } else {
+        $URL .= "&return=success0&editID=$gibbonCalendarEventID";
+    }
+
+    header("Location: {$URL}");
 }