You are here

Home » API reference » Facets 8 » TranslateEntityAggregatedFieldProcessor.php

class TranslateEntityAggregatedFieldProcessor in Facets 8

Transforms the results to show the translated entity label.

Plugin annotation


@FacetsProcessor(
  id = "translate_entity_aggregated_fields",
  label = @Translation("Transform entity ID in aggregated field to label"),
  description = @Translation("Display the entity label instead of its ID (for example the term name instead of the taxonomy term ID) in aggregated fields."),
  stages = {
    "build" = 5
  }
)

Hierarchy

Expanded class hierarchy of TranslateEntityAggregatedFieldProcessor

File

src/Plugin/facets/processor/TranslateEntityAggregatedFieldProcessor.php, line 32

Namespace

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

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

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

  /**
   * 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\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @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, LanguageManagerInterface $language_manager, EntityTypeManagerInterface $entity_type_manager, ConfigManagerInterface $config_manager, EntityFieldManagerInterface $entity_field_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->languageManager = $language_manager;
    $this->entityTypeManager = $entity_type_manager;
    $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('language_manager'), $container
      ->get('entity_type.manager'), $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_type_ids = [];
    $allowed_values = [];
    $language_interface = $this->languageManager
      ->getCurrentLanguage();

    // 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);
      foreach ($field
        ->getConfiguration()['fields'] as $field_configuration) {
        $parts = explode(':', $field_configuration);
        if ($parts[0] !== 'entity') {
          throw new \InvalidArgumentException('Data type must be in the form of "entity:ENTITY_TYPE/FIELD_NAME."');
        }
        $parts = explode('/', $parts[1]);
        $entity_type_id = $parts[0];
        $field = $parts[1];
        $entity_type_ids[] = $entity_type_id;
        $definition_update_manager = \Drupal::entityDefinitionUpdateManager();
        $field_storage = $definition_update_manager
          ->getFieldStorageDefinition($field, $entity_type_id);
        if ($field_storage && $field_storage
          ->getType() === 'entity_reference') {

          /** @var \Drupal\facets\Result\ResultInterface $result */
          $ids = [];
          foreach ($results as $delta => $result) {
            $ids[$delta] = $result
              ->getRawValue();
          }
          if ($field_storage instanceof FieldStorageDefinitionInterface) {
            if ($field !== 'type') {

              // Load all indexed entities of this type.
              $entities = $this->entityTypeManager
                ->getStorage($field_storage
                ->getSettings()['target_type'])
                ->loadMultiple($ids);

              // Loop over all results.
              foreach ($results as $i => $result) {
                if (!isset($entities[$ids[$i]])) {
                  continue;
                }

                /** @var \Drupal\Core\Entity\ContentEntityBase $entity */
                $entity = $entities[$ids[$i]];

                // Check for a translation of the entity and load that
                // instead if one's found.
                if ($entity instanceof TranslatableInterface && $entity
                  ->hasTranslation($language_interface
                  ->getId())) {
                  $entity = $entity
                    ->getTranslation($language_interface
                    ->getId());
                }

                // Overwrite the result's display value.
                $results[$i]
                  ->setDisplayValue($entity
                  ->label());
              }
            }
          }
        }
      }

      // If no values are found for the current field, try to see if this is a
      // bundle field.
      foreach ($entity_type_ids as $entity) {
        $list_bundles = $this->entityTypeBundleInfo
          ->getBundleInfo($entity);
        if (!empty($list_bundles)) {
          foreach ($list_bundles as $key => $bundle) {
            $allowed_values[$key] = $bundle['label'];
          }
          $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 original
   *   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;
  }

  /**
   * {@inheritdoc}
   */
  public function supportsFacet(FacetInterface $facet) {
    $facet_source = $facet
      ->getFacetSource();
    if ($facet_source instanceof SearchApiFacetSourceInterface) {

      /** @var \Drupal\search_api\Item\Field $field */
      $field_identifier = $facet
        ->getFieldIdentifier();
      $field = $facet_source
        ->getIndex()
        ->getField($field_identifier);
      if ($field
        ->getPropertyPath() === 'aggregated_field') {
        return TRUE;
      }
    }
    return FALSE;
  }

}

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.
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::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.
TranslateEntityAggregatedFieldProcessor::$configManager protected property The config manager.
TranslateEntityAggregatedFieldProcessor::$entityFieldManager protected property The entity field manager.
TranslateEntityAggregatedFieldProcessor::$entityTypeBundleInfo protected property The entity_type bundle info service.
TranslateEntityAggregatedFieldProcessor::$entityTypeManager protected property The entity type manager.
TranslateEntityAggregatedFieldProcessor::$languageManager protected property The language manager.
TranslateEntityAggregatedFieldProcessor::build public function Runs before the renderable array is created. Overrides BuildProcessorInterface::build
TranslateEntityAggregatedFieldProcessor::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TranslateEntityAggregatedFieldProcessor::overWriteDisplayValues protected function Overwrite the display value of the result with a new text.
TranslateEntityAggregatedFieldProcessor::supportsFacet public function Checks if the facet is supported by this widget. Overrides ProcessorPluginBase::supportsFacet
TranslateEntityAggregatedFieldProcessor::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct