Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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();
< $course = $courseentity->get_table_alias('course');
$this->add_entity($courseentity);
> $context = $courseentity->get_table_alias('context'); $this->set_main_table('course', $course); > $course = $courseentity->get_table_alias('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. // Join the enrolments entity. > $enrolentity = new enrol(); $enrolmententity = new enrolment(); > $enrol = $enrolentity->get_table_alias('enrol'); $userenrolment = $enrolmententity->get_table_alias('user_enrolments'); > $this->add_entity($enrolentity $enrol = $enrolmententity->get_table_alias('enrol'); > ->add_join("LEFT JOIN {enrol} {$enrol} ON {$enrol}.courseid = {$course}.id")); $enroljoin = "LEFT JOIN {enrol} {$enrol} ON {$enrol}.courseid = {$course}.id"; >
< $enrolmententity = new enrolment();
> $enrolmententity = (new enrolment()) > ->set_table_alias('enrol', $enrol);
< $enrol = $enrolmententity->get_table_alias('enrol'); < $enroljoin = "LEFT JOIN {enrol} {$enrol} ON {$enrol}.courseid = {$course}.id"; < $userenrolmentjoin = " LEFT JOIN {user_enrolments} {$userenrolment} ON {$userenrolment}.enrolid = {$enrol}.id"; < $enrolmententity->add_joins([$enroljoin, $userenrolmentjoin]); < $this->add_entity($enrolmententity);
> $this->add_entity($enrolmententity > ->add_joins($enrolentity->get_joins()) > ->add_join("LEFT JOIN {user_enrolments} {$userenrolment} ON {$userenrolment}.enrolid = {$enrol}.id"));
$user = $userentity->get_table_alias('user');
< $userentity->add_joins($enrolmententity->get_joins()); < $userentity->add_join("LEFT JOIN {user} {$user} ON {$userenrolment}.userid = {$user}.id AND {$user}.deleted = 0"); < $this->add_entity($userentity);
> $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', $courseentity->get_table_alias('context'));
> ->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")
> ON {$groups}.courseid = {$course}.id AND {$groups}.userid = {$user}.id")
); // Join completion entity.
< $completionentity = new completion();
> $completionentity = (new completion()) > ->set_table_aliases([ > 'course' => $course, > 'user' => $user, > ]);
$completion = $completionentity->get_table_alias('course_completion');
< $completionentity->add_joins($userentity->get_joins()); < $completionentity->add_join("
> $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 < "); < $completionentity->set_table_alias('user', $user); < $this->add_entity($completionentity);
> ON {$completion}.course = {$course}.id AND {$completion}.userid = {$user}.id") > );
// Join course access entity.
< $accessentity = new access();
> $accessentity = (new access()) > ->set_table_alias('user', $user);
$lastaccess = $accessentity->get_table_alias('user_lastaccess');
< $accessentity->add_joins($userentity->get_joins()); < $accessentity->add_join("
> $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 < "); < $this->add_entity($accessentity);
> 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',
< 'enrolment:method',
'user:fullnamewithlink',
> 'enrol:name', ]; > ]; } > } > /** > /** * Return the filters that will be added to the report once is created > * Return the column sorting that will be added to the report upon creation * > * * @return string[] > * @return int[] */ > */ public function get_default_filters(): array { > public function get_default_column_sorting(): array { return [ > return [ 'user:suspended', > 'course:coursefullnamewithlink' => SORT_ASC, 'user:confirmed', > 'user:fullnamewithlink' => SORT_ASC, ]; > 'enrol:name' => SORT_ASC,
} /** * 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,