mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
/
category.php
93 lines (79 loc) · 3.28 KB
/
category.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<?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_reportbuilder\local\filters;
use core_course_category;
use MoodleQuickForm;
use core_reportbuilder\local\helpers\database;
/**
* Course category report filter
*
* The following optional array property can be passed to the {@see \core_reportbuilder\local\report\filter::set_options} method
* when defining this filter, to define the capabilities passed to {@see \core_course_category::make_categories_list}
*
* ['requiredcapabilities' => '...']
*
* @package core_reportbuilder
* @copyright 2022 Paul Holden <paulh@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class category extends base {
/**
* Setup form
*
* @param MoodleQuickForm $mform
*/
public function setup_form(MoodleQuickForm $mform): void {
$label = get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header());
// See MDL-74627: in order to set the default value to "No selection" we need to prepend an empty value.
$requiredcapabilities = $this->filter->get_options()['requiredcapabilities'] ?? '';
$categories = [0 => ''] + core_course_category::make_categories_list($requiredcapabilities);
$mform->addElement('autocomplete', "{$this->name}_value", $label, $categories)->setHiddenLabel(true);
$mform->addElement('advcheckbox', "{$this->name}_subcategories", get_string('viewallsubcategories'));
}
/**
* Return filter SQL
*
* @param array $values
* @return array
*/
public function get_sql_filter(array $values): array {
global $DB;
$fieldsql = $this->filter->get_field_sql();
$params = $this->filter->get_field_params();
$category = (int) ($values["{$this->name}_value"] ?? 0);
$subcategories = !empty($values["{$this->name}_subcategories"]);
// Invalid or inactive filter.
if (empty($category)) {
return ['', []];
}
// Initial matching on selected category.
$paramcategory = database::generate_param_name();
$params[$paramcategory] = $category;
$sql = "{$fieldsql} = :{$paramcategory}";
// Sub-category matching on path of selected category.
if ($subcategories) {
$paramcategorypath = database::generate_param_name();
$params[$paramcategorypath] = "%/{$category}/%";
$sql .= " OR {$fieldsql} IN (
SELECT id
FROM {course_categories}
WHERE " . $DB->sql_like('path', ":{$paramcategorypath}") . "
)";
}
return [$sql, $params];
}
}