Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.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_comment\reportbuilder\datasource;

> use core\reportbuilder\local\entities\context;
use core_reportbuilder\datasource; use core_reportbuilder\local\entities\user; use core_comment\reportbuilder\local\entities\comment; /** * Comments datasource * * @package core_comment * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class comments extends datasource { /** * Return user friendly name of the report source * * @return string */ public static function get_name(): string { return get_string('comments', 'core_comment'); } /** * Initialise report */ protected function initialise(): void { $commententity = new comment(); $commentalias = $commententity->get_table_alias('comments'); $this->set_main_table('comments', $commentalias);
<
$this->add_entity($commententity);
> // Join the context entity. // Join the user entity to the comment userid (author). > $contextentity = (new context()) $userentity = new user(); > ->set_table_alias('context', $commententity->get_table_alias('context')); $useralias = $userentity->get_table_alias('user'); > $this->add_entity($contextentity $this->add_entity($userentity > ->add_join($commententity->get_context_join()) ->add_join("LEFT JOIN {user} {$useralias} ON {$useralias}.id = {$commentalias}.userid")); > ); >
// Add report elements from each of the entities we added to the report. $this->add_all_from_entities(); } /** * Return the columns that will be added to the report upon creation * * @return string[] */ public function get_default_columns(): array { return [
< 'comment:context', < 'comment:content',
'user:fullname',
> 'context:name', 'comment:timecreated', > 'comment:content',
];
> ]; } > } > /** > /** * Return the filters that will be added to the report upon creation > * 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 [ 'comment:content', > 'user:fullname' => SORT_ASC, ]; > 'comment:timecreated' => SORT_ASC,
} /** * Return the conditions that will be added to the report upon creation * * @return string[] */ public function get_default_conditions(): array { return [ 'user:fullname', ]; } }