class InputRequired

Exposed form plugin that provides an exposed form with required input.

Plugin annotation


@Plugin(
  id = "input_required",
  title = @Translation("Input required"),
  help = @Translation("An exposed form that only renders a view if the form contains user input.")
)

Hierarchy

Expanded class hierarchy of InputRequired

Related topics

Views exposed form plugins
Plugins that handle the validation/submission and rendering of exposed forms.

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/exposed_form/InputRequired.php, line 24
Definition of Drupal\views\Plugin\views\exposed_form\InputRequired.

Namespace

Drupal\views\Plugin\views\exposed_form
View source
class InputRequired extends ExposedFormPluginBase {
  protected function defineOptions() {
    $options = parent::defineOptions();
    $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;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($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,
    );
  }
  public function submitOptionsForm(&$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::submitOptionsForm($form, $form_state);
  }
  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
            ->isExposed()) {
            $identifier = $filter->options['expose']['identifier'];
            if (isset($view->exposed_input[$identifier])) {
              $cache = TRUE;
              return $cache;
            }
          }
        }
      }
      $cache = FALSE;
    }
    return $cache;
  }
  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'],
      );
      $handler = views_get_handler('views', 'area', 'area');
      $handler
        ->init($this->view, $options);
      $this->displayHandler->handlers['empty'] = array(
        'area' => $handler,
      );
      $this->displayHandler
        ->setOption('empty', array(
        'text' => $options,
      ));
    }
  }
  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();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ExposedFormPluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
ExposedFormPluginBase::exposed_form_alter function
ExposedFormPluginBase::exposed_form_submit function This function is executed when exposed form is submited.
ExposedFormPluginBase::exposed_form_validate function
ExposedFormPluginBase::init public function Initialize the plugin.
ExposedFormPluginBase::postExecute public function
ExposedFormPluginBase::post_render function
ExposedFormPluginBase::pre_execute function
ExposedFormPluginBase::render_exposed_form function Render the exposed filter form.
ExposedFormPluginBase::reset_form function
InputRequired::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides ExposedFormPluginBase::buildOptionsForm
InputRequired::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides ExposedFormPluginBase::defineOptions
InputRequired::exposed_filter_applied function
InputRequired::pre_render function Overrides ExposedFormPluginBase::pre_render
InputRequired::query public function Add anything to the query that we might need to. Overrides ExposedFormPluginBase::query
InputRequired::submitOptionsForm public function Handle any special handling on the validate form. Overrides PluginBase::submitOptionsForm
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::validateOptionsForm public function Validate the options form. 11
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct