class TermWeightWidgetOrderProcessor in Facets 8

A processor that orders the term-results by their weight.

Plugin annotation


@FacetsProcessor(
  id = "term_weight_widget_order",
  label = @Translation("Sort by taxonomy term weight"),
  description = @Translation("Sorts the widget results by taxonomy term weight. This sort is only applicable for term-based facets."),
  stages = {
    "sort" = 60
  }
)

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
    class \Drupal\facets\Plugin\facets\processor\TermWeightWidgetOrderProcessor implements ContainerFactoryPluginInterface

Expanded class hierarchy of TermWeightWidgetOrderProcessor

1 file declares its use of TermWeightWidgetOrderProcessor

TermWeightWidgetOrderProcessorTest.php in tests/src/Unit/Plugin/processor/TermWeightWidgetOrderProcessorTest.php

File

src/Plugin/facets/processor/TermWeightWidgetOrderProcessor.php, line 26

Namespace

Drupal\facets\Plugin\facets\processor

View source

class TermWeightWidgetOrderProcessor extends SortProcessorPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function sortResults(Result $a, Result $b) {

    // Get the term weight once.
    if (!isset($a->termWeight) || !isset($b->termWeight)) {
      $ids = [];
      if (!isset($a->termWeight)) {
        $a_raw = $a
          ->getRawValue();
        $ids[] = $a_raw;
      }
      if (!isset($b->termWeight)) {
        $b_raw = $b
          ->getRawValue();
        $ids[] = $b_raw;
      }
      $entities = $this->entityTypeManager
        ->getStorage('taxonomy_term')
        ->loadMultiple($ids);
      if (!isset($a->termWeight)) {
        if (empty($entities[$a_raw])) {
          return 0;
        }
        $a->termWeight = $entities[$a_raw]
          ->getWeight();
      }
      if (!isset($b->termWeight)) {
        if (empty($entities[$b_raw])) {
          return 0;
        }
        $b->termWeight = $entities[$b_raw]
          ->getWeight();
      }
    }

    // Return the sort value.
    if ($a->termWeight === $b->termWeight) {
      return 0;
    }
    return $a->termWeight < $b->termWeight ? -1 : 1;
  }

  /**
   * {@inheritdoc}
   */
  public function supportsFacet(FacetInterface $facet) {
    $data_definition = $facet
      ->getDataDefinition();
    if ($data_definition
      ->getDataType() === 'entity_reference') {
      return TRUE;
    }
    if (!$data_definition instanceof ComplexDataDefinitionInterface) {
      return FALSE;
    }
    $data_definition = $facet
      ->getDataDefinition();
    $property_definitions = $data_definition
      ->getPropertyDefinitions();
    foreach ($property_definitions as $definition) {
      if ($definition instanceof DataReferenceDefinitionInterface && $definition
        ->getDataType() === 'entity_reference' && $definition
        ->getConstraint('EntityType') === 'taxonomy_term') {
        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
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.
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::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
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.
TermWeightWidgetOrderProcessor::$entityTypeManager	protected	property	The entity type manager.
TermWeightWidgetOrderProcessor::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TermWeightWidgetOrderProcessor::sortResults	public	function	Orders results and return the new order of results. Overrides SortProcessorInterface::sortResults
TermWeightWidgetOrderProcessor::supportsFacet	public	function	Checks if the facet is supported by this widget. Overrides ProcessorPluginBase::supportsFacet
TermWeightWidgetOrderProcessor::__construct	public	function	Constructs a new object. Overrides PluginBase::__construct

You are here

class TermWeightWidgetOrderProcessor in Facets 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation