user/filters/profilefield.php

   1 <?php //$Id$
   2
   3 require_once($CFG->dirroot . '/user/filters/lib.php');
   4
   5 /**
   6  * User filter based on values of custom profile fields.
   7  */
   8 class user_filter_profilefield extends user_filter_type {
   9     /**
  10      * operator used for comparison of data
  11      */
  12     var $_operator;
  13     /**
  14      * profile field to look at (0 - all fields)
  15      */
  16     var $_profile_field;
  17     /**
  18      * Constructor
  19      * @param string $name the name of the filter instance
  20      * @param string $label the label of the filter instance
  21      * @param string $field the field used for filtering data
  22      * @param string $value the value of the profile field (used for filtering data)
  23      * @param int $profile_field id of the profile field to look in
  24      * @param int $operator code of the comparison operator
  25      */
  26     function user_filter_profilefield($name, $label, $field='id', $value=null, $profile_field=0, $operator=0) {
  27         parent::user_filter_type($name, $label, $field, $value);
  28         $this->_operator = $operator;
  29         $this->_profile_field = $profile_field;
  30     }
  31
  32     /**
  33      * Returns an array of comparison operators
  34      * @return array of comparison operators
  35      */
  36     function getOperators() {
  37         return array(
  38             get_string('contains', 'filters'),
  39             get_string('doesnotcontain','filters'),
  40             get_string('isequalto','filters'),
  41             get_string('startswith','filters'),
  42             get_string('endswith','filters'),
  43             get_string('isempty','filters'),
  44             get_string('isnotdefined','filters'),
  45             get_string('isdefined','filters'),
  46         );
  47     }
  48
  49     /**
  50      * Returns an array of custom profile fields
  51      * @return array of profile fields
  52      */
  53     function getProfileFields() {
  54         $fields =& get_records_select('user_info_field', '', 'shortname', 'id,shortname');
  55         if(empty($fields)) {
  56             return null;
  57         }
  58         $res[0] = get_string('anyfield','filters');
  59         foreach($fields as $k=>$v) {
  60             $res[$k] = $v->shortname;
  61         }
  62         return $res;
  63     }
  64
  65     /**
  66      * Adds controls specific to this filter in the form.
  67      * @param object $mform a MoodleForm object to setup
  68      */
  69     function setupForm(&$mform) {
  70         $profile_fields =& $this->getProfileFields();
  71         if(empty($profile_fields)) {
  72             return;
  73         }
  74         $objs = array();
  75         $objs[] =& $mform->createElement('select', $this->_name . '_fld', null, $profile_fields);
  76         $objs[] =& $mform->createElement('select', $this->_name . '_op', null, $this->getOperators());
  77         $objs[] =& $mform->createElement('text', $this->_name, null);
  78         $grp =& $mform->addElement('group', $this->_name . '_grp', $this->_label, $objs, '', false);
  79         $grp->setHelpButton(array('profilefield','','filters'));
  80         $mform->setDefault($this->_name . '_fld', $this->_profile_field);
  81         $mform->setDefault($this->_name . '_op', $this->_operator);
  82         $mform->setDefault($this->_name, $this->_value);
  83     }
  84
  85     /**
  86      * Retrieves data from the form data
  87      * @param object $formdata data submited with the form
  88      */
  89     function checkData($formdata) {
  90         $field = $this->_name;
  91         $operator = $field . '_op';
  92         $profile_field = $field . '_fld';
  93         $this->_value = (string)@$formdata->$field;
  94         $this->_operator = (int)@$formdata->$operator;
  95         $this->_profile_field = (int)@$formdata->$profile_field;
  96     }
  97
  98     /**
  99      * Returns the condition to be used with SQL where
 100      * @return string the filtering condition or null if the filter is disabled
 101      */
 102     function getSQLFilter() {
 103         global $CFG;
 104         $where = '';
 105         $op = ' IN ';
 106         switch($this->_operator) {
 107         case 0: // contains
 108             if(empty($this->_value)) {
 109                 return null;
 110             }
 111             $where = 'data ' . sql_ilike(). ' "%' . $this->_value . '%"';
 112             break;
 113         case 1: // does not contain
 114             if(empty($this->_value)) {
 115                 return null;
 116             }
 117             $where = 'data NOT ' . sql_ilike(). ' "%' . $this->_value . '%"';
 118             break;
 119         case 2: // equal to
 120             if(empty($this->_value)) {
 121                 return null;
 122             }
 123             $where = 'data="' . $this->_value . '"';
 124             break;
 125         case 3: // starts with
 126             if(empty($this->_value)) {
 127                 return null;
 128             }
 129             $where = 'data ' . sql_ilike(). ' "' . $this->_value . '%"';
 130             break;
 131         case 4: // ends with
 132             if(empty($this->_value)) {
 133                 return null;
 134             }
 135             $where = 'data ' . sql_ilike(). ' "%' . $this->_value . '"';
 136             break;
 137         case 5: // empty
 138             $where = 'data=""';
 139             break;
 140         case 6: // is not defined
 141             $op = ' NOT IN ';
 142             break;
 143         case 7: // is defined
 144             break;
 145         }
 146         if(!empty($this->_profile_field)) {
 147             if(!empty($where)) {
 148                 $where = ' AND ' . $where;
 149             }
 150             $where = 'fieldid=' . $this->_profile_field . $where;
 151         }
 152         if(!empty($where)) {
 153             $where = ' WHERE ' . $where;
 154         }
 155         return $this->_field . $op . "(SELECT userid FROM {$CFG->prefix}user_info_data" . $where . ')';
 156     }
 157
 158     /**
 159      * Returns a human friendly description of the filter.
 160      * @return string filter description
 161      */
 162     function getDescription() {
 163         $res = '';
 164         $operators =& $this->getOperators();
 165         $profilefields =& $this->getProfileFields();
 166         switch($this->_operator) {
 167         case 0: // contains
 168         case 1: // doesn't contain
 169         case 2: // equal to
 170         case 3: // starts with
 171         case 4: // ends with
 172             $res = $this->_label . ': '. $profilefields[$this->_profile_field] . ' ' . $operators[$this->_operator]. ' "' . stripslashes($this->_value) . '"';
 173             break;
 174         case 5: // empty
 175         case 6: // is not defined
 176         case 7: // is defined
 177             $res = $this->_label . ': '. $profilefields[$this->_profile_field] . ' ' . $operators[$this->_operator];
 178             break;
 179         }
 180         return $res;
 181     }
 182 }