class InputRequired in Drupal 10

Same name and namespace in other branches

8 core/modules/views/src/Plugin/views/exposed_form/InputRequired.php \Drupal\views\Plugin\views\exposed_form\InputRequired
9 core/modules/views/src/Plugin/views/exposed_form/InputRequired.php \Drupal\views\Plugin\views\exposed_form\InputRequired

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

Plugin annotation


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

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginBase implements CacheableDependencyInterface, ExposedFormPluginInterface
    class \Drupal\views\Plugin\views\exposed_form\InputRequired

Expanded class hierarchy of InputRequired

File

core/modules/views/src/Plugin/views/exposed_form/InputRequired.php, line 19

Namespace

Drupal\views\Plugin\views\exposed_form

View source

class InputRequired extends ExposedFormPluginBase {
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['text_input_required'] = [
      'default' => $this
        ->t('Select any filter and click on Apply to see results'),
    ];
    $options['text_input_required_format'] = [
      'default' => NULL,
    ];
    return $options;
  }
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['text_input_required'] = [
      '#type' => 'text_format',
      '#title' => $this
        ->t('Text on demand'),
      '#description' => $this
        ->t('Text to display instead of results until the user selects and applies an exposed filter.'),
      '#default_value' => $this->options['text_input_required'],
      '#format' => $this->options['text_input_required_format'] ?? filter_default_format(),
      '#editor' => FALSE,
    ];
  }
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {
    $exposed_form_options = $form_state
      ->getValue('exposed_form_options');
    $form_state
      ->setValue([
      'exposed_form_options',
      'text_input_required_format',
    ], $exposed_form_options['text_input_required']['format']);
    $form_state
      ->setValue([
      'exposed_form_options',
      'text_input_required',
    ], $exposed_form_options['text_input_required']['value']);
    parent::submitOptionsForm($form, $form_state);
  }
  protected function exposedFilterApplied() {
    static $cache = NULL;
    if (!isset($cache)) {
      $view = $this->view;
      if (is_array($view->filter) && count($view->filter)) {
        foreach ($view->filter as $filter) {
          if ($filter
            ->isExposed()) {
            $identifier = $filter->options['expose']['identifier'];
            if (isset($view
              ->getExposedInput()[$identifier])) {
              $cache = TRUE;
              return $cache;
            }
          }
        }
      }
      $cache = FALSE;
    }
    return $cache;
  }
  public function preRender($values) {

    // Display the "text on demand" if needed. This is a site builder-defined
    // text to display instead of results until the user selects and applies
    // an exposed filter.
    if (!$this
      ->exposedFilterApplied()) {
      $options = [
        'id' => 'area',
        'table' => 'views',
        'field' => 'area',
        'label' => '',
        'relationship' => 'none',
        'group_type' => 'group',
        // We need to set the "Display even if view has no result" option to
        // TRUE as the input required exposed form plugin will always force an
        // empty result if no exposed filters are applied.
        'empty' => TRUE,
        'content' => [
          // @see \Drupal\views\Plugin\views\area\Text::render()
          'value' => $this->options['text_input_required'],
          'format' => $this->options['text_input_required_format'],
        ],
      ];
      $handler = Views::handlerManager('area')
        ->getHandler($options);
      $handler
        ->init($this->view, $this->displayHandler, $options);
      $this->displayHandler->handlers['empty'] = [
        'area' => $handler,
      ];

      // Override the existing empty result message (if applicable).
      $this->displayHandler
        ->setOption('empty', [
        'text' => $options,
      ]);
    }
  }
  public function query() {
    if (!$this
      ->exposedFilterApplied()) {

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

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
ExposedFormPluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
ExposedFormPluginBase::exposedFormAlter	public	function	Alters the exposed form. Overrides ExposedFormPluginInterface::exposedFormAlter
ExposedFormPluginBase::exposedFormSubmit	public	function	Submits the exposed form. Overrides ExposedFormPluginInterface::exposedFormSubmit
ExposedFormPluginBase::exposedFormValidate	public	function	Validates the exposed form submission. Overrides ExposedFormPluginInterface::exposedFormValidate
ExposedFormPluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
ExposedFormPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
ExposedFormPluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ExposedFormPluginBase::postExecute	public	function	Runs after the view has been executed. Overrides ExposedFormPluginInterface::postExecute
ExposedFormPluginBase::postRender	public	function	Runs after the view has been rendered. Overrides ExposedFormPluginInterface::postRender
ExposedFormPluginBase::preExecute	public	function	Runs before the view has been executed. Overrides ExposedFormPluginInterface::preExecute
ExposedFormPluginBase::renderExposedForm	public	function	Renders the exposed form. Overrides ExposedFormPluginInterface::renderExposedForm
ExposedFormPluginBase::resetForm	public	function	Resets all the states of the exposed form.
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. Overrides ExposedFormPluginBase::defineOptions
InputRequired::exposedFilterApplied	protected	function
InputRequired::preRender	public	function	Runs before the view is rendered. Overrides ExposedFormPluginBase::preRender
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
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition.
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.
PluginBase::$view	public	property	The top object of a view.
PluginBase::calculateDependencies	public	function		4
PluginBase::create	public static	function		7
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function		1
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function
PluginBase::getAvailableGlobalTokens	public	function
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::getProvider	public	function
PluginBase::getRenderer	protected	function	Returns the render API renderer.
PluginBase::globalTokenForm	public	function
PluginBase::globalTokenReplace	public	function
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::init	public	function		2
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function
PluginBase::preRenderAddFieldsetMarkup	public static	function
PluginBase::preRenderFlattenData	public static	function
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function		3
PluginBase::themeFunctions	public	function
PluginBase::trustedCallbacks	public static	function		1
PluginBase::unpackOptions	public	function
PluginBase::usesOptions	public	function		6
PluginBase::validate	public	function		2
PluginBase::validateOptionsForm	public	function		5
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginBase::__construct	public	function	Constructs a PluginBase object.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class InputRequired in Drupal 10

Plugin annotation

Hierarchy

Related topics

File

Namespace

Members

API Navigation