MDL-64484 user: show full profile field name in filter element.
[moodle.git] / user / filters / profilefield.php
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/>.
17 /**
18  * Profile field filter.
19  *
20  * @package   core_user
21  * @category  user
22  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require_once($CFG->dirroot.'/user/filters/lib.php');
28 /**
29  * User filter based on values of custom profile fields.
30  *
31  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
32  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class user_filter_profilefield extends user_filter_type {
36     /**
37      * Constructor
38      * @param string $name the name of the filter instance
39      * @param string $label the label of the filter instance
40      * @param boolean $advanced advanced form element flag
41      */
42     public function __construct($name, $label, $advanced) {
43         parent::__construct($name, $label, $advanced);
44     }
46     /**
47      * Old syntax of class constructor. Deprecated in PHP7.
48      *
49      * @deprecated since Moodle 3.1
50      */
51     public function user_filter_profilefield($name, $label, $advanced) {
52         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
53         self::__construct($name, $label, $advanced);
54     }
56     /**
57      * Returns an array of comparison operators
58      * @return array of comparison operators
59      */
60     public function get_operators() {
61         return array(0 => get_string('contains', 'filters'),
62                      1 => get_string('doesnotcontain', 'filters'),
63                      2 => get_string('isequalto', 'filters'),
64                      3 => get_string('startswith', 'filters'),
65                      4 => get_string('endswith', 'filters'),
66                      5 => get_string('isempty', 'filters'),
67                      6 => get_string('isnotdefined', 'filters'),
68                      7 => get_string('isdefined', 'filters'));
69     }
71     /**
72      * Returns an array of custom profile fields
73      * @return array of profile fields
74      */
75     public function get_profile_fields() {
76         global $DB;
77         if (!$fields = $DB->get_records_menu('user_info_field', null, 'name', 'id, name')) {
78             return null;
79         }
80         $res = array(0 => get_string('anyfield', 'filters'));
82         return $res + $fields;
83     }
85     /**
86      * Adds controls specific to this filter in the form.
87      * @param object $mform a MoodleForm object to setup
88      */
89     public function setupForm(&$mform) {
90         $profilefields = $this->get_profile_fields();
91         if (empty($profilefields)) {
92             return;
93         }
94         $objs = array();
95         $objs['field'] = $mform->createElement('select', $this->_name.'_fld', null, $profilefields);
96         $objs['op'] = $mform->createElement('select', $this->_name.'_op', null, $this->get_operators());
97         $objs['value'] = $mform->createElement('text', $this->_name, null);
98         $objs['field']->setLabel(get_string('profilefilterfield', 'filters'));
99         $objs['op']->setLabel(get_string('profilefilterlimiter', 'filters'));
100         $objs['value']->setLabel(get_string('valuefor', 'filters', $this->_label));
101         $grp =& $mform->addElement('group', $this->_name.'_grp', $this->_label, $objs, '', false);
102         $mform->setType($this->_name, PARAM_RAW);
103         if ($this->_advanced) {
104             $mform->setAdvanced($this->_name.'_grp');
105         }
106     }
108     /**
109      * Retrieves data from the form data
110      * @param object $formdata data submited with the form
111      * @return mixed array filter data or false when filter not set
112      */
113     public function check_data($formdata) {
114         $profilefields = $this->get_profile_fields();
116         if (empty($profilefields)) {
117             return false;
118         }
120         $field    = $this->_name;
121         $operator = $field.'_op';
122         $profile  = $field.'_fld';
124         if (array_key_exists($profile, $formdata)) {
125             if ($formdata->$operator < 5 and $formdata->$field === '') {
126                 return false;
127             }
129             return array('value'    => (string)$formdata->$field,
130                          'operator' => (int)$formdata->$operator,
131                          'profile'  => (int)$formdata->$profile);
132         }
133     }
135     /**
136      * Returns the condition to be used with SQL where
137      * @param array $data filter settings
138      * @return array sql string and $params
139      */
140     public function get_sql_filter($data) {
141         global $CFG, $DB;
142         static $counter = 0;
143         $name = 'ex_profilefield'.$counter++;
145         $profilefields = $this->get_profile_fields();
146         if (empty($profilefields)) {
147             return '';
148         }
150         $profile  = $data['profile'];
151         $operator = $data['operator'];
152         $value    = $data['value'];
154         $params = array();
155         if (!array_key_exists($profile, $profilefields)) {
156             return array('', array());
157         }
159         $where = "";
160         $op = " IN ";
162         if ($operator < 5 and $value === '') {
163             return '';
164         }
166         switch($operator) {
167             case 0: // Contains.
168                 $where = $DB->sql_like('data', ":$name", false, false);
169                 $params[$name] = "%$value%";
170                 break;
171             case 1: // Does not contain.
172                 $where = $DB->sql_like('data', ":$name", false, false, true);
173                 $params[$name] = "%$value%";
174                 break;
175             case 2: // Equal to.
176                 $where = $DB->sql_like('data', ":$name", false, false);
177                 $params[$name] = "$value";
178                 break;
179             case 3: // Starts with.
180                 $where = $DB->sql_like('data', ":$name", false, false);
181                 $params[$name] = "$value%";
182                 break;
183             case 4: // Ends with.
184                 $where = $DB->sql_like('data', ":$name", false, false);
185                 $params[$name] = "%$value";
186                 break;
187             case 5: // Empty.
188                 $where = "data = :$name";
189                 $params[$name] = "";
190                 break;
191             case 6: // Is not defined.
192                 $op = " NOT IN ";
193                 break;
194             case 7: // Is defined.
195                 break;
196         }
197         if ($profile) {
198             if ($where !== '') {
199                 $where = " AND $where";
200             }
201             $where = "fieldid=$profile $where";
202         }
203         if ($where !== '') {
204             $where = "WHERE $where";
205         }
206         return array("id $op (SELECT userid FROM {user_info_data} $where)", $params);
207     }
209     /**
210      * Returns a human friendly description of the filter used as label.
211      * @param array $data filter settings
212      * @return string active filter label
213      */
214     public function get_label($data) {
215         $operators      = $this->get_operators();
216         $profilefields = $this->get_profile_fields();
218         if (empty($profilefields)) {
219             return '';
220         }
222         $profile  = $data['profile'];
223         $operator = $data['operator'];
224         $value    = $data['value'];
226         if (!array_key_exists($profile, $profilefields)) {
227             return '';
228         }
230         $a = new stdClass();
231         $a->label    = $this->_label;
232         $a->value    = $value;
233         $a->profile  = $profilefields[$profile];
234         $a->operator = $operators[$operator];
236         switch($operator) {
237             case 0: // Contains.
238             case 1: // Doesn't contain.
239             case 2: // Equal to.
240             case 3: // Starts with.
241             case 4: // Ends with.
242                 return get_string('profilelabel', 'filters', $a);
243             case 5: // Empty.
244             case 6: // Is not defined.
245             case 7: // Is defined.
246                 return get_string('profilelabelnovalue', 'filters', $a);
247         }
248         return '';
249     }