views_plugin_exposed_form_input_required.inc in Views (for Drupal 7) 7.3

Definition of views_plugin_exposed_form_input_required.

File

plugins/views_plugin_exposed_form_input_required.inc

<?php

/**
 * @file
 * Definition of views_plugin_exposed_form_input_required.
 */

/**
 * Exposed form plugin that provides an exposed form with required input.
 *
 * @ingroup views_exposed_form_plugins
 */
class views_plugin_exposed_form_input_required extends views_plugin_exposed_form {

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['text_input_required'] = array(
      'default' => 'Select any filter and click on Apply to see results',
      'translatable' => TRUE,
    );
    $options['text_input_required_format'] = array(
      'default' => NULL,
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['text_input_required'] = array(
      '#type' => 'text_format',
      '#title' => t('Text on demand'),
      '#description' => t('Text to display instead of results until the user selects and applies an exposed filter.'),
      '#default_value' => $this->options['text_input_required'],
      '#format' => isset($this->options['text_input_required_format']) ? $this->options['text_input_required_format'] : filter_default_format(),
      '#wysiwyg' => FALSE,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function options_submit(&$form, &$form_state) {
    $form_state['values']['exposed_form_options']['text_input_required_format'] = $form_state['values']['exposed_form_options']['text_input_required']['format'];
    $form_state['values']['exposed_form_options']['text_input_required'] = $form_state['values']['exposed_form_options']['text_input_required']['value'];
    parent::options_submit($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function exposed_filter_applied() {
    static $cache = NULL;
    if (!isset($cache)) {
      $view = $this->view;
      if (is_array($view->filter) && count($view->filter)) {
        foreach ($view->filter as $filter_id => $filter) {
          if ($filter
            ->is_exposed()) {
            $identifier = $filter->options['expose']['identifier'];
            if (isset($view->exposed_input[$identifier])) {
              $cache = TRUE;
              return $cache;
            }
          }
        }
      }
      $cache = FALSE;
    }
    return $cache;
  }

  /**
   * {@inheritdoc}
   */
  public function pre_render($values) {
    if (!$this
      ->exposed_filter_applied()) {
      $options = array(
        'id' => 'area',
        'table' => 'views',
        'field' => 'area',
        'label' => '',
        'relationship' => 'none',
        'group_type' => 'group',
        'content' => $this->options['text_input_required'],
        'format' => $this->options['text_input_required_format'],
        'empty' => TRUE,
      );
      $handler = views_get_handler('views', 'area', 'area');
      $handler
        ->init($this->view, $options);
      $this->display->handler->handlers['empty'] = array(
        'area' => $handler,
      );
      $this->display->handler
        ->set_option('empty', array(
        'text' => $options,
      ));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    if (!$this
      ->exposed_filter_applied()) {

      // We return with no query; this will force the empty text.
      $this->view->built = TRUE;
      $this->view->executed = TRUE;
      $this->view->result = array();
    }
    else {
      parent::query();
    }
  }

}

Classes

Name	Description
views_plugin_exposed_form_input_required	Exposed form plugin that provides an exposed form with required input.