From e7b3185d416135dc8b0561fcd4d4e66623f9d72a Mon Sep 17 00:00:00 2001
From: PMKuipers <pm@miqra.nl>
Date: Mon, 29 May 2023 23:01:04 +0200
Subject: [PATCH] Started work on completionscanner for corecompletion teacher
 view

---
 classes/completionscanner.php | 121 ++++++++++++++++++++++++++++++++++
 1 file changed, 121 insertions(+)
 create mode 100644 classes/completionscanner.php

diff --git a/classes/completionscanner.php b/classes/completionscanner.php
new file mode 100644
index 0000000..47b6578
--- /dev/null
+++ b/classes/completionscanner.php
@@ -0,0 +1,121 @@
+<?php
+
+namespace local_treestudyplan;
+require_once($CFG->libdir.'/externallib.php');
+
+use \grade_item;
+
+// $gi->courseid, 
+// $gi->itemmodule, 
+// $gi->iteminstance
+class completionscanner 
+{
+    private static $mod_supported = [];
+    private static $course_students = [];
+    private $scanner = null;
+    private $course = null;
+    private $cm = null;
+    private $gi = null;
+    private $pending_cache = [];
+
+    public static function supported($mod){
+        if(!array_key_exists($mod,self::$mod_supported)){
+            self::$mod_supported[$mod] = class_exists("\local_treestudyplan\\local\\ungradedscanners\\{$mod}_scanner");
+        }
+        return self::$mod_supported[$mod];
+    }
+
+    public static function get_course_students($courseid){
+        global $CFG;
+        if(!array_key_exists($courseid,self::$course_students)){
+            $students = [];
+            $context = \context_course::instance($courseid);
+            foreach (explode(',', $CFG->gradebookroles) as $roleid) {
+                $roleid = trim($roleid);
+                $students = array_keys(get_role_users($roleid, $context, false, 'u.id', 'u.id ASC'));
+            }
+            self::$course_students[$courseid] = $students;
+        }
+        return self::$course_students[$courseid];
+    }
+
+    public function __construct($course,\completion_criteria $crit){
+        $this->course = $course;
+        $this->crit = $crit;
+        
+        // Find a related scanner if the type is an activity type
+        if($crit->criteriatype == COMPLETION_CRITERIA_TYPE_ACTIVITY){
+            // First find the course module
+            $modinfo = get_fast_modinfo($course);
+            $this->cm = $modinfo->get_cm($crit->moduleinstance);
+
+            $gi = grade_item::fetch(['itemtype' => 'mod', 'itemmodule' => $cm->mod, 'iteminstance' => $cm->id, 'courseid' => $course->id]);
+            if($gi !== false)
+            {
+                // Grade none items should not be relevant
+                // Note that the grade status is probably only relevant if the item has not yet received a completion, but has been submitted
+                if(($gi->gradetype == GRADE_TYPE_VALUE || $gi->gradetype == GRADE_TYPE_SCALE))
+                {
+                    // If it's a relevant grade type, initialize a scanner if possible
+                    $this->gi = gi;       
+                    if(self::supported($gi->itemmodule)) {
+                        $scannerclass = "\local_treestudyplan\\local\ungradedscanners\\{$gi->itemmodule}_scanner";
+                        $this->scanner = new $scannerclass($gi);
+                    }
+                }
+            }
+
+        }
+
+    }
+    
+
+    public function count_students(){
+        return count(self::get_course_students($this->gi->courseid));
+    }
+
+    public function count_ungraded(){
+        if($this->scanner === null) {
+            return -1;
+        }
+        return $this->scanner->count_ungraded(self::get_course_students($this->gi->courseid));
+    }
+
+    public function count_graded(){
+        if($this->scanner === null) {
+            return -1;
+        }
+        return $this->scanner->count_graded(self::get_course_students($this->gi->courseid));
+    }
+
+    public function pending($userid){
+        if(!array_key_exists($userid, $this->pending_cache)){
+            if($this->scanner === null) {
+                $this->pending_cache[$userid] = false;
+            }
+            else {
+                $this->pending_cache[$userid] = $this->scanner->has_ungraded_submission($userid);;    
+            }
+        }
+        return $this->pending_cache[$userid];
+    }    
+
+
+
+    public static function structure($value=VALUE_OPTIONAL){
+        return new \external_single_structure([
+            "ungraded" => new \external_value(PARAM_INT, 'number of ungraded submissions'),
+            "graded" => new \external_value(PARAM_INT, 'number of graded students'),
+            "students" => new \external_value(PARAM_INT, 'number of students that should submit'),
+        ],"details about gradable submissions",$value);
+    }
+
+    public function model(){
+        return [
+            'ungraded' => $this->count_ungraded(),
+            'graded' => $this->count_graded(),
+            'students' => $this->count_students(),
+        ];
+    }
+
+}
\ No newline at end of file