user/filters/date.php

   1 <?php
   2
   3 require_once($CFG->dirroot.'/user/filters/lib.php');
   4
   5 /**
   6  * Generic filter based on a date.
   7  */
   8 class user_filter_date extends user_filter_type {
   9     /**
  10      * the fields available for comparisson
  11      */
  12     var $_field;
  13
  14     /**
  15      * Constructor
  16      * @param string $name the name of the filter instance
  17      * @param string $label the label of the filter instance
  18      * @param boolean $advanced advanced form element flag
  19      * @param string $field user table filed name
  20      */
  21     function user_filter_date($name, $label, $advanced, $field) {
  22         parent::user_filter_type($name, $label, $advanced);
  23         $this->_field = $field;
  24     }
  25
  26     /**
  27      * Adds controls specific to this filter in the form.
  28      * @param object $mform a MoodleForm object to setup
  29      */
  30     function setupForm(&$mform) {
  31         $objs = array();
  32
  33         $objs[] =& $mform->createElement('checkbox', $this->_name.'_sck', null, get_string('isafter', 'filters'));
  34         $objs[] =& $mform->createElement('date_selector', $this->_name.'_sdt', null);
  35         $objs[] =& $mform->createElement('static', $this->_name.'_break', null, '<br/>');
  36         $objs[] =& $mform->createElement('checkbox', $this->_name.'_eck', null, get_string('isbefore', 'filters'));
  37         $objs[] =& $mform->createElement('date_selector', $this->_name.'_edt', null);
  38
  39         $grp =& $mform->addElement('group', $this->_name.'_grp', $this->_label, $objs, '', false);
  40
  41         if ($this->_advanced) {
  42             $mform->setAdvanced($this->_name.'_grp');
  43         }
  44
  45         $mform->disabledIf($this->_name.'_sdt[day]', $this->_name.'_sck', 'notchecked');
  46         $mform->disabledIf($this->_name.'_sdt[month]', $this->_name.'_sck', 'notchecked');
  47         $mform->disabledIf($this->_name.'_sdt[year]', $this->_name.'_sck', 'notchecked');
  48         $mform->disabledIf($this->_name.'_edt[day]', $this->_name.'_eck', 'notchecked');
  49         $mform->disabledIf($this->_name.'_edt[month]', $this->_name.'_eck', 'notchecked');
  50         $mform->disabledIf($this->_name.'_edt[year]', $this->_name.'_eck', 'notchecked');
  51     }
  52
  53     /**
  54      * Retrieves data from the form data
  55      * @param object $formdata data submited with the form
  56      * @return mixed array filter data or false when filter not set
  57      */
  58     function check_data($formdata) {
  59         $sck = $this->_name.'_sck';
  60         $sdt = $this->_name.'_sdt';
  61         $eck = $this->_name.'_eck';
  62         $edt = $this->_name.'_edt';
  63
  64         if (!array_key_exists($sck, $formdata) and !array_key_exists($eck, $formdata)) {
  65             return false;
  66         }
  67
  68         $data = array();
  69         if (array_key_exists($sck, $formdata)) {
  70             $data['after'] = $formdata->$sdt;
  71         } else {
  72             $data['after'] = 0;
  73         }
  74         if (array_key_exists($eck, $formdata)) {
  75             $data['before'] = $formdata->$edt;
  76         } else {
  77             $data['before'] = 0;
  78         }
  79
  80         return $data;
  81     }
  82
  83     /**
  84      * Returns the condition to be used with SQL where
  85      * @param array $data filter settings
  86      * @return array sql string and $params
  87      */
  88     function get_sql_filter($data) {
  89         $after  = (int)$data['after'];
  90         $before = (int)$data['before'];
  91
  92         $field  = $this->_field;
  93
  94         if (empty($after) and empty($before)) {
  95             return array('', array());
  96         }
  97
  98         $res = " $field >= 0 " ;
  99
 100         if ($after) {
 101             $res .= " AND $field >= $after";
 102         }
 103
 104         if ($before) {
 105             $res .= " AND $field <= $before";
 106         }
 107         return array($res, array());
 108     }
 109
 110     /**
 111      * Returns a human friendly description of the filter used as label.
 112      * @param array $data filter settings
 113      * @return string active filter label
 114      */
 115     function get_label($data) {
 116         $after  = $data['after'];
 117         $before = $data['before'];
 118         $field  = $this->_field;
 119
 120         $a = new stdClass();
 121         $a->label  = $this->_label;
 122         $a->after  = userdate($after);
 123         $a->before = userdate($before);
 124
 125         if ($after and $before) {
 126             return get_string('datelabelisbetween', 'filters', $a);
 127         } else if ($after) {
 128             return get_string('datelabelisafter', 'filters', $a);
 129         } else if ($before) {
 130             return get_string('datelabelisbefore', 'filters', $a);
 131         }
 132         return '';
 133     }
 134 }