class SliderWidget in Facets 8

The slider widget.

Plugin annotation


@FacetsWidget(
  id = "slider",
  label = @Translation("Slider"),
  description = @Translation("A widget that shows a slider."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\facets\Widget\WidgetPluginBase implements WidgetPluginInterface
    class \Drupal\facets_range_widget\Plugin\facets\widget\SliderWidget

Expanded class hierarchy of SliderWidget

1 file declares its use of SliderWidget

SliderWidgetTest.php in modules/facets_range_widget/tests/src/Unit/Plugin/widget/SliderWidgetTest.php

File

modules/facets_range_widget/src/Plugin/facets/widget/SliderWidget.php, line 18

Namespace

Drupal\facets_range_widget\Plugin\facets\widget

View source

class SliderWidget extends WidgetPluginBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'prefix' => '',
      'suffix' => '',
      'min_type' => 'search_result',
      'min_value' => 0,
      'max_type' => 'search_result',
      'max_value' => 10,
      'step' => 1,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet) {
    $build = parent::build($facet);
    $results = $facet
      ->getResults();
    if (empty($results)) {
      return $build;
    }
    ksort($results);
    $show_numbers = $facet
      ->getWidgetInstance()
      ->getConfiguration()['show_numbers'];
    $urls = [];
    $labels = [];
    foreach ($results as $result) {
      $urls['f_' . $result
        ->getRawValue()] = $result
        ->getUrl()
        ->toString();
      $labels[] = $result
        ->getDisplayValue() . ($show_numbers ? ' (' . $result
        ->getCount() . ')' : '');
    }

    // The results set on the facet are sorted where the minimum is the first
    // item and the last one is the one with the highest results, so it's safe
    // to use min/max.
    $min = (double) reset($results)
      ->getRawValue();
    $max = (double) end($results)
      ->getRawValue();
    $build['#items'] = [
      [
        '#type' => 'html_tag',
        '#tag' => 'div',
        '#attributes' => [
          'class' => [
            'facet-slider',
          ],
          'id' => $facet
            ->id(),
        ],
      ],
    ];
    $active = $facet
      ->getActiveItems();
    $build['#attached']['library'][] = 'facets_range_widget/slider';
    $build['#attached']['drupalSettings']['facets']['sliders'][$facet
      ->id()] = [
      'min' => $min,
      'max' => $max,
      'value' => isset($active[0]) ? (double) $active[0] : '',
      'urls' => $urls,
      'prefix' => $this
        ->getConfiguration()['prefix'],
      'suffix' => $this
        ->getConfiguration()['suffix'],
      'step' => $this
        ->getConfiguration()['step'],
      'labels' => $labels,
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $facet) {
    $config = $this
      ->getConfiguration();
    $form = parent::buildConfigurationForm($form, $form_state, $facet);
    $form['prefix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Value prefix'),
      '#size' => 5,
      '#default_value' => $config['prefix'],
    ];
    $form['suffix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Value suffix'),
      '#size' => 5,
      '#default_value' => $config['suffix'],
    ];
    $form['min_type'] = [
      '#type' => 'radios',
      '#options' => [
        'fixed' => $this
          ->t('Fixed value'),
        'search_result' => $this
          ->t('Based on search result'),
      ],
      '#title' => $this
        ->t('Minimum value type'),
      '#default_value' => $config['min_type'],
    ];
    $form['min_value'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum value'),
      '#default_value' => $config['min_value'],
      '#size' => 10,
      '#states' => [
        'visible' => [
          'input[name="widget_config[min_type]"]' => [
            'value' => 'fixed',
          ],
        ],
      ],
    ];
    $form['max_type'] = [
      '#type' => 'radios',
      '#options' => [
        'fixed' => $this
          ->t('Fixed value'),
        'search_result' => $this
          ->t('Based on search result'),
      ],
      '#title' => $this
        ->t('Maximum value type'),
      '#default_value' => $config['max_type'],
    ];
    $form['max_value'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum value'),
      '#default_value' => $config['max_value'],
      '#size' => 5,
      '#states' => [
        'visible' => [
          'input[name="widget_config[max_type]"]' => [
            'value' => 'fixed',
          ],
        ],
      ],
    ];
    $form['step'] = [
      '#type' => 'number',
      '#step' => 0.001,
      '#title' => $this
        ->t('slider step'),
      '#default_value' => $config['step'],
      '#size' => 2,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function isPropertyRequired($name, $type) {
    if ($name === 'slider' && $type === 'processors') {
      return TRUE;
    }
    if ($name === 'show_only_one_result' && $type === 'settings') {
      return TRUE;
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
SliderWidget::build	public	function	Builds the facet widget for rendering. Overrides WidgetPluginBase::build	1
SliderWidget::buildConfigurationForm	public	function	Provides a configuration form for this widget. Overrides WidgetPluginBase::buildConfigurationForm
SliderWidget::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides WidgetPluginBase::defaultConfiguration
SliderWidget::isPropertyRequired	public	function	Checks is a specific property is required for this widget. Overrides WidgetPluginBase::isPropertyRequired	1
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.
WidgetPluginBase::$facet	protected	property	The facet the widget is being built for.
WidgetPluginBase::$showNumbers	protected	property	Show the amount of results next to the result.
WidgetPluginBase::buildListItems	protected	function	Builds a renderable array of result items.	1
WidgetPluginBase::buildResultItem	protected	function	Builds a facet result item.
WidgetPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
WidgetPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WidgetPluginBase::getFacetItemListThemeHook	protected	function	Provides a full array of possible theme functions to try for a given hook.
WidgetPluginBase::getQueryType	public	function	Picks the preferred query type for this widget. Overrides WidgetPluginInterface::getQueryType	3
WidgetPluginBase::prepareLink	protected	function	Returns the text or link for an item.
WidgetPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
WidgetPluginBase::supportsFacet	public	function	Checks if the facet is supported by this processor. Overrides WidgetPluginInterface::supportsFacet	1
WidgetPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct

You are here

class SliderWidget in Facets 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation