first commit

course/classes/reportbuilder/datasource/categories.php

@@ -0,0 +1,134 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+declare(strict_types=1);
+
+namespace core_course\reportbuilder\datasource;
+
+use core_cohort\reportbuilder\local\entities\cohort;
+use core_course\reportbuilder\local\entities\course_category;
+use core_reportbuilder\datasource;
+use core_reportbuilder\local\entities\{course, user};
+use core_role\reportbuilder\local\entities\role;
+
+/**
+ * Course categories datasource
+ *
+ * @package     core_course
+ * @copyright   2023 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class categories extends datasource {
+
+    /**
+     * Return user friendly name of the datasource
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('coursecategories');
+    }
+
+    /**
+     * Initialise report
+     */
+    protected function initialise(): void {
+        $categoryentity = new course_category();
+
+        $categoryalias = $categoryentity->get_table_alias('course_categories');
+        $contextalias = $categoryentity->get_table_alias('context');
+
+        $this->set_main_table('course_categories', $categoryalias);
+        $this->add_entity($categoryentity);
+
+        // Join course entity.
+        $courseentity = new course();
+        $coursealias = $courseentity->get_table_alias('course');
+        $this->add_entity($courseentity
+            ->add_join("LEFT JOIN {course} {$coursealias} ON {$coursealias}.category = {$categoryalias}.id"));
+
+        // Join cohort entity (indicate context table join alias).
+        $cohortentity = (new cohort())
+            ->set_table_join_alias('context', $contextalias);
+        $cohort = $cohortentity->get_table_alias('cohort');
+        $this->add_entity($cohortentity
+            ->add_join($categoryentity->get_context_join())
+            ->add_join("LEFT JOIN {cohort} {$cohort} ON {$cohort}.contextid = {$contextalias}.id"));
+
+        // Join role entity.
+        $roleentity = (new role())
+            ->set_table_alias('context', $contextalias);
+        $role = $roleentity->get_table_alias('role');
+        $this->add_entity($roleentity
+            ->add_join($categoryentity->get_context_join())
+            ->add_join("LEFT JOIN {role_assignments} ras ON ras.contextid = {$contextalias}.id")
+            ->add_join("LEFT JOIN {role} {$role} ON {$role}.id = ras.roleid"));
+
+        // Join user entity.
+        $userentity = new user();
+        $user = $userentity->get_table_alias('user');
+        $this->add_entity($userentity
+            ->add_joins($roleentity->get_joins())
+            ->add_join("LEFT JOIN {user} {$user} ON {$user}.id = ras.userid"));
+
+        // Add all elements from entities to be available in custom reports.
+        $this->add_all_from_entities();
+    }
+
+    /**
+     * Return the columns that will be added to the report as part of default setup
+     *
+     * @return string[]
+     */
+    public function get_default_columns(): array {
+        return [
+            'course_category:name',
+            'course_category:idnumber',
+            'course_category:coursecount',
+        ];
+    }
+
+    /**
+     * Return the default sorting that will be added to the report as part of default setup
+     *
+     * @return int[]
+     */
+    public function get_default_column_sorting(): array {
+        return [
+            'course_category:name' => SORT_ASC,
+        ];
+    }
+
+    /**
+     * Return the filters that will be added to the report as part of default setup
+     *
+     * @return string[]
+     */
+    public function get_default_filters(): array {
+        return [
+            'course_category:name',
+        ];
+    }
+
+    /**
+     * Return the conditions that will be added to the report as part of default setup
+     *
+     * @return string[]
+     */
+    public function get_default_conditions(): array {
+        return [];
+    }
+}

course/classes/reportbuilder/datasource/courses.php

@@ -0,0 +1,149 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+declare(strict_types=1);
+
+namespace core_course\reportbuilder\datasource;
+
+use core_course\reportbuilder\local\entities\course_category;
+use core_files\reportbuilder\local\entities\file;
+use core_reportbuilder\datasource;
+use core_reportbuilder\local\entities\course;
+use core_reportbuilder\local\helpers\database;
+use core_tag\reportbuilder\local\entities\tag;
+use lang_string;
+
+/**
+ * Courses datasource
+ *
+ * @package     core_course
+ * @copyright   2021 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class courses extends datasource {
+
+    /**
+     * Return user friendly name of the datasource
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('courses');
+    }
+
+    /**
+     * Initialise report
+     */
+    protected function initialise(): void {
+        $courseentity = new course();
+        $coursetablealias = $courseentity->get_table_alias('course');
+
+        // Exclude site course.
+        $paramsiteid = database::generate_param_name();
+
+        $this->set_main_table('course', $coursetablealias);
+        $this->add_base_condition_sql("{$coursetablealias}.id != :{$paramsiteid}", [$paramsiteid => SITEID]);
+
+        $this->add_entity($courseentity);
+
+        // Join the course category entity.
+        $coursecatentity = new course_category();
+        $coursecattablealias = $coursecatentity->get_table_alias('course_categories');
+        $this->add_entity($coursecatentity
+            ->add_join("JOIN {course_categories} {$coursecattablealias}
+                ON {$coursecattablealias}.id = {$coursetablealias}.category"));
+
+        // Join the tag entity.
+        $tagentity = (new tag())
+            ->set_table_alias('tag', $courseentity->get_table_alias('tag'));
+        $this->add_entity($tagentity
+            ->add_joins($courseentity->get_tag_joins()));
+
+        // Join the files entity.
+        $contextalias = $courseentity->get_table_alias('context');
+        $fileentity = (new file())
+            ->set_entity_title(new lang_string('courseoverviewfiles'));
+        $filesalias = $fileentity->get_table_alias('files');
+        $this->add_entity($fileentity
+            ->add_join($courseentity->get_context_join())
+            ->add_join("LEFT JOIN {files} {$filesalias}
+                ON {$filesalias}.contextid = {$contextalias}.id
+               AND {$filesalias}.component = 'course'
+               AND {$filesalias}.filearea = 'overviewfiles'
+               AND {$filesalias}.itemid = 0
+               AND {$filesalias}.filename != '.'"));
+
+        // Add all columns/filters/conditions from entities to be available in custom reports.
+        $this->add_all_from_entity($coursecatentity->get_entity_name());
+        $this->add_all_from_entity($courseentity->get_entity_name());
+
+        // Add specific tag entity elements.
+        $this->add_columns_from_entity($tagentity->get_entity_name(), ['name', 'namewithlink']);
+        $this->add_filter($tagentity->get_filter('name'));
+        $this->add_condition($tagentity->get_condition('name'));
+
+        // Add specific file entity elements.
+        $this->add_columns_from_entity($fileentity->get_entity_name(), ['name', 'size', 'type', 'timecreated']);
+        $this->add_filters_from_entity($fileentity->get_entity_name(), ['name', 'size', 'timecreated']);
+        $this->add_conditions_from_entity($fileentity->get_entity_name(), ['name', 'size', 'timecreated']);
+
+    }
+
+    /**
+     * Return the columns that will be added to the report as part of default setup
+     *
+     * @return string[]
+     */
+    public function get_default_columns(): array {
+        return [
+            'course_category:name',
+            'course:shortname',
+            'course:fullname',
+            'course:idnumber',
+        ];
+    }
+
+    /**
+     * Return the filters that will be added to the report once is created
+     *
+     * @return string[]
+     */
+    public function get_default_filters(): array {
+        return ['course_category:name', 'course:fullname', 'course:idnumber'];
+    }
+
+    /**
+     * Return the conditions that will be added to the report once is created
+     *
+     * @return string[]
+     */
+    public function get_default_conditions(): array {
+        return ['course_category:name'];
+    }
+
+    /**
+     * Return the default sorting that will be added to the report once it is created
+     *
+     * @return array|int[]
+     */
+    public function get_default_column_sorting(): array {
+        return [
+            'course_category:name' => SORT_ASC,
+            'course:shortname' => SORT_ASC,
+            'course:fullname' => SORT_ASC,
+        ];
+    }
+}

course/classes/reportbuilder/datasource/participants.php

@@ -0,0 +1,215 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+declare(strict_types=1);
+
+namespace core_course\reportbuilder\datasource;
+
+use core_course\reportbuilder\local\entities\course_category;
+use core_course\reportbuilder\local\entities\access;
+use core_course\reportbuilder\local\entities\completion;
+use core_course\reportbuilder\local\entities\enrolment;
+use core_enrol\reportbuilder\local\entities\enrol;
+use core_group\reportbuilder\local\entities\group;
+use core_reportbuilder\datasource;
+use core_reportbuilder\local\entities\course;
+use core_reportbuilder\local\entities\user;
+use core_reportbuilder\local\filters\select;
+use core_reportbuilder\local\helpers\database;
+use core_role\reportbuilder\local\entities\role;
+use core_user\output\status_field;
+
+/**
+ * Course participants datasource
+ *
+ * @package     core_course
+ * @copyright   2022 David Matamoros <davidmc@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class participants extends datasource {
+
+    /**
+     * Initialise report
+     */
+    protected function initialise(): void {
+        $courseentity = new course();
+        $this->add_entity($courseentity);
+
+        $context = $courseentity->get_table_alias('context');
+        $course = $courseentity->get_table_alias('course');
+        $this->set_main_table('course', $course);
+
+        // Exclude site course.
+        $paramsiteid = database::generate_param_name();
+        $this->add_base_condition_sql("{$course}.id != :{$paramsiteid}", [$paramsiteid => SITEID]);
+
+        // Join the course category entity.
+        $coursecatentity = new course_category();
+        $categories = $coursecatentity->get_table_alias('course_categories');
+        $this->add_entity($coursecatentity
+            ->add_join("JOIN {course_categories} {$categories} ON {$categories}.id = {$course}.category"));
+
+        // Join the enrolment method entity.
+        $enrolentity = new enrol();
+        $enrol = $enrolentity->get_table_alias('enrol');
+        $this->add_entity($enrolentity
+            ->add_join("LEFT JOIN {enrol} {$enrol} ON {$enrol}.courseid = {$course}.id"));
+
+        // Join the enrolments entity.
+        $enrolmententity = (new enrolment())
+            ->set_table_alias('enrol', $enrol);
+        $userenrolment = $enrolmententity->get_table_alias('user_enrolments');
+        $this->add_entity($enrolmententity
+            ->add_joins($enrolentity->get_joins())
+            ->add_join("LEFT JOIN {user_enrolments} {$userenrolment} ON {$userenrolment}.enrolid = {$enrol}.id"));
+
+        // Join user entity.
+        $userentity = new user();
+        $user = $userentity->get_table_alias('user');
+        $this->add_entity($userentity
+            ->add_joins($enrolmententity->get_joins())
+            ->add_join("LEFT JOIN {user} {$user} ON {$user}.id = {$userenrolment}.userid AND {$user}.deleted = 0"));
+
+        // Join the role entity.
+        $roleentity = (new role())
+            ->set_table_alias('context', $context);
+        $role = $roleentity->get_table_alias('role');
+        $this->add_entity($roleentity
+            ->add_joins($userentity->get_joins())
+            ->add_join($courseentity->get_context_join())
+            ->add_join("LEFT JOIN {role_assignments} ras ON ras.contextid = {$context}.id AND ras.userid = {$user}.id")
+            ->add_join("LEFT JOIN {role} {$role} ON {$role}.id = ras.roleid")
+        );
+
+        // Join group entity.
+        $groupentity = (new group())
+            ->set_table_alias('context', $context);
+        $groups = $groupentity->get_table_alias('groups');
+
+        // Sub-select for all course group members.
+        $groupsinnerselect = "
+            SELECT grs.*, grms.userid
+              FROM {groups} grs
+              JOIN {groups_members} grms ON grms.groupid = grs.id";
+
+        $this->add_entity($groupentity
+            ->add_join($courseentity->get_context_join())
+            ->add_joins($userentity->get_joins())
+            ->add_join("
+                LEFT JOIN ({$groupsinnerselect}) {$groups}
+                       ON {$groups}.courseid = {$course}.id AND {$groups}.userid = {$user}.id")
+        );
+
+        // Join completion entity.
+        $completionentity = (new completion())
+            ->set_table_aliases([
+                'course' => $course,
+                'user' => $user,
+            ]);
+        $completion = $completionentity->get_table_alias('course_completion');
+        $this->add_entity($completionentity
+            ->add_joins($userentity->get_joins())
+            ->add_join("
+                LEFT JOIN {course_completions} {$completion}
+                       ON {$completion}.course = {$course}.id AND {$completion}.userid = {$user}.id")
+        );
+
+        // Join course access entity.
+        $accessentity = (new access())
+            ->set_table_alias('user', $user);
+        $lastaccess = $accessentity->get_table_alias('user_lastaccess');
+        $this->add_entity($accessentity
+            ->add_joins($userentity->get_joins())
+            ->add_join("
+                LEFT JOIN {user_lastaccess} {$lastaccess}
+                       ON {$lastaccess}.userid = {$user}.id AND {$lastaccess}.courseid = {$course}.id"));
+
+        // Add all entities columns/filters/conditions.
+        $this->add_all_from_entities();
+    }
+
+    /**
+     * Return user friendly name of the datasource
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('courseparticipants', 'course');
+    }
+
+    /**
+     * Return the columns that will be added to the report as part of default setup
+     *
+     * @return string[]
+     */
+    public function get_default_columns(): array {
+        return [
+            'course:coursefullnamewithlink',
+            'user:fullnamewithlink',
+            'enrol:name',
+        ];
+    }
+
+    /**
+     * Return the column sorting that will be added to the report upon creation
+     *
+     * @return int[]
+     */
+    public function get_default_column_sorting(): array {
+        return [
+            'course:coursefullnamewithlink' => SORT_ASC,
+            'user:fullnamewithlink' => SORT_ASC,
+            'enrol:name' => SORT_ASC,
+        ];
+    }
+
+    /**
+     * Return the filters that will be added to the report once is created
+     *
+     * @return string[]
+     */
+    public function get_default_filters(): array {
+        return [
+            'user:suspended',
+            'user:confirmed',
+        ];
+    }
+
+    /**
+     * Return the conditions that will be added to the report once is created
+     *
+     * @return string[]
+     */
+    public function get_default_conditions(): array {
+        return [
+            'enrolment:status',
+            'user:suspended',
+            'user:confirmed',
+        ];
+    }
+
+    /**
+     * Return the condition values that will be set for the report upon creation
+     *
+     * @return array
+     */
+    public function get_default_condition_values(): array {
+        return [
+            'enrolment:status_operator' => select::EQUAL_TO,
+            'enrolment:status_value' => status_field::STATUS_ACTIVE,
+        ];
+    }
+}