| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
declare(strict_types=1);
|
|
|
18 |
|
|
|
19 |
namespace core_reportbuilder\local\helpers;
|
|
|
20 |
|
|
|
21 |
use stdClass;
|
|
|
22 |
|
|
|
23 |
/**
|
|
|
24 |
* Class containing helper methods for formatting column data via callbacks
|
|
|
25 |
*
|
|
|
26 |
* @package core_reportbuilder
|
|
|
27 |
* @copyright 2021 Sara Arjona <sara@moodle.com> based on Alberto Lara Hernández <albertolara@moodle.com> code.
|
|
|
28 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
29 |
*/
|
|
|
30 |
class format {
|
|
|
31 |
|
|
|
32 |
/**
|
|
|
33 |
* Returns formatted date.
|
|
|
34 |
*
|
|
|
35 |
* @param int|null $value Unix timestamp
|
|
|
36 |
* @param stdClass $row
|
|
|
37 |
* @param string|null $format Format string for strftime
|
|
|
38 |
* @return string
|
|
|
39 |
*/
|
|
|
40 |
public static function userdate(?int $value, stdClass $row, ?string $format = null): string {
|
|
|
41 |
return $value ? userdate($value, $format) : '';
|
|
|
42 |
}
|
|
|
43 |
|
|
|
44 |
/**
|
| 1441 |
ariadna |
45 |
* Returns formatted time duration (e.g. "3 days 4 hours")
|
|
|
46 |
*
|
|
|
47 |
* @param float|null $value
|
|
|
48 |
* @param stdClass $row
|
|
|
49 |
* @param int|null $precision
|
|
|
50 |
* @return string
|
|
|
51 |
*/
|
|
|
52 |
public static function format_time(?float $value, stdClass $row, ?int $precision = 0): string {
|
|
|
53 |
if ($value === null) {
|
|
|
54 |
return '';
|
|
|
55 |
}
|
|
|
56 |
$value = round($value, (int) $precision);
|
|
|
57 |
if ($value === 0.0) {
|
|
|
58 |
return '0 ' . get_string('secs', 'moodle');
|
|
|
59 |
}
|
|
|
60 |
return format_time($value);
|
|
|
61 |
}
|
|
|
62 |
|
|
|
63 |
/**
|
| 1 |
efrain |
64 |
* Returns yes/no string depending on the given value
|
|
|
65 |
*
|
|
|
66 |
* @param bool|null $value
|
|
|
67 |
* @return string
|
|
|
68 |
*/
|
|
|
69 |
public static function boolean_as_text(?bool $value): string {
|
|
|
70 |
if ($value === null) {
|
|
|
71 |
return '';
|
|
|
72 |
}
|
|
|
73 |
return $value ? get_string('yes') : get_string('no');
|
|
|
74 |
}
|
|
|
75 |
|
|
|
76 |
/**
|
|
|
77 |
* Returns float value as a percentage
|
|
|
78 |
*
|
|
|
79 |
* @param float|null $value
|
|
|
80 |
* @return string
|
|
|
81 |
*/
|
|
|
82 |
public static function percent(?float $value): string {
|
|
|
83 |
if ($value === null) {
|
|
|
84 |
return '';
|
|
|
85 |
}
|
|
|
86 |
return get_string('percents', 'moodle', format_float($value));
|
|
|
87 |
}
|
|
|
88 |
}
|