abstract class SortProcessorPluginBase in Facets 8

A base class for plugins that implements some boilerplate for a widget order.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\facets\Processor\ProcessorPluginBase implements ProcessorInterface uses DependencyTrait
      • class \Drupal\facets\Processor\SortProcessorPluginBase implements SortProcessorInterface

5 files declare their use of SortProcessorPluginBase

ActiveWidgetOrderProcessor.php in src/Plugin/facets/processor/ActiveWidgetOrderProcessor.php

CountWidgetOrderProcessor.php in src/Plugin/facets/processor/CountWidgetOrderProcessor.php

DisplayValueWidgetOrderProcessor.php in src/Plugin/facets/processor/DisplayValueWidgetOrderProcessor.php

RawValueWidgetOrderProcessor.php in src/Plugin/facets/processor/RawValueWidgetOrderProcessor.php

TermWeightWidgetOrderProcessor.php in src/Plugin/facets/processor/TermWeightWidgetOrderProcessor.php

File

src/Processor/SortProcessorPluginBase.php, line 11

Namespace

Drupal\facets\Processor

abstract class SortProcessorPluginBase extends ProcessorPluginBase implements SortProcessorInterface {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $facet) {
    $processors = $facet
      ->getProcessors();
    $config = isset($processors[$this
      ->getPluginId()]) ? $processors[$this
      ->getPluginId()] : NULL;
    $build['sort'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Sort order'),
      '#options' => [
        'ASC' => $this
          ->t('Ascending'),
        'DESC' => $this
          ->t('Descending'),
      ],
      '#default_value' => !is_null($config) ? $config
        ->getConfiguration()['sort'] : $this
        ->defaultConfiguration()['sort'],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'sort' => 'ASC',
    ];
  }

}

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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ProcessorInterface::STAGE_BUILD		constant	Processing stage: build.
ProcessorInterface::STAGE_POST_QUERY		constant	Processing stage: post_query.
ProcessorInterface::STAGE_PRE_QUERY		constant	Processing stage: pre_query.
ProcessorInterface::STAGE_SORT		constant	Processing stage: sort.
ProcessorPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ProcessorPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ProcessorPluginBase::getDefaultWeight	public	function	Returns the default weight for a specific processing stage. Overrides ProcessorInterface::getDefaultWeight
ProcessorPluginBase::getDescription	public	function	Retrieves the processor description. Overrides ProcessorInterface::getDescription
ProcessorPluginBase::getQueryType	public	function	Picks the preferred query type for this widget. Overrides ProcessorInterface::getQueryType	4
ProcessorPluginBase::isHidden	public	function	Determines whether this processor should be hidden from the user. Overrides ProcessorInterface::isHidden
ProcessorPluginBase::isLocked	public	function	Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ProcessorPluginBase::submitConfigurationForm	public	function
ProcessorPluginBase::supportsFacet	public	function	Checks if the facet is supported by this widget. Overrides ProcessorInterface::supportsFacet	6
ProcessorPluginBase::supportsStage	public	function	Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage
ProcessorPluginBase::validateConfigurationForm	public	function	Validates a configuration form for this processor. Overrides ProcessorInterface::validateConfigurationForm	2
SortProcessorInterface::sortResults	public	function	Orders results and return the new order of results.	5
SortProcessorPluginBase::buildConfigurationForm	public	function	Adds a configuration form for this processor. Overrides ProcessorPluginBase::buildConfigurationForm
SortProcessorPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ProcessorPluginBase::defaultConfiguration	2
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.