You are here

Home » API reference » Facets 8 » ListItemProcessor.php

class ListItemProcessor in Facets 8

Provides a processor that transforms the results to show the list item label.

Plugin annotation


@FacetsProcessor(
  id = "list_item",
  label = @Translation("List item label"),
  description = @Translation("Display the label instead of the key of fields that are a list (such as <em>List (integer)</em>) or <em>List (text)</em>) or a bundle field. Keep in mind that transformations on the source of this field (such as transliteration or ignore characters) may break this functionality."),
  stages = {
    "build" = 5
  }
)

Hierarchy

Expanded class hierarchy of ListItemProcessor

1 file declares its use of ListItemProcessor
ListItemProcessorTest.php in tests/src/Unit/Plugin/processor/ListItemProcessorTest.php

File

src/Plugin/facets/processor/ListItemProcessor.php, line 31

Namespace

Drupal\facets\Plugin\facets\processor
View source 
class ListItemProcessor extends ProcessorPluginBase implements BuildProcessorInterface, ContainerFactoryPluginInterface {

  /**
   * The config manager.
   *
   * @var \Drupal\Core\Config\ConfigManagerInterface
   */
  protected $configManager;

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The entity_type bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * Constructs a Drupal\Component\Plugin\PluginBase 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\Config\ConfigManagerInterface $config_manager
   *   The config manager.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity bundle info service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigManagerInterface $config_manager, EntityFieldManagerInterface $entity_field_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configManager = $config_manager;
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
  }

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

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet, array $results) {
    $field_identifier = $facet
      ->getFieldIdentifier();
    $entity = 'node';
    $field = FALSE;
    $allowed_values = [];

    // Support multiple entities when using Search API.
    if ($facet
      ->getFacetSource() instanceof SearchApiDisplay) {

      /** @var \Drupal\search_api\Entity\Index $index */
      $index = $facet
        ->getFacetSource()
        ->getIndex();

      /** @var \Drupal\search_api\Item\Field $field */
      $field = $index
        ->getField($field_identifier);
      if (!$field
        ->getDatasourceId()) {
        throw new InvalidProcessorException("This field has no datasource, there is no valid use for this processor with this facet");
      }
      $entity = $field
        ->getDatasource()
        ->getEntityTypeId();
    }

    // If it's an entity base field, we find it in the field definitions.
    // We don't have access to the bundle via SearchApiFacetSourceInterface, so
    // we check the entity's base fields only.
    $base_fields = $this->entityFieldManager
      ->getFieldDefinitions($entity, '');

    // This only works for configurable fields.
    $config_entity_name = sprintf('field.storage.%s.%s', $entity, $field_identifier);
    if (isset($base_fields[$field_identifier])) {
      $field = $base_fields[$field_identifier];
    }
    elseif ($this->configManager
      ->loadConfigEntityByName($config_entity_name) !== NULL) {
      $field = $this->configManager
        ->loadConfigEntityByName($config_entity_name);
    }
    elseif ($field
      ->getDataDefinition() instanceof FieldItemDataDefinition) {
      $fieldDefinition = $field
        ->getDataDefinition()
        ->getFieldDefinition();
      $referenced_entity_name = sprintf('field.storage.%s.%s', $fieldDefinition
        ->getTargetEntityTypeId(), $fieldDefinition
        ->getName());
      if ($fieldDefinition instanceof BaseFieldDefinition) {
        if (isset($base_fields[$field
          ->getPropertyPath()])) {
          $field = $base_fields[$field
            ->getPropertyPath()];
        }
      }
      elseif ($this->configManager
        ->loadConfigEntityByName($referenced_entity_name) !== NULL) {
        $field = $this->configManager
          ->loadConfigEntityByName($referenced_entity_name);
      }
    }
    if ($field instanceof FieldStorageDefinitionInterface) {
      if ($field
        ->getName() !== 'type') {
        $allowed_values = options_allowed_values($field);
        if (!empty($allowed_values)) {
          return $this
            ->overWriteDisplayValues($results, $allowed_values);
        }
      }
    }

    // If no values are found for the current field, try to see if this is a
    // bundle field.
    $list_bundles = $this->entityTypeBundleInfo
      ->getBundleInfo($entity);
    if (!empty($list_bundles)) {
      foreach ($list_bundles as $key => $bundle) {
        $allowed_values[$key] = $bundle['label'];
      }
      return $this
        ->overWriteDisplayValues($results, $allowed_values);
    }
    return $results;
  }

  /**
   * Overwrite the display value of the result with a new text.
   *
   * @param \Drupal\facets\Result\ResultInterface[] $results
   *   An array of results to work on.
   * @param array $replacements
   *   An array of values that contain possible replacements for the orignal
   *   values.
   *
   * @return \Drupal\facets\Result\ResultInterface[]
   *   The changed results.
   */
  protected function overWriteDisplayValues(array $results, array $replacements) {

    /** @var \Drupal\facets\Result\ResultInterface $a */
    foreach ($results as &$a) {
      if (isset($replacements[$a
        ->getRawValue()])) {
        $a
          ->setDisplayValue($replacements[$a
          ->getRawValue()]);
      }
    }
    return $results;
  }

}

Members

Namesort descending 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.
ListItemProcessor::$configManager protected property The config manager.
ListItemProcessor::$entityFieldManager protected property The entity field manager.
ListItemProcessor::$entityTypeBundleInfo protected property The entity_type bundle info service.
ListItemProcessor::build public function Runs before the renderable array is created. Overrides BuildProcessorInterface::build
ListItemProcessor::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ListItemProcessor::overWriteDisplayValues protected function Overwrite the display value of the result with a new text.
ListItemProcessor::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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::buildConfigurationForm public function Adds a configuration form for this processor. Overrides ProcessorInterface::buildConfigurationForm 10
ProcessorPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ProcessorPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 8
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
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.