L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Huong Nguyen
2024-07-24 12:10:28 +07:00
parent 86968a64a5 c10610d035
commit 83a18b6f58
10 changed files with 76 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.upgradenotes/MDL-82466-2024071510553022.yml
+7
View File
@@ -0,0 +1,7 @@
issueNumber: MDL-82466
notes:
core_reportbuilder:
- message: >
New format helper `format_time` method, for use in column callbacks that
represent a duration of time (e.g. "3 days 4 hours")
type: improved
admin/classes/reportbuilder/local/entities/task_log.php
+1 -9
View File
@@ -183,15 +183,7 @@ class task_log extends base {
->set_type(column::TYPE_FLOAT)
->add_field("{$tablealias}.timeend - {$tablealias}.timestart", 'duration')
->set_is_sortable(true)
->add_callback(static function(float $value): string {
$duration = round($value, 2);
if (empty($duration)) {
// The format_time function returns 'now' when the difference is exactly 0.
// Note: format_time performs concatenation in exactly this fashion so we should do this for consistency.
return '0 ' . get_string('secs', 'moodle');
}
return format_time($duration);
});
->add_callback([format::class, 'format_time'], 2);
// Hostname column.
$columns[] = (new column(
course/classes/reportbuilder/local/entities/completion.php
+7 -5
View File
@@ -224,7 +224,7 @@ class completion extends base {
$currenttime = time();
$columns[] = (new column(
'dayscourse',
new lang_string('daystakingcourse', 'course'),
new lang_string('daystakingcourse', 'completion'),
$this->get_entity_name()
))
->add_joins($this->get_joins())
@@ -236,9 +236,10 @@ class completion extends base {
{$coursecompletion}.timecompleted
ELSE
{$currenttime}
END - {$course}.startdate) / " . DAYSECS . "
END - {$course}.startdate)
END)", 'dayscourse')
->set_is_sortable(true);
->set_is_sortable(true)
->set_callback([format::class, 'format_time']);
// Days since last completion (days since last enrolment date until completion or until current date if not completed).
$columns[] = (new column(
@@ -255,9 +256,10 @@ class completion extends base {
{$coursecompletion}.timecompleted
ELSE
{$currenttime}
END - {$coursecompletion}.timeenrolled) / " . DAYSECS . "
END - {$coursecompletion}.timeenrolled)
END)", 'daysuntilcompletion')
->set_is_sortable(true);
->set_is_sortable(true)
->set_callback([format::class, 'format_time']);
// Student course grade.
$columns[] = (new column(
course/tests/reportbuilder/datasource/participants_test.php
+3 -3
View File
@@ -235,8 +235,8 @@ final class participants_test extends core_reportbuilder_testcase {
'', // Time started.
userdate($timecompleted), // Time completed.
'', // Reagreggate.
2, // Days taking course.
2, // Days until completion.
'2 days', // Days taking course.
'2 days', // Days until completion.
'42.50', // Grade.
], array_values($content[0]));
}
@@ -310,7 +310,7 @@ final class participants_test extends core_reportbuilder_testcase {
$content = $this->get_custom_report_content($report->get('id'));
$this->assertEquals([
[$courseone->fullname, '2.5'],
[$courseone->fullname, '2 days 12 hours'],
[$coursetwo->fullname, ''],
], array_map('array_values', $content));
}
enrol/classes/reportbuilder/local/entities/enrol.php
+3 -4
View File
@@ -145,12 +145,11 @@ class enrol extends base {
->set_type(column::TYPE_TIMESTAMP)
->add_fields("{$enrolalias}.enrolperiod")
->set_is_sortable(true)
->set_callback(static function(?int $enrolperiod): string {
if (!$enrolperiod) {
->set_callback(static function(?int $enrolperiod, stdClass $row): string {
if ($enrolperiod === 0) {
return '';
}
return format_time($enrolperiod);
return format::format_time($enrolperiod, $row);
});
// Start date column.
lang/en/completion.php
+2 -1
View File
@@ -140,7 +140,8 @@ $string['csvdownload'] = 'Download in spreadsheet format (UTF-8 .csv)';
$string['datepassed'] = 'Date passed';
$string['days'] = 'Days';
$string['daysoftotal'] = '{$a->days} of {$a->total}';
$string['daysuntilcompletion'] = 'Days until completion';
$string['daystakingcourse'] = 'Time taking course';
$string['daysuntilcompletion'] = 'Time until completion';
$string['defaultactivitycompletionsite'] = 'These are the default completion conditions for activities in all courses.';
$string['defaultactivitycompletioncourse'] = 'These are the default completion conditions for activities in this course.';
$string['defaultcompletion'] = 'Default activity completion';
lang/en/course.php
+3 -1
View File
@@ -85,7 +85,6 @@ $string['customfield_visibility_help'] = 'This setting determines who can view t
$string['customfield_visibletoall'] = 'Everyone';
$string['customfield_visibletoteachers'] = 'Teachers';
$string['customfieldsettings'] = 'Common course custom fields settings';
$string['daystakingcourse'] = 'Days taking course';
$string['defaultsettingscategory'] = 'Default settings';
$string['downloadcourseconfirmation'] = 'You are about to download a zip file of course content (excluding items which cannot be downloaded and any files larger than {$a}).';
$string['downloadcoursecontent'] = 'Download course content';
@@ -167,3 +166,6 @@ $string['gotosection'] = 'Go to section {$a}';
// Deprecated since Moodle 4.3.
$string['aria:courseimage'] = 'Course image';
// Deprecated since Moodle 4.5.
$string['daystakingcourse'] = 'Days taking course';
lang/en/deprecated.txt
+1
View File
@@ -116,6 +116,7 @@ coursecalendar,core_calendar
importcalendarexternal,core_calendar
nocalendarsubscriptions,core_calendar
datechanged,core
daystakingcourse,core_course
siteregistrationcontact,core_hub
siteregistrationcontact_help,core_hub
registrationcontactno,core
reportbuilder/classes/local/helpers/format.php
+19
View File
@@ -41,6 +41,25 @@ class format {
return $value ? userdate($value, $format) : '';
}
/**
* Returns formatted time duration (e.g. "3 days 4 hours")
*
* @param float|null $value
* @param stdClass $row
* @param int|null $precision
* @return string
*/
public static function format_time(?float $value, stdClass $row, ?int $precision = 0): string {
if ($value === null) {
return '';
}
$value = round($value, (int) $precision);
if ($value === 0.0) {
return '0 ' . get_string('secs', 'moodle');
}
return format_time($value);
}
/**
* Returns yes/no string depending on the given value
*
reportbuilder/tests/local/helpers/format_test.php
+30 -3
View File
@@ -29,7 +29,7 @@ use stdClass;
* @copyright 2021 Paul Holden <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class format_test extends advanced_testcase {
final class format_test extends advanced_testcase {
/**
* Test userdate method
@@ -41,12 +41,39 @@ class format_test extends advanced_testcase {
$this->assertEquals(userdate($now), $userdate);
}
/**
* Data provider for {@see test_format_time}
*
* @return array[]
*/
public static function format_time_provider(): array {
return [
[null, 0, ''],
[0, 0, '0 secs'],
[2.456, 1, '2.5 secs'],
[3.2, null, '3 secs'],
];
}
/**
* Test format time
*
* @param float|null $value
* @param int|null $precision
* @param string $expected
*
* @dataProvider format_time_provider
*/
public function test_format_time(?float $value, ?int $precision, string $expected): void {
$this->assertEquals($expected, format::format_time($value, (object) [], $precision));
}
/**
* Data provider for {@see test_boolean_as_text}
*
* @return array
* @return array[]
*/
public function boolean_as_text_provider(): array {
public static function boolean_as_text_provider(): array {
return [
[false, get_string('no')],
[true, get_string('yes')],