| 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\aggregation;
|
|
|
20 |
|
|
|
21 |
use lang_string;
|
|
|
22 |
use core_reportbuilder\local\report\column;
|
|
|
23 |
|
|
|
24 |
/**
|
|
|
25 |
* Column sum aggregation type
|
|
|
26 |
*
|
|
|
27 |
* @package core_reportbuilder
|
|
|
28 |
* @copyright 2021 Paul Holden <paulh@moodle.com>
|
|
|
29 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
30 |
*/
|
|
|
31 |
class sum extends base {
|
|
|
32 |
|
|
|
33 |
/**
|
|
|
34 |
* Return aggregation name
|
|
|
35 |
*
|
|
|
36 |
* @return lang_string
|
|
|
37 |
*/
|
|
|
38 |
public static function get_name(): lang_string {
|
|
|
39 |
return new lang_string('aggregationsum', 'core_reportbuilder');
|
|
|
40 |
}
|
|
|
41 |
|
|
|
42 |
/**
|
|
|
43 |
* This aggregation can be performed on all numeric and boolean columns
|
|
|
44 |
*
|
|
|
45 |
* @param int $columntype
|
|
|
46 |
* @return bool
|
|
|
47 |
*/
|
|
|
48 |
public static function compatible(int $columntype): bool {
|
|
|
49 |
return in_array($columntype, [
|
|
|
50 |
column::TYPE_INTEGER,
|
|
|
51 |
column::TYPE_FLOAT,
|
|
|
52 |
column::TYPE_BOOLEAN,
|
|
|
53 |
]);
|
|
|
54 |
}
|
|
|
55 |
|
|
|
56 |
/**
|
|
|
57 |
* Return the aggregated field SQL
|
|
|
58 |
*
|
|
|
59 |
* @param string $field
|
|
|
60 |
* @param int $columntype
|
|
|
61 |
* @return string
|
|
|
62 |
*/
|
|
|
63 |
public static function get_field_sql(string $field, int $columntype): string {
|
|
|
64 |
return "SUM({$field})";
|
|
|
65 |
}
|
|
|
66 |
|
|
|
67 |
/**
|
|
|
68 |
* Return formatted value for column when applying aggregation
|
|
|
69 |
*
|
|
|
70 |
* For boolean columns we return the sum of the true values, numeric columns execute original callbacks if present
|
|
|
71 |
*
|
|
|
72 |
* @param mixed $value
|
|
|
73 |
* @param array $values
|
|
|
74 |
* @param array $callbacks
|
|
|
75 |
* @param int $columntype
|
|
|
76 |
* @return mixed
|
|
|
77 |
*/
|
|
|
78 |
public static function format_value($value, array $values, array $callbacks, int $columntype) {
|
|
|
79 |
$firstvalue = reset($values);
|
|
|
80 |
if ($firstvalue === null) {
|
|
|
81 |
return null;
|
|
|
82 |
}
|
|
|
83 |
if ($columntype === column::TYPE_BOOLEAN || empty($callbacks)) {
|
|
|
84 |
$decimalpoints = (int) ($columntype === column::TYPE_FLOAT);
|
|
|
85 |
return format_float((float) $firstvalue, $decimalpoints);
|
|
|
86 |
}
|
|
|
87 |
|
|
|
88 |
return parent::format_value($value, $values, $callbacks, $columntype);
|
|
|
89 |
}
|
|
|
90 |
}
|