mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-20 07:30:01 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-72353' of https://github.com/paulholden/moodle

Browse Source
This commit is contained in:
Ilya Tregubov 2024-05-07 09:06:55 +08:00
commit 2b951ed07a
3 changed files with 9 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
lib/classes/report_helper.php
View File

@ -14,24 +14,16 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Report plugins helper class
*
* @package core
* @subpackage report
* @copyright 2021 Sujith Haridasan
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core;
use context_course;
use moodle_url;
use stdClass;
/**
* A helper class with static methods to help report plugins
*
* @package core
* @subpackage report
* @copyright 2021 Sujith Haridasan
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@ -93,24 +85,11 @@ class report_helper {
}
/**
* Save the last selected report in the session
*
* @deprecated since Moodle 4.0
* @param int $id The course id
* @param moodle_url $url The moodle url
* @return void
*/
public static function save_selected_report(int $id, moodle_url $url): void {
global $USER;
debugging('save_selected_report() has been deprecated because it is no longer used and will be '.
'removed in future versions of Moodle', DEBUG_DEVELOPER);
// Last selected report.
if (!isset($USER->course_last_report)) {
$USER->course_last_report = [];
}
$USER->course_last_report[$id] = $url;
#[\core\attribute\deprecated(null, reason: 'It is no longer used', since: '4.0', final: true)]
public static function save_selected_report() {
\core\deprecation::emit_deprecation_if_present([self::class, __FUNCTION__]);
}
/**

78
lib/tests/report_helper_test.php
View File

@ -1,78 +0,0 @@
<?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/>.
/**
* Tests for report_helper.
*
* @package core
* @category test
* @copyright 2021 Sujith Haridasan
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core;
use moodle_url;
use core\report_helper;
/**
* Tests the functions for report_helper class.
*/
class report_helper_test extends \advanced_testcase {
/**
* Data provider for testing selected report for same and different courses
*
* @return array
*/
public function data_selected_report(): array {
return [
['course_url_id' => [
['url' => '/test', 'id' => 1],
['url' => '/foo', 'id' => 1]]
],
['course_url_id' => [
['url' => '/test', 'id' => 1],
['url' => '/foo/bar', 'id' => 2]]
]
];
}
/**
* Testing selected report saved in $USER session.
*
* @dataProvider data_selected_report
* @param array $courseurlid The array has both course url and course id
*/
public function test_save_selected_report(array $courseurlid): void {
global $USER;
$url1 = new moodle_url($courseurlid[0]['url']);
$courseid1 = $courseurlid[0]['id'];
report_helper::save_selected_report($courseid1, $url1);
$this->assertDebuggingCalled('save_selected_report() has been deprecated because it is no ' .
'longer used and will be removed in future versions of Moodle');
$this->assertEquals($USER->course_last_report[$courseid1], $url1);
$url2 = new moodle_url($courseurlid[1]['url']);
$courseid2 = $courseurlid[1]['id'];
report_helper::save_selected_report($courseid2, $url2);
$this->assertDebuggingCalled('save_selected_report() has been deprecated because it is no ' .
'longer used and will be removed in future versions of Moodle');
$this->assertEquals($USER->course_last_report[$courseid2], $url2);
}
}

4
report/upgrade.txt
View File

@ -1,6 +1,10 @@
This files describes API changes in /report/* - plugins,
information provided here is intended especially for developers.
=== 4.5 ===
* The previously deprecated `report_helper::save_selected_report` method has been removed
=== 4.2 ===
* The method report_progress\local\helper::get_activities_to_show() has an additional parameter $activitysection