You are here

Home » API reference » Search API 7 » handler_filter_date.inc

class SearchApiViewsHandlerFilterDate in Search API 7

Views filter handler base class for handling date fields.

Hierarchy

Expanded class hierarchy of SearchApiViewsHandlerFilterDate

1 string reference to 'SearchApiViewsHandlerFilterDate'
_search_api_views_add_handlers in contrib/search_api_views/search_api_views.views.inc
Adds handler definitions for a field to a Views data table definition.

File

contrib/search_api_views/includes/handler_filter_date.inc, line 11
Contains SearchApiViewsHandlerFilterDate.

View source 
class SearchApiViewsHandlerFilterDate extends SearchApiViewsHandlerFilterNumeric {

  /**
   * Add a "widget type" option.
   */
  public function option_definition() {
    return parent::option_definition() + array(
      'widget_type' => array(
        'default' => 'default',
      ),
      'date_popup_format' => array(
        'default' => 'm/d/Y',
      ),
      'year_range' => array(
        'default' => '-3:+3',
      ),
    );
  }

  /**
   * If the date popup module is enabled, provide the extra option setting.
   */
  public function has_extra_options() {
    if (module_exists('date_popup')) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Add extra options if we allow the date popup widget.
   */
  public function extra_options_form(&$form, &$form_state) {
    parent::extra_options_form($form, $form_state);
    if (module_exists('date_popup')) {
      $widget_options = array(
        'default' => 'Default',
        'date_popup' => 'Date popup',
      );
      $form['widget_type'] = array(
        '#type' => 'radios',
        '#title' => t('Date selection form element'),
        '#default_value' => $this->options['widget_type'],
        '#options' => $widget_options,
      );
      $form['date_popup_format'] = array(
        '#type' => 'textfield',
        '#title' => t('Date format'),
        '#default_value' => $this->options['date_popup_format'],
        '#description' => t('A date in any format understood by <a href="@doc-link">PHP</a>. For example, "Y-m-d" or "m/d/Y".', array(
          '@doc-link' => 'http://php.net/manual/en/function.date.php',
        )),
        '#states' => array(
          'visible' => array(
            ':input[name="options[widget_type]"]' => array(
              'value' => 'date_popup',
            ),
          ),
        ),
      );
    }
    if (module_exists('date_api')) {
      $form['year_range'] = array(
        '#type' => 'date_year_range',
        '#default_value' => $this->options['year_range'],
      );
    }
  }

  /**
   * Validate extra options.
   */
  public function extra_options_validate($form, &$form_state) {
    if (isset($form_state['values']['options']['year_range'])) {
      if (!preg_match('/^(?:\\-[0-9]{1,4}|[0-9]{4}):(?:[\\+|\\-][0-9]{1,4}|[0-9]{4})$/', $form_state['values']['options']['year_range'])) {
        form_error($form['year_range'], t('Date year range must be in the format -9:+9, 2005:2010, -9:2010, or 2005:+9'));
      }
    }
  }

  /**
   * Provide a form for setting the filter value.
   */
  public function value_form(&$form, &$form_state) {
    parent::value_form($form, $form_state);
    $is_date_popup = $this->options['widget_type'] == 'date_popup' && module_exists('date_popup');

    // If the operator is between
    if ($this->operator == 'between') {
      if ($is_date_popup) {
        $form['value']['min']['#type'] = 'date_popup';
        $form['value']['min']['#date_format'] = $this->options['date_popup_format'];
        $form['value']['min']['#date_year_range'] = $this->options['year_range'];
        $form['value']['max']['#type'] = 'date_popup';
        $form['value']['max']['#date_format'] = $this->options['date_popup_format'];
        $form['value']['max']['#date_year_range'] = $this->options['year_range'];
      }
    }
    elseif ($is_date_popup) {

      // Add an "id" for the "value" field, since it is expected in
      // date_views_form_views_exposed_form_alter().
      // @see date_views_filter_handler_simple::value_form()
      $form['value']['#id'] = 'date_views_exposed_filter-' . bin2hex(drupal_random_bytes(16));
      $form['value']['#type'] = 'date_popup';
      $form['value']['#date_format'] = $this->options['date_popup_format'];
      $form['value']['#date_year_range'] = $this->options['year_range'];
      unset($form['value']['#description']);
    }
    elseif (empty($form_state['exposed'])) {
      $form['value']['#description'] = t('A date in any format understood by <a href="@doc-link">PHP</a>. For example, "@date1" or "@date2".', array(
        '@doc-link' => 'http://php.net/manual/en/function.strtotime.php',
        '@date1' => format_date(REQUEST_TIME, 'custom', 'Y-m-d H:i:s'),
        '@date2' => 'now + 1 day',
      ));
    }
  }

  /**
   * Add this filter to the query.
   */
  public function query() {
    $this
      ->normalizeValue();
    if ($this->operator === 'empty') {
      $this->query
        ->condition($this->real_field, NULL, '=', $this->options['group']);
    }
    elseif ($this->operator === 'not empty') {
      $this->query
        ->condition($this->real_field, NULL, '<>', $this->options['group']);
    }
    elseif (in_array($this->operator, array(
      'between',
      'not between',
    ), TRUE)) {
      $min = $this->value['min'];
      if ($min !== '') {
        $min = is_numeric($min) ? $min : strtotime($min, REQUEST_TIME);
      }
      $max = $this->value['max'];
      if ($max !== '') {
        $max = is_numeric($max) ? $max : strtotime($max, REQUEST_TIME);
      }
      if (is_numeric($min) && is_numeric($max)) {
        $this->query
          ->condition($this->real_field, array(
          $min,
          $max,
        ), strtoupper($this->operator), $this->options['group']);
      }
      elseif (is_numeric($min)) {
        $operator = $this->operator === 'between' ? '>=' : '<';
        $this->query
          ->condition($this->real_field, $min, $operator, $this->options['group']);
      }
      elseif (is_numeric($max)) {
        $operator = $this->operator === 'between' ? '<=' : '>';
        $this->query
          ->condition($this->real_field, $min, $operator, $this->options['group']);
      }
    }
    else {
      $v = is_numeric($this->value['value']) ? $this->value['value'] : strtotime($this->value['value'], REQUEST_TIME);
      if ($v !== FALSE) {
        $this->query
          ->condition($this->real_field, $v, $this->operator, $this->options['group']);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
SearchApiViewsHandlerFilter::$operator public property The operator used for filtering. Overrides views_handler_filter::$operator
SearchApiViewsHandlerFilter::$query public property The associated views query object. Overrides views_handler::$query 4
SearchApiViewsHandlerFilter::$value public property The value to filter for. Overrides views_handler_filter::$value
SearchApiViewsHandlerFilterDate::extra_options_form public function Add extra options if we allow the date popup widget. Overrides views_handler::extra_options_form
SearchApiViewsHandlerFilterDate::extra_options_validate public function Validate extra options. Overrides views_handler::extra_options_validate
SearchApiViewsHandlerFilterDate::has_extra_options public function If the date popup module is enabled, provide the extra option setting. Overrides views_handler::has_extra_options
SearchApiViewsHandlerFilterDate::option_definition public function Add a "widget type" option. Overrides SearchApiViewsHandlerFilterNumeric::option_definition
SearchApiViewsHandlerFilterDate::query public function Add this filter to the query. Overrides SearchApiViewsHandlerFilterNumeric::query
SearchApiViewsHandlerFilterDate::value_form public function Provide a form for setting the filter value. Overrides SearchApiViewsHandlerFilterNumeric::value_form
SearchApiViewsHandlerFilterNumeric::admin_summary public function Display the filter on the administrative summary Overrides SearchApiViewsHandlerFilter::admin_summary
SearchApiViewsHandlerFilterNumeric::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler_filter::init
SearchApiViewsHandlerFilterNumeric::normalizeValue protected function Sets $this->value to an array of options as defined by the filter.
SearchApiViewsHandlerFilterNumeric::operator_options public function Provide a list of options for the operator form. Overrides SearchApiViewsHandlerFilter::operator_options
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_filter::$always_multiple public property Disable the possibility to force a single value. 6
views_handler_filter::$always_required public property Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info public property Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator public property Disable the possibility to use operators. 2
views_handler_filter::accept_exposed_input public function Check to see if input from the exposed filters should change the behavior. Overrides views_handler::accept_exposed_input 2
views_handler_filter::build_group_form public function Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options public function Provide default options for exposed filters.
views_handler_filter::build_group_submit public function Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate public function Validate the build group options form. 1
views_handler_filter::can_build_group public function Determine if a filter can be converted into a group.
views_handler_filter::can_expose public function Determine if a filter can be exposed. Overrides views_handler::can_expose 5
views_handler_filter::can_group public function Can this filter be used in OR groups? 1
views_handler_filter::convert_exposed_input public function Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_form public function Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
views_handler_filter::exposed_info public function Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate public function Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_form public function Options form subform for exposed filter options. Overrides views_handler::expose_form 2
views_handler_filter::expose_options public function Provide default options for exposed filters. Overrides views_handler::expose_options 2
views_handler_filter::expose_validate public function Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form public function Build a form with a group of operator | values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input public function Options available for a grouped filter which uses checkboxes.
views_handler_filter::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input public function Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form public function Options form subform for setting the operator. 6
views_handler_filter::operator_submit public function Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate public function Validate the operator form.
views_handler_filter::options_form public function Provide the basic form which calls through to subforms. Overrides views_handler::options_form 4
views_handler_filter::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate public function Simple validate handler. Overrides views_handler::options_validate 1
views_handler_filter::prepare_filter_select_options public function Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button public function Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form public function Shortcut to display the exposed options form.
views_handler_filter::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form public function Shortcut to display the operator form.
views_handler_filter::show_value_form public function Shortcut to display the value form.
views_handler_filter::store_exposed_input public function Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input public function If set to remember exposed input in the session, store it there.
views_handler_filter::value_submit public function Perform any necessary changes to the form values prior to storage. 1
views_handler_filter::value_validate public function Validate the options form. 3
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function