MDL-65276 core: fix CiBoT complains
[moodle.git] / lib / classes / task / completion_regular_task.php
index 3edea82..40d4572 100644 (file)
@@ -51,10 +51,11 @@ class completion_regular_task extends scheduled_task {
 
             // Process each criteria type.
             foreach ($COMPLETION_CRITERIA_TYPES as $type) {
-                $object = 'completion_criteria_'.$type;
-                require_once $CFG->dirroot.'/completion/criteria/'.$object.'.php';
+                $object = 'completion_criteria_' . $type;
+                require_once($CFG->dirroot . '/completion/criteria/' . $object . '.php');
+
                 $class = new $object();
-                // Run the criteria type's cron method, if it has one
+                // Run the criteria type's cron method, if it has one.
                 if (method_exists($class, 'cron')) {
                     if (debugging()) {
                         mtrace('Running '.$object.'->cron()');
@@ -66,132 +67,132 @@ class completion_regular_task extends scheduled_task {
             if (debugging()) {
                 mtrace('Aggregating completions');
             }
-            // Save time started
+
+            // Save time started.
             $timestarted = time();
-            // Grab all criteria and their associated criteria completions
-            $sql = '
-                SELECT DISTINCT
-                    c.id AS course,
-                    cr.id AS criteriaid,
-                    crc.userid AS userid,
-                    cr.criteriatype AS criteriatype,
-                    cc.timecompleted AS timecompleted
-                FROM
-                    {course_completion_criteria} cr
-                INNER JOIN
-                    {course} c
-                 ON cr.course = c.id
-                INNER JOIN
-                    {course_completions} crc
-                 ON crc.course = c.id
-                LEFT JOIN
-                    {course_completion_crit_compl} cc
-                 ON cc.criteriaid = cr.id
-                AND crc.userid = cc.userid
-                WHERE
-                    c.enablecompletion = 1
-                AND crc.timecompleted IS NULL
-                AND crc.reaggregate > 0
-                AND crc.reaggregate < :timestarted
-                ORDER BY
-                    course,
-                    userid
-            ';
-            $rs = $DB->get_recordset_sql($sql, array('timestarted' => $timestarted));
-            // Check if result is empty
+
+            // Grab all criteria and their associated criteria completions.
+            $sql = 'SELECT DISTINCT c.id AS course, cr.id AS criteriaid, crc.userid AS userid,
+                                    cr.criteriatype AS criteriatype, cc.timecompleted AS timecompleted
+                      FROM {course_completion_criteria} cr
+                INNER JOIN {course} c ON cr.course = c.id
+                INNER JOIN {course_completions} crc ON crc.course = c.id
+                 LEFT JOIN {course_completion_crit_compl} cc ON cc.criteriaid = cr.id AND crc.userid = cc.userid
+                     WHERE c.enablecompletion = 1
+                       AND crc.timecompleted IS NULL
+                       AND crc.reaggregate > 0
+                       AND crc.reaggregate < :timestarted
+                  ORDER BY course, userid';
+            $rs = $DB->get_recordset_sql($sql, ['timestarted' => $timestarted]);
+
+            // Check if result is empty.
             if (!$rs->valid()) {
-                $rs->close(); // Not going to iterate (but exit), close rs
+                $rs->close();
                 return;
             }
-            $current_user = null;
-            $current_course = null;
-            $completions = array();
+
+            $currentuser = null;
+            $currentcourse = null;
+            $completions = [];
             while (1) {
-                // Grab records for current user/course
+                // Grab records for current user/course.
                 foreach ($rs as $record) {
-                    // If we are still grabbing the same users completions
-                    if ($record->userid === $current_user && $record->course === $current_course) {
+                    // If we are still grabbing the same users completions.
+                    if ($record->userid === $currentuser && $record->course === $currentcourse) {
                         $completions[$record->criteriaid] = $record;
                     } else {
                         break;
                     }
                 }
-                // Aggregate
+
+                // Aggregate.
                 if (!empty($completions)) {
                     if (debugging()) {
-                        mtrace('Aggregating completions for user '.$current_user.' in course '.$current_course);
+                        mtrace('Aggregating completions for user ' . $currentuser . ' in course ' . $currentcourse);
                     }
-                    // Get course info object
-                    $info = new \completion_info((object)array('id' => $current_course));
-                    // Setup aggregation
+
+                    // Get course info object.
+                    $info = new \completion_info((object)['id' => $currentcourse]);
+
+                    // Setup aggregation.
                     $overall = $info->get_aggregation_method();
                     $activity = $info->get_aggregation_method(COMPLETION_CRITERIA_TYPE_ACTIVITY);
                     $prerequisite = $info->get_aggregation_method(COMPLETION_CRITERIA_TYPE_COURSE);
                     $role = $info->get_aggregation_method(COMPLETION_CRITERIA_TYPE_ROLE);
-                    $overall_status = null;
-                    $activity_status = null;
-                    $prerequisite_status = null;
-                    $role_status = null;
-                    // Get latest timecompleted
+
+                    $overallstatus = null;
+                    $activitystatus = null;
+                    $prerequisitestatus = null;
+                    $rolestatus = null;
+
+                    // Get latest timecompleted.
                     $timecompleted = null;
-                    // Check each of the criteria
+
+                    // Check each of the criteria.
                     foreach ($completions as $params) {
                         $timecompleted = max($timecompleted, $params->timecompleted);
                         $completion = new \completion_criteria_completion((array)$params, false);
-                        // Handle aggregation special cases
+
+                        // Handle aggregation special cases.
                         if ($params->criteriatype == COMPLETION_CRITERIA_TYPE_ACTIVITY) {
-                            completion_cron_aggregate($activity, $completion->is_complete(), $activity_status);
+                            completion_cron_aggregate($activity, $completion->is_complete(), $activitystatus);
                         } else if ($params->criteriatype == COMPLETION_CRITERIA_TYPE_COURSE) {
-                            completion_cron_aggregate($prerequisite, $completion->is_complete(), $prerequisite_status);
+                            completion_cron_aggregate($prerequisite, $completion->is_complete(), $prerequisitestatus);
                         } else if ($params->criteriatype == COMPLETION_CRITERIA_TYPE_ROLE) {
-                            completion_cron_aggregate($role, $completion->is_complete(), $role_status);
+                            completion_cron_aggregate($role, $completion->is_complete(), $rolestatus);
                         } else {
-                            completion_cron_aggregate($overall, $completion->is_complete(), $overall_status);
+                            completion_cron_aggregate($overall, $completion->is_complete(), $overallstatus);
                         }
                     }
-                    // Include role criteria aggregation in overall aggregation
-                    if ($role_status !== null) {
-                        completion_cron_aggregate($overall, $role_status, $overall_status);
+
+                    // Include role criteria aggregation in overall aggregation.
+                    if ($rolestatus !== null) {
+                        completion_cron_aggregate($overall, $rolestatus, $overallstatus);
                     }
-                    // Include activity criteria aggregation in overall aggregation
-                    if ($activity_status !== null) {
-                        completion_cron_aggregate($overall, $activity_status, $overall_status);
+
+                    // Include activity criteria aggregation in overall aggregation.
+                    if ($activitystatus !== null) {
+                        completion_cron_aggregate($overall, $activitystatus, $overallstatus);
                     }
-                    // Include prerequisite criteria aggregation in overall aggregation
-                    if ($prerequisite_status !== null) {
-                        completion_cron_aggregate($overall, $prerequisite_status, $overall_status);
+
+                    // Include prerequisite criteria aggregation in overall aggregation.
+                    if ($prerequisitestatus !== null) {
+                        completion_cron_aggregate($overall, $prerequisitestatus, $overallstatus);
                     }
-                    // If aggregation status is true, mark course complete for user
-                    if ($overall_status) {
+
+                    // If aggregation status is true, mark course complete for user.
+                    if ($overallstatus) {
                         if (debugging()) {
                             mtrace('Marking complete');
                         }
-                        $ccompletion = new \completion_completion(array('course' => $params->course, 'userid' => $params->userid));
+
+                        $ccompletion = new \completion_completion([
+                            'course' => $params->course,
+                            'userid' => $params->userid
+                        ]);
                         $ccompletion->mark_complete($timecompleted);
                     }
                 }
-                // If this is the end of the recordset, break the loop
+
+                // If this is the end of the recordset, break the loop.
                 if (!$rs->valid()) {
                     $rs->close();
                     break;
                 }
-                // New/next user, update user details, reset completions
-                $current_user = $record->userid;
-                $current_course = $record->course;
-                $completions = array();
+
+                // New/next user, update user details, reset completions.
+                $currentuser = $record->userid;
+                $currentcourse = $record->course;
+                $completions = [];
                 $completions[$record->criteriaid] = $record;
             }
-            // Mark all users as aggregated
-            $sql = "
-                UPDATE
-                    {course_completions}
-                SET
-                    reaggregate = 0
-                WHERE
-                    reaggregate < :timestarted
-                AND reaggregate > 0
-            ";
-            $DB->execute($sql, array('timestarted' => $timestarted));
+
+            // Mark all users as aggregated.
+            $sql = "UPDATE {course_completions}
+                       SET reaggregate = 0
+                     WHERE reaggregate < :timestarted
+                       AND reaggregate > 0";
+            $DB->execute($sql, ['timestarted' => $timestarted]);
         }
     }