views_handler_filter_date.inc

<?php


/**
 * @file
 * Definition of views_handler_filter_date.
 */

/**
 * Filter to handle dates stored as a timestamp.
 *
 * @ingroup views_filter_handlers
 */
class views_handler_filter_date extends views_handler_filter_numeric {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        // Value is already set up properly, we're just adding our new field to it.
        $options['value']['contains']['type']['default'] = 'date';
        return $options;
    }
    
    /**
     * Add a type selector to the value form.
     */
    public function value_form(&$form, &$form_state) {
        if (empty($form_state['exposed'])) {
            $form['value']['type'] = array(
                '#type' => 'radios',
                '#title' => t('Value type'),
                '#options' => array(
                    'date' => t('A date in any machine readable format. CCYY-MM-DD HH:MM:SS is preferred.'),
                    'offset' => t('An offset from the current time such as "!example1" or "!example2"', array(
                        '!example1' => '+1 day',
                        '!example2' => '-2 hours -30 minutes',
                    )),
                ),
                '#default_value' => !empty($this->value['type']) ? $this->value['type'] : 'date',
            );
        }
        parent::value_form($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_validate(&$form, &$form_state) {
        parent::options_validate($form, $form_state);
        if (!empty($this->options['exposed']) && empty($form_state['values']['options']['expose']['required'])) {
            // Who cares what the value is if it's exposed and non-required.
            return;
        }
        $this->validate_valid_time($form['value'], $form_state['values']['options']['operator'], $form_state['values']['options']['value']);
    }
    
    /**
     * {@inheritdoc}
     */
    public function exposed_validate(&$form, &$form_state) {
        if (empty($this->options['exposed'])) {
            return;
        }
        if (empty($this->options['expose']['required'])) {
            // Who cares what the value is if it's exposed and non-required.
            return;
        }
        $value =& $form_state['values'][$this->options['expose']['identifier']];
        if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id'])) {
            $operator = $form_state['values'][$this->options['expose']['operator_id']];
        }
        else {
            $operator = $this->operator;
        }
        $this->validate_valid_time($this->options['expose']['identifier'], $operator, $value);
    }
    
    /**
     * Validate that the time values convert to something usable.
     */
    public function validate_valid_time(&$form, $operator, $value) {
        $operators = $this->operators();
        if ($operators[$operator]['values'] == 1) {
            $convert = strtotime($value['value']);
            if (!empty($form['value']) && ($convert == -1 || $convert === FALSE)) {
                form_error($form['value'], t('Invalid date format.'));
            }
        }
        elseif ($operators[$operator]['values'] == 2) {
            $min = strtotime($value['min']);
            if ($min == -1 || $min === FALSE) {
                form_error($form['min'], t('Invalid date format.'));
            }
            $max = strtotime($value['max']);
            if ($max == -1 || $max === FALSE) {
                form_error($form['max'], t('Invalid date format.'));
            }
        }
    }
    
    /**
     * Validate the build group options form.
     */
    public function build_group_validate($form, &$form_state) {
        // Special case to validate grouped date filters, this is because the
        // $group['value'] array contains the type of filter (date or offset)
        // and therefore the number of items the comparission has to be done
        // against 'one' instead of 'zero'.
        foreach ($form_state['values']['options']['group_info']['group_items'] as $id => $group) {
            if (empty($group['remove'])) {
                // Check if the title is defined but value wasn't defined.
                if (!empty($group['title'])) {
                    if (!is_array($group['value']) && empty($group['value']) || is_array($group['value']) && count(array_filter($group['value'])) == 1) {
                        form_error($form['group_info']['group_items'][$id]['value'], t('The value is required if title for this item is defined.'));
                    }
                }
                // Check if the value is defined but title wasn't defined.
                if (!is_array($group['value']) && !empty($group['value']) || is_array($group['value']) && count(array_filter($group['value'])) > 1) {
                    if (empty($group['title'])) {
                        form_error($form['group_info']['group_items'][$id]['title'], t('The title is required if value for this item is defined.'));
                    }
                }
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function accept_exposed_input($input) {
        if (empty($this->options['exposed'])) {
            return TRUE;
        }
        // Store this because it will get overwritten.
        $type = '';
        if (is_array($this->value)) {
            $type = $this->value['type'];
        }
        $rc = parent::accept_exposed_input($input);
        // Don't filter if value(s) are empty.
        $operators = $this->operators();
        if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id'])) {
            $operator = $input[$this->options['expose']['operator_id']];
        }
        else {
            $operator = $this->operator;
        }
        if ($operators[$operator]['values'] == 1) {
            if ($this->value['value'] == '') {
                return FALSE;
            }
        }
        elseif ($operators[$operator]['values'] == 2) {
            if ($this->value['min'] == '' || $this->value['max'] == '') {
                return FALSE;
            }
        }
        // Restore what got overwritten by the parent.
        if (is_array($this->value)) {
            $this->value['type'] = $type;
        }
        return $rc;
    }
    
    /**
     *
     */
    public function op_between($field) {
        // Use the substitutions to ensure a consistent timestamp.
        $query_substitutions = views_views_query_substitutions($this->view);
        $a = intval(strtotime($this->value['min'], $query_substitutions['***CURRENT_TIME***']));
        $b = intval(strtotime($this->value['max'], $query_substitutions['***CURRENT_TIME***']));
        // This is safe because we are manually scrubbing the values. It is
        // necessary to do it this way because $a and $b are formulas when using an
        // offset.
        $operator = strtoupper($this->operator);
        $this->query
            ->add_where_expression($this->options['group'], "{$field} {$operator} {$a} AND {$b}");
    }
    
    /**
     *
     */
    public function op_simple($field) {
        // Use the substitutions to ensure a consistent timestamp.
        $query_substitutions = views_views_query_substitutions($this->view);
        $value = intval(strtotime($this->value['value'], $query_substitutions['***CURRENT_TIME***']));
        // This is safe because we are manually scrubbing the value. It is
        // necessary to do it this way because $value is a formula when using an
        // offset.
        $this->query
            ->add_where_expression($this->options['group'], "{$field} {$this->operator} {$value}");
    }

}