RCOS course mapping

Code refactoring, fixes, and comment/documentation improvements.

Author: pbailie

student_auto_feed/config.php

@@ -133,10 +133,15 @@
  * permit a student to declare their credit load.  The data feed will need
  * a column showing a student's credit load.  See above: COLUMN_CREDITS
  *
- * DO NOT MAP RCOS COURSES IN THE SUBMITTY DATABASE
+ * RCOS courses need to be mapped to a "primary" course in the database,
+ * but the autofeed will override the registration section as
+ * "{course_code}-{credit_load}".  e.g. "csci4700-4".
  */
 
-// List all RCOS courses, as an array.  If you are not tracking RCOS, then set as null or an empty array.
+// 1. List all RCOS courses, as an array.  If you are not tracking RCOS, then set as null or an empty array.
+// 2. One (any which one) of these courses needs to be designated as "primary" and the others need to be mapped to the
+// primary within the database.  Registration sections need to be defined in the database, but are otherwise irrelevant
+// as the auto feed will override registration sections.
 define('RCOS_COURSE_LIST', null);
 
 /* DATA SOURCING --------------------------------------------------------------

student_auto_feed/ssaf_rcos.php

@@ -4,25 +4,28 @@
 /**
  * Static utilty class to support RCOS (Rensselaer Center for Open Source)
  *
+ * This will override enrollment registration sections for RCOS courses.  Some RCOS students may declare how many
+ * credits they are registered for, but are otherwise all placed in the same course and registration section.
+ * (currently) Submitty does not keep records for regsitered credits per student, but this record is needed for
+ * RCOS.  Therefore, this helper class will override a RCOS student's enrollment record to `{course}-{credits}`
+ * e.g. `csci4700-4`.  This must done while processing the CSV because every override requires the student's
+ * registered credits from the CSV.
+ *
  * @author Peter Bailie
  */
 class rcos {
     private array $course_list;
 
     public function __construct() {
         $this->course_list = RCOS_COURSE_LIST ?? [];
+        sort($this->course_list, SORT_STRING);
         array_walk($this->course_list, function(&$v, $i) { $v = strtolower($v); });
     }
 
     /** Adjusts `$row[COLUMN_SECTION]` when `$course` is an RCOS course. */
     public function map(string $course, array &$row): void {
-        if ($this->check($course)) {
-            $row[COLUMN_SECTION] = "{$row[COLUMN_COURSE_NUMBER]}-{$row[COLUMN_CREDITS]}";
+        if (in_array($course, $this->course_list, true)) {
+            $row[COLUMN_SECTION] = "{$course}-{$row[COLUMN_CREDITS]}";
         }
     }
-
-    /** Returns `true` if `$course` is an RCOS course and `false` otherwise. */
-    public function check(string $course): bool {
-        return array_search($course, self::$course_list) !== false;
-    }
 }

student_auto_feed/submitty_student_auto_feed.php

@@ -29,7 +29,7 @@
 /** primary process class */
 class submitty_student_auto_feed {
     /** File handle to read CSV */
-    private resource $fh;
+    private $fh;
     /** Semester code */
     private string $semester;
     /** List of courses registered in Submitty */
@@ -83,9 +83,6 @@ public function __construct() {
             exit(1);
         }
 
-        // Helper object for special-cases involving RCOS.
-        $this->rcos = new rcos();
-
         // Get course list
         $error = null;
         $this->course_list = db::get_course_list($this->semester, $error);
@@ -103,12 +100,12 @@ public function __construct() {
             exit(1);
         }
 
-        // RCOS courses should not be mapped in the database.
-
-
         // Get CRN shared courses/sections (when a course/section is copied to another course/section)
         $this->crn_copymap = $this->read_crn_copymap();
 
+        // Helper object for special-cases involving RCOS.
+        $this->rcos = new rcos();
+
         // Init other properties.
         $this->invalid_courses = [];
         $this->data = [];
@@ -203,9 +200,6 @@ private function get_csv_data() {
             // Course is comprised of an alphabetic prefix and a numeric suffix.
             $course = strtolower($row[COLUMN_COURSE_PREFIX] . $row[COLUMN_COURSE_NUMBER]);
 
-            // Check/perform special-case RCOS registration section mapping.
-            rcos::map($course, $row);
-
             switch(true) {
             // Check that $row has an appropriate student registration.
             case array_search($row[COLUMN_REGISTRATION], $all_valid_reg_codes) === false:
@@ -224,6 +218,9 @@ private function get_csv_data() {
             // Check that $row is associated with the course list.
             case array_search($course, $this->course_list) !== false:
                 if (validate::validate_row($row, $row_num)) {
+                    // Check (and perform) special-case RCOS registration section mapping.
+                    $this->rcos->map($course, $row);
+
                     // Include $row
                     $this->data[$course][] = $row;
 
@@ -245,8 +242,13 @@ private function get_csv_data() {
                 if (array_key_exists($section, $this->mapped_courses[$course])) {
                     $m_course = $this->mapped_courses[$course][$section]['mapped_course'];
                     if (validate::validate_row($row, $row_num)) {
-                        // Include $row.
+                        // Do course mapping (alters registration section).
                         $row[COLUMN_SECTION] = $this->mapped_courses[$course][$section]['mapped_section'];
+
+                        // Check (and override) for special-case RCOS registration section mapping.
+                        $this->rcos->map($course, $row);
+
+                        // Include $row.
                         $this->data[$m_course][] = $row;
 
                         // $row with a blank email is allowed, but it is also logged.