Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
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\filters;
20
 
21
use core_reportbuilder\local\helpers\database;
22
 
23
/**
24
 * Number report filter
25
 *
26
 * @package     core_reportbuilder
27
 * @copyright   2021 David Matamoros <davidmc@moodle.com>
28
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29
 */
30
class number extends base {
31
 
32
    /** @var int Any value */
33
    public const ANY_VALUE = 0;
34
 
35
    /** @var int Is not empty */
36
    public const IS_NOT_EMPTY = 1;
37
 
38
    /** @var int Is empty */
39
    public const IS_EMPTY = 2;
40
 
41
    /** @var int Less than */
42
    public const LESS_THAN = 3;
43
 
44
    /** @var int Greater than */
45
    public const GREATER_THAN = 4;
46
 
47
    /** @var int Equal to */
48
    public const EQUAL_TO = 5;
49
 
50
    /** @var int Equal or less than */
51
    public const EQUAL_OR_LESS_THAN = 6;
52
 
53
    /** @var int Equal or greater than */
54
    public const EQUAL_OR_GREATER_THAN = 7;
55
 
56
    /** @var int Range */
57
    public const RANGE = 8;
58
 
59
    /**
60
     * Returns an array of comparison operators
61
     *
62
     * @return array of comparison operators
63
     */
64
    private function get_operators(): array {
65
        $operators = [
66
            self::ANY_VALUE => get_string('filterisanyvalue', 'core_reportbuilder'),
67
            self::IS_NOT_EMPTY => get_string('filterisnotempty', 'core_reportbuilder'),
68
            self::IS_EMPTY => get_string('filterisempty', 'core_reportbuilder'),
69
            self::LESS_THAN => get_string('filterlessthan', 'core_reportbuilder'),
70
            self::GREATER_THAN => get_string('filtergreaterthan', 'core_reportbuilder'),
71
            self::EQUAL_TO => get_string('filterisequalto', 'core_reportbuilder'),
72
            self::EQUAL_OR_LESS_THAN => get_string('filterequalorlessthan', 'core_reportbuilder'),
73
            self::EQUAL_OR_GREATER_THAN => get_string('filterequalorgreaterthan', 'core_reportbuilder'),
74
            self::RANGE => get_string('filterrange', 'core_reportbuilder'),
75
        ];
76
 
77
        return $this->filter->restrict_limited_operators($operators);
78
    }
79
 
80
    /**
81
     * Adds controls specific to this filter in the form.
82
     *
83
     * @param \MoodleQuickForm $mform
84
     */
85
    public function setup_form(\MoodleQuickForm $mform): void {
86
        $objs = [];
87
 
88
        $objs['select'] = $mform->createElement('select', $this->name . '_operator',
89
            get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()), $this->get_operators());
90
        $mform->setType($this->name . '_operator', PARAM_INT);
91
 
92
        $objs['text'] = $mform->createElement('text', $this->name . '_value1',
93
            get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()), ['size' => 3]);
94
        $mform->setType($this->name . '_value1', PARAM_INT);
95
        $mform->setDefault($this->name . '_value1', 0);
96
        $mform->hideIf($this->name . '_value1', $this->name . '_operator', 'in',
97
            [self::ANY_VALUE,  self::IS_NOT_EMPTY,  self::IS_EMPTY]);
98
 
99
        $objs['text2'] = $mform->createElement('text', $this->name . '_value2',
100
            get_string('filterfieldto', 'reportbuilder', $this->get_header()), ['size' => 3]);
101
        $mform->setType($this->name . '_value2', PARAM_INT);
102
        $mform->setDefault($this->name . '_value2', 0);
103
        $mform->hideIf($this->name . '_value2', $this->name . '_operator', 'noteq', self::RANGE);
104
 
105
        $mform->addGroup($objs, $this->name . '_grp', $this->get_header(), '', false)
106
            ->setHiddenLabel(true);
107
    }
108
 
109
    /**
110
     * Return filter SQL
111
     *
112
     * @param array $values
113
     * @return array array of two elements - SQL query and named parameters
114
     */
115
    public function get_sql_filter(array $values): array {
116
        $operator = (int) ($values["{$this->name}_operator"] ?? self::ANY_VALUE);
117
 
118
        $value1 = $values["{$this->name}_value1"] ?? null;
119
        $value2 = $values["{$this->name}_value2"] ?? null;
120
 
121
        // Validate filter form values.
122
        if (!$this->validate_filter_values($operator, $value1, $value2)) {
123
            // Filter configuration is invalid. Ignore the filter.
124
            return ['', []];
125
        }
126
 
127
        [$param, $param2] = database::generate_param_names(2);
128
 
129
        $fieldsql = $this->filter->get_field_sql();
130
        $params = $this->filter->get_field_params();
131
 
132
        switch ($operator) {
133
            case self::ANY_VALUE:
134
                return ['', []];
135
            case self::IS_NOT_EMPTY:
136
                $res = "COALESCE({$fieldsql}, 0) <> 0";
137
                break;
138
            case self::IS_EMPTY:
139
                $res = "COALESCE({$fieldsql}, 0) = 0";
140
                break;
141
            case self::LESS_THAN:
142
                $res = "{$fieldsql} < :{$param}";
143
                $params[$param] = $value1;
144
                break;
145
            case self::GREATER_THAN:
146
                $res = "{$fieldsql} > :{$param}";
147
                $params[$param] = $value1;
148
                break;
149
            case self::EQUAL_TO:
150
                $res = "{$fieldsql} = :{$param}";
151
                $params[$param] = $value1;
152
                break;
153
            case self::EQUAL_OR_LESS_THAN:
154
                $res = "{$fieldsql} <= :{$param}";
155
                $params[$param] = $value1;
156
                break;
157
            case self::EQUAL_OR_GREATER_THAN:
158
                $res = "{$fieldsql} >= :{$param}";
159
                $params[$param] = $value1;
160
                break;
161
            case self::RANGE:
162
                $res = "{$fieldsql} BETWEEN :{$param} AND :{$param2}";
163
                $params[$param] = $value1;
164
                $params[$param2] = $value2;
165
                break;
166
            default:
167
                // Filter configuration is invalid. Ignore the filter.
168
                return ['', []];
169
        }
170
        return [$res, $params];
171
    }
172
 
173
    /**
174
     * Validate filter form values
175
     *
176
     * @param int $operator
177
     * @param int|null $value1
178
     * @param int|null $value2
179
     * @return bool
180
     */
181
    private function validate_filter_values(int $operator, ?int $value1, ?int $value2): bool {
182
        // Check that for any of these operators value1 can not be null.
183
        $requirescomparisonvalue = [
184
            self::LESS_THAN,
185
            self::GREATER_THAN,
186
            self::EQUAL_TO,
187
            self::EQUAL_OR_LESS_THAN,
188
            self::EQUAL_OR_GREATER_THAN
189
        ];
190
        if (in_array($operator, $requirescomparisonvalue) && $value1 === null) {
191
            return false;
192
        }
193
 
194
        // When operator is between $value1 and $value2, can not be null.
195
        if (($operator === self::RANGE) && ($value1 === null || $value2 === null)) {
196
            return false;
197
        }
198
 
199
        return true;
200
    }
201
 
202
    /**
203
     * Return sample filter values
204
     *
205
     * @return array
206
     */
207
    public function get_sample_values(): array {
208
        return [
209
            "{$this->name}_operator" => self::GREATER_THAN,
210
            "{$this->name}_value1" => 1,
211
        ];
212
    }
213
}