You are here

class Links in Better Exposed Filters 8.4

Same name in this branch
  1. 8.4 src/Plugin/better_exposed_filters/filter/Links.php \Drupal\better_exposed_filters\Plugin\better_exposed_filters\filter\Links
  2. 8.4 src/Plugin/better_exposed_filters/sort/Links.php \Drupal\better_exposed_filters\Plugin\better_exposed_filters\sort\Links
  3. 8.4 src/Plugin/better_exposed_filters/pager/Links.php \Drupal\better_exposed_filters\Plugin\better_exposed_filters\pager\Links
Same name and namespace in other branches
  1. 8.5 src/Plugin/better_exposed_filters/pager/Links.php \Drupal\better_exposed_filters\Plugin\better_exposed_filters\pager\Links

Radio Buttons pager widget implementation.

Plugin annotation


@BetterExposedFiltersPagerWidget(
  id = "bef_links",
  label = @Translation("Links"),
)

Hierarchy

Expanded class hierarchy of Links

4 string references to 'Links'
better_exposed_filters.filter.schema.yml in config/schema/better_exposed_filters.filter.schema.yml
config/schema/better_exposed_filters.filter.schema.yml
better_exposed_filters.pager.schema.yml in config/schema/better_exposed_filters.pager.schema.yml
config/schema/better_exposed_filters.pager.schema.yml
better_exposed_filters.sort.schema.yml in config/schema/better_exposed_filters.sort.schema.yml
config/schema/better_exposed_filters.sort.schema.yml
hook_better_exposed_filters_filter_widgets_alter in ./better_exposed_filters.api.php
Modify the array of BEF display options for an exposed filter.

File

src/Plugin/better_exposed_filters/pager/Links.php, line 15

Namespace

Drupal\better_exposed_filters\Plugin\better_exposed_filters\pager
View source
class Links extends PagerWidgetBase {

  /**
   * {@inheritdoc}
   */
  public function exposedFormAlter(array &$form, FormStateInterface $form_state) {
    parent::exposedFormAlter($form, $form_state);
    if (!empty($form['items_per_page'] && count($form['items_per_page']['#options']) > 1)) {
      $form['items_per_page']['#theme'] = 'bef_links';
      $form['items_per_page']['#items_per_page'] = max($form['items_per_page']['#default_value'], key($form['items_per_page']['#options']));

      // Exposed form displayed as blocks can appear on pages other than
      // the view results appear on. This can cause problems with
      // select_as_links options as they will use the wrong path. We
      // provide a hint for theme functions to correct this.
      $form['items_per_page']['#bef_path'] = $this
        ->getExposedFormActionUrl($form_state);
    }
  }

}

Members

Namesort descending 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
Links::exposedFormAlter public function Manipulate views exposed from element. Overrides PagerWidgetBase::exposedFormAlter
PagerWidgetBase::$pagerElements protected property List of available exposed sort form element keys.
PagerWidgetBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
PagerWidgetBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides BetterExposedFiltersWidgetBase::defaultConfiguration
PagerWidgetBase::isApplicable public static function Verify this plugin can be used on the form element. Overrides BetterExposedFiltersWidgetInterface::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.