interface BetterExposedFiltersWidgetInterface in Better Exposed Filters 8.5

Defines an interface for Better exposed filters filter widget plugins.

Hierarchy

• interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface
  • interface \Drupal\better_exposed_filters\Plugin\BetterExposedFiltersWidgetInterface

3 files declare their use of BetterExposedFiltersWidgetInterface

FilterWidgetBase.php in src/Plugin/better_exposed_filters/filter/FilterWidgetBase.php

PagerWidgetBase.php in src/Plugin/better_exposed_filters/pager/PagerWidgetBase.php

SortWidgetBase.php in src/Plugin/better_exposed_filters/sort/SortWidgetBase.php

File

src/Plugin/BetterExposedFiltersWidgetInterface.php, line 15

Namespace

Drupal\better_exposed_filters\Plugin

interface BetterExposedFiltersWidgetInterface extends PluginFormInterface, PluginInspectionInterface, ConfigurableInterface {

  /**
   * Sets the view object.
   *
   * @param \Drupal\views\ViewExecutable $view
   *   The views executable object.
   */
  public function setView(ViewExecutable $view);

  /**
   * Sets the exposed view handler plugin.
   *
   * @param \Drupal\views\Plugin\views\ViewsHandlerInterface $handler
   *   The views handler plugin this configuration will affect when exposed.
   */
  public function setViewsHandler(ViewsHandlerInterface $handler);

  /**
   * Verify this plugin can be used on the form element.
   *
   * @param mixed $handler
   *   The handler type we are altering (e.g. filter, pager, sort).
   * @param array $options
   *   The options for this handler.
   *
   * @return bool
   *   If this plugin can be used.
   */
  public static function isApplicable($handler = NULL, array $options = []);

  /**
   * Manipulate views exposed from element.
   *
   * @param array $form
   *   The views configuration form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   */
  public function exposedFormAlter(array &$form, FormStateInterface $form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
BetterExposedFiltersWidgetInterface::exposedFormAlter	public	function	Manipulate views exposed from element.	3
BetterExposedFiltersWidgetInterface::isApplicable	public static	function	Verify this plugin can be used on the form element.	3
BetterExposedFiltersWidgetInterface::setView	public	function	Sets the view object.	1
BetterExposedFiltersWidgetInterface::setViewsHandler	public	function	Sets the exposed view handler plugin.	1
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2