MDL-65829 analytics: Accept enrol start time after analysis time

Author: David Monllaó

course/classes/analytics/target/course_competencies.php

@@ -118,11 +118,6 @@ public function is_valid_analysable(\core_analytics\analysable $course, $fortrai
      */
     protected function calculate_sample($sampleid, \core_analytics\analysable $course, $starttime = false, $endtime = false) {
 
-        if ($this->enrolment_starts_after_calculation_start($sampleid, $starttime)) {
-            // Discard user enrolments whose start date is after $starttime.
-            return null;
-        }
-
         $userenrol = $this->retrieve('user_enrolments', $sampleid);
 
         $key = $course->get_id();

course/classes/analytics/target/course_completion.php

@@ -96,10 +96,6 @@ public function is_valid_analysable(\core_analytics\analysable $course, $fortrai
      */
     protected function calculate_sample($sampleid, \core_analytics\analysable $course, $starttime = false, $endtime = false) {
 
-        if ($this->enrolment_starts_after_calculation_start($sampleid, $starttime)) {
-            // Discard user enrolments whose start date is after $starttime.
-            return null;
-        }
         $userenrol = $this->retrieve('user_enrolments', $sampleid);
 
         // We use completion as a success metric.

course/classes/analytics/target/course_dropout.php

@@ -118,11 +118,6 @@ public function is_valid_analysable(\core_analytics\analysable $course, $fortrai
      */
     protected function calculate_sample($sampleid, \core_analytics\analysable $course, $starttime = false, $endtime = false) {
 
-        if ($this->enrolment_starts_after_calculation_start($sampleid, $starttime)) {
-            // Discard user enrolments whose start date is after $starttime.
-            return null;
-        }
-
         $userenrol = $this->retrieve('user_enrolments', $sampleid);
 
         // We use completion as a success metric only when it is enabled.

course/classes/analytics/target/course_enrolments.php

@@ -197,27 +197,4 @@ public function prediction_actions(\core_analytics\prediction $prediction, $incl
 
         return array_merge($actions, parent::prediction_actions($prediction, $includedetailsaction));
     }
-
-    /**
-     * Does the user enrolment created after this time range start time or starts after it?
-     *
-     * We need to identify these enrolments because the indicators can not be calculated properly
-     * if the student enrolment started half way through this time range.
-     *
-     * User enrolments whose end date is before time() have already been discarded in
-     * course_enrolments::is_valid_sample.
-     *
-     * @param  int    $sampleid
-     * @param  int    $starttime
-     * @return bool
-     */
-    protected function enrolment_starts_after_calculation_start(int $sampleid, int $starttime) {
-
-        $userenrol = $this->retrieve('user_enrolments', $sampleid);
-        if ($userenrol->timestart && $userenrol->timestart > $starttime) {
-            return true;
-        }
-
-        return false;
-    }
 }

course/classes/analytics/target/course_gradetopass.php

@@ -164,11 +164,6 @@ public function is_valid_analysable(\core_analytics\analysable $course, $fortrai
      */
     protected function calculate_sample($sampleid, \core_analytics\analysable $course, $starttime = false, $endtime = false) {
 
-        if ($this->enrolment_starts_after_calculation_start($sampleid, $starttime)) {
-            // Discard user enrolments whose start date is after $starttime.
-            return null;
-        }
-
         $userenrol = $this->retrieve('user_enrolments', $sampleid);
 
         // Get course grade to pass.

lib/tests/targets_test.php

@@ -413,15 +413,11 @@ public function test_core_target_course_gradetopass_calculate() {
         $student1 = $dg->create_user();
         $student2 = $dg->create_user();
         $student3 = $dg->create_user();
-        $student4 = $dg->create_user();
         $studentrole = $DB->get_record('role', array('shortname' => 'student'));
         $dg->enrol_user($student1->id, $course1->id, $studentrole->id);
         $dg->enrol_user($student2->id, $course1->id, $studentrole->id);
         $dg->enrol_user($student3->id, $course1->id, $studentrole->id);
 
-        $enrolstart = mktime(0, 0, 0, 10, 25, 2015);
-        $dg->enrol_user($student4->id, $course1->id, $studentrole->id, 'manual', $enrolstart);
-
         // get_all_samples() does not guarantee any order, so let's
         // explicitly define the expectations here for later comparing.
         // Expectations format being array($userid => expectation, ...)
@@ -439,9 +435,6 @@ public function test_core_target_course_gradetopass_calculate() {
         // Student 3 (has no grade) fails, so it's non achieved sample.
         $expectations[$student3->id] = 1;
 
-        // Student 4 should be null as its enrolment timestart is after the this range.
-        $expectations[$student4->id] = null;
-
         $courseitem->gradepass = 50;
         $DB->update_record('grade_items', $courseitem);
 
@@ -460,12 +453,9 @@ public function test_core_target_course_gradetopass_calculate() {
         $method = $class->getMethod('calculate_sample');
         $method->setAccessible(true);
 
-        $starttime = mktime(0, 0, 0, 10, 24, 2015);
-
         // Verify all the expectations are fulfilled.
         foreach ($sampleids as $sampleid => $key) {
-            $this->assertEquals($expectations[$samplesdata[$key]['user']->id], $method->invoke($target, $sampleid,
-                $analysable, $starttime));
+            $this->assertEquals($expectations[$samplesdata[$key]['user']->id], $method->invoke($target, $sampleid, $analysable));
         }
     }
 }