class FederatedTerms in Search API Federated Solr 8.3

Same name in this branch

8.3 src/Plugin/search_api/processor/FederatedTerms.php \Drupal\search_api_federated_solr\Plugin\search_api\processor\FederatedTerms
8.3 src/Plugin/Field/FieldType/FederatedTerms.php \Drupal\search_api_federated_solr\Plugin\Field\FieldType\FederatedTerms

Same name and namespace in other branches

8 src/Plugin/search_api/processor/FederatedTerms.php \Drupal\search_api_federated_solr\Plugin\search_api\processor\FederatedTerms
8.2 src/Plugin/search_api/processor/FederatedTerms.php \Drupal\search_api_federated_solr\Plugin\search_api\processor\FederatedTerms
4.x src/Plugin/search_api/processor/FederatedTerms.php \Drupal\search_api_federated_solr\Plugin\search_api\processor\FederatedTerms

Normalize multiple taxonomy terms into federated terms.

Plugin annotation


@SearchApiProcessor(
  id = "federated_terms",
  label = @Translation("Federated terms"),
  description = @Translation("Normalize multiple taxonomy terms into federated terms."),
  stages = {
    "add_properties" = 20,
  },
  locked = true,
  hidden = true,
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
    class \Drupal\search_api\Plugin\ConfigurablePluginBase implements ConfigurablePluginInterface uses PluginDependencyTrait
    class \Drupal\search_api\Plugin\IndexPluginBase implements IndexPluginInterface
    class \Drupal\search_api\Processor\ProcessorPluginBase implements ProcessorInterface
    class \Drupal\search_api_federated_solr\Plugin\search_api\processor\FederatedTerms

Expanded class hierarchy of FederatedTerms

File

src/Plugin/search_api/processor/FederatedTerms.php, line 27

Namespace

Drupal\search_api_federated_solr\Plugin\search_api\processor

View source

class FederatedTerms extends ProcessorPluginBase {

  /**
   * {@inheritdoc}
   */
  public function getPropertyDefinitions(DatasourceInterface $datasource = NULL) {
    $properties = [];
    if (!$datasource) {
      $definition = [
        'label' => $this
          ->t('Federated terms'),
        'description' => $this
          ->t('Normalize multiple taxonomy terms into federated terms.'),
        'type' => 'string',
        'processor_id' => $this
          ->getPluginId(),
      ];
      $properties['federated_terms'] = new FederatedTermsProperty($definition);
    }
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function addFieldValues(ItemInterface $item) {

    /* Get all of the federated terms fields on our index
     * (there should only be one).
     */
    $federated_terms = $this
      ->getFieldsHelper()
      ->filterForPropertyPath($item
      ->getFields(), NULL, 'federated_terms');

    // Get the entity object for the item being indexed.
    $entity = $item
      ->getOriginalObject()
      ->getValue();

    // Exit if there's somehow not one.
    if (!$entity) {
      return;
    }

    // Define our array of federated terms destination values.
    $federated_terms_destination_values = [];

    // Set some helper vars for the entity and bundle type.
    $entity_type = $entity
      ->getEntityTypeId();
    $bundle_type = $entity
      ->bundle();

    // Get the bundle's fields.
    $entityManager = \Drupal::service('entity_field.manager');
    $bundle_fields = $entityManager
      ->getFieldDefinitions($entity_type, $bundle_type);

    // Define array of potential taxonomy fields.
    $bundle_taxonomy_fields = [];

    // Process and set values for each federated field on the index.
    foreach ($federated_terms as $federated_term) {

      // Determine if / which taxonomy fields exist on the entity.
      foreach ($bundle_fields as $bundle_field) {
        $bundle_field_type = $bundle_field
          ->getType();
        if ($bundle_field_type === "entity_reference") {
          $bundle_field_settings = $bundle_field
            ->getSettings();
          if ($bundle_field_settings['target_type'] == 'taxonomy_term') {
            $bundle_taxonomy_fields[$bundle_field
              ->getName()] = $bundle_field
              ->getLabel();
          }
        }
      }

      // For each taxonomy field on the entity, get the terms.
      foreach ($bundle_taxonomy_fields as $taxonomy_field_id => $taxonomy_field_name) {

        // Get the entity's term data for that taxonomy field.
        $entity_terms = $entity->{$taxonomy_field_id}
          ->getValue();

        // If there are no taxonomy terms on this $entity, do nothing.
        if (empty($entity_terms)) {
          continue;
        }

        // Iterate through this item's terms to find federated_terms values.
        foreach ($entity_terms as $term) {

          // Load the taxonomy term entity.
          $term_entity = Term::load($term['target_id']);

          // Get the term's field definitions.
          $field_definitions = $term_entity
            ->getFieldDefinitions();
          $federated_term_definitions = array_filter($field_definitions, function ($field_definition) {
            return $field_definition
              ->getType() === "federated_terms";
          });

          /* Since we don't know the field name which was added,
           * we need to identify it by the field type.
           */
          $federated_term_field_names = array_map(function ($federated_term_definition) {
            return $federated_term_definition
              ->getName();
          }, $federated_term_definitions);

          // Iterate through any federated_terms fields and get their values.
          foreach ($federated_term_field_names as $field_name) {
            $federated_term_values = $term_entity->{$field_name}
              ->getValue();

            // If the federated_terms field is populated.
            if (!empty($federated_term_values)) {
              foreach ($federated_term_values as $federated_term_value) {

                // Add its values to the destination_terms array.
                $federated_terms_destination_values[] = $federated_term_value['value'];
              }
            }
          }
        }
      }

      // Remove any duplicate federated_term_destination_values.
      $federated_terms_destination_values = array_unique($federated_terms_destination_values);

      // If the value does not already exist for this item, then add it.
      foreach ($federated_terms_destination_values as $value) {
        $existing_values = $federated_term
          ->getValues();
        if (!array_search($value, $existing_values)) {
          $federated_term
            ->addValue($value);
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
ConfigurablePluginBase::calculatePluginDependencies Deprecated	protected	function	Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	11
ConfigurablePluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription	public	function	Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated	protected	function	Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label	public	function	Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated	protected	function	Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval	public	function	Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval	5
ConfigurablePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	3
ConfigurablePluginBase::themeHandler Deprecated	protected	function	Wraps the theme handler.
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.
FederatedTerms::addFieldValues	public	function	Adds the values of properties defined by this processor to the item. Overrides ProcessorPluginBase::addFieldValues
FederatedTerms::getPropertyDefinitions	public	function	Retrieves the properties this processor defines for the given datasource. Overrides ProcessorPluginBase::getPropertyDefinitions
IndexPluginBase::$index	protected	property	The index this processor is configured for.
IndexPluginBase::getIndex	public	function	Retrieves the index this plugin is configured for. Overrides IndexPluginInterface::getIndex
IndexPluginBase::setIndex	public	function	Sets the index this plugin is configured for. Overrides IndexPluginInterface::setIndex
IndexPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurablePluginBase::__construct	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.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler. Aliased as: traitModuleHandler	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler. Aliased as: traitThemeHandler	1
ProcessorInterface::STAGE_ADD_PROPERTIES		constant	Processing stage: add properties.
ProcessorInterface::STAGE_ALTER_ITEMS		constant	Processing stage: alter indexed items.
ProcessorInterface::STAGE_POSTPROCESS_QUERY		constant	Processing stage: postprocess query.
ProcessorInterface::STAGE_PREPROCESS_INDEX		constant	Processing stage: preprocess index.
ProcessorInterface::STAGE_PREPROCESS_QUERY		constant	Processing stage: preprocess query.
ProcessorInterface::STAGE_PRE_INDEX_SAVE		constant	Processing stage: preprocess index.
ProcessorPluginBase::$fieldsHelper	protected	property	The fields helper.	1
ProcessorPluginBase::alterIndexedItems	public	function	Alter the items to be indexed. Overrides ProcessorInterface::alterIndexedItems	3
ProcessorPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ConfigurablePluginBase::create	8
ProcessorPluginBase::ensureField	protected	function	Ensures that a field with certain properties is indexed on the index.
ProcessorPluginBase::findField	protected	function	Finds a certain field in the index.
ProcessorPluginBase::getFieldsHelper	public	function	Retrieves the fields helper.	1
ProcessorPluginBase::getWeight	public	function	Returns the weight for a specific processing stage. Overrides ProcessorInterface::getWeight
ProcessorPluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginBase::isHidden
ProcessorPluginBase::isLocked	public	function	Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::postprocessSearchResults	public	function	Postprocess search results before they are returned by the query. Overrides ProcessorInterface::postprocessSearchResults	2
ProcessorPluginBase::preIndexSave	public	function	Preprocesses the search index entity before it is saved. Overrides ProcessorInterface::preIndexSave	5
ProcessorPluginBase::preprocessIndexItems	public	function	Preprocesses search items for indexing. Overrides ProcessorInterface::preprocessIndexItems	5
ProcessorPluginBase::preprocessSearchQuery	public	function	Preprocesses a search query. Overrides ProcessorInterface::preprocessSearchQuery	4
ProcessorPluginBase::requiresReindexing	public	function	Determines whether re-indexing is required after a settings change. Overrides ProcessorInterface::requiresReindexing
ProcessorPluginBase::setFieldsHelper	public	function	Sets the fields helper.	1
ProcessorPluginBase::setWeight	public	function	Sets the weight for a specific processing stage. Overrides ProcessorInterface::setWeight
ProcessorPluginBase::supportsIndex	public static	function	Checks whether this processor is applicable for a certain index. Overrides ProcessorInterface::supportsIndex	8
ProcessorPluginBase::supportsStage	public	function	Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage	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.

You are here

class FederatedTerms in Search API Federated Solr 8.3

Plugin annotation

Hierarchy

See also

File

Namespace

Members

API Navigation