class Hidden in Better Exposed Filters 8.4

Default widget implementation.

Plugin annotation

@BetterExposedFiltersFilterWidget(
  id = "bef_hidden",
  label = @Translation("Hidden"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\better_exposed_filters\Plugin\BetterExposedFiltersWidgetBase implements BetterExposedFiltersWidgetInterface uses StringTranslationTrait
    • class \Drupal\better_exposed_filters\Plugin\better_exposed_filters\filter\FilterWidgetBase implements BetterExposedFiltersWidgetInterface uses StringTranslationTrait
      • class \Drupal\better_exposed_filters\Plugin\better_exposed_filters\filter\Hidden

1 string reference to 'Hidden'

better_exposed_filters.filter.schema.yml in config/schema/better_exposed_filters.filter.schema.yml

config/schema/better_exposed_filters.filter.schema.yml

File

src/Plugin/better_exposed_filters/filter/Hidden.php, line 15

Namespace

Drupal\better_exposed_filters\Plugin\better_exposed_filters\filter

class Hidden extends FilterWidgetBase {

  /**
   * {@inheritdoc}
   */
  public function exposedFormAlter(array &$form, FormStateInterface $form_state) {
    $field_id = $this
      ->getExposedFilterFieldId();
    parent::exposedFormAlter($form, $form_state);
    if (empty($form[$field_id]['#multiple'])) {

      // Single entry filters can simply be changed to a different element
      // type.
      $form[$field_id]['#type'] = 'hidden';
    }
    else {

      // Hide the label.
      $form['#info']["filter-{$field_id}"]['label'] = '';
      $form[$field_id]['#title'] = '';

      // Use BEF's preprocess and template to output the hidden elements.
      $form[$field_id]['#theme'] = 'bef_hidden';
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable($filter = NULL, array $filter_options = []) {
    $is_applicable = parent::isApplicable($filter, $filter_options);
    if ((is_a($filter, 'Drupal\\views\\Plugin\\views\\filter\\Date') || !empty($filter->date_handler)) && !$filter
      ->isAGroup()) {
      $is_applicable = TRUE;
    }
    return $is_applicable;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BetterExposedFiltersWidgetBase::$handler	protected	property	The views plugin this configuration will affect when exposed.
BetterExposedFiltersWidgetBase::$view	protected	property	The views executable object.
BetterExposedFiltersWidgetBase::addContext	protected	function	Sets metadata on the form elements for easier processing.
BetterExposedFiltersWidgetBase::addElementToGroup	protected	function	Moves an exposed form element into a field group.
BetterExposedFiltersWidgetBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
BetterExposedFiltersWidgetBase::getExposedFormActionUrl	protected	function	Returns exposed form action URL object.
BetterExposedFiltersWidgetBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
BetterExposedFiltersWidgetBase::setView	public	function	Sets the view object. Overrides BetterExposedFiltersWidgetInterface::setView
BetterExposedFiltersWidgetBase::setViewsHandler	public	function	Sets the exposed view handler plugin. Overrides BetterExposedFiltersWidgetInterface::setViewsHandler
BetterExposedFiltersWidgetBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
BetterExposedFiltersWidgetBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1
BetterExposedFiltersWidgetBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
FilterWidgetBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	3
FilterWidgetBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides BetterExposedFiltersWidgetBase::defaultConfiguration	3
FilterWidgetBase::getExposedFilterFieldId	protected	function	Helper function to get the unique identifier for the exposed filter.
FilterWidgetBase::getExposedFilterWidgetType	protected	function	Helper function to get the widget type of the exposed filter.
FilterWidgetBase::processSortedOptions	public	function	Sorts the options for a given form element alphabetically.
Hidden::exposedFormAlter	public	function	Manipulate views exposed from element. Overrides FilterWidgetBase::exposedFormAlter
Hidden::isApplicable	public static	function	Verify this plugin can be used on the form element. Overrides FilterWidgetBase::isApplicable
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.