You are here

Home » API reference » Feeds 8.3 » ConfigEntityReference.php

class ConfigEntityReference in Feeds 8.3

Defines a config entity reference mapper.

Plugin annotation


@FeedsTarget(
  id = "config_entity_reference",
  field_types = {"entity_reference"},
)

Hierarchy

Expanded class hierarchy of ConfigEntityReference

1 file declares its use of ConfigEntityReference
ConfigEntityReferenceTest.php in tests/src/Unit/Feeds/Target/ConfigEntityReferenceTest.php

File

src/Feeds/Target/ConfigEntityReference.php, line 33

Namespace

Drupal\feeds\Feeds\Target
View source 
class ConfigEntityReference extends FieldTargetBase implements ConfigurableTargetInterface, ContainerFactoryPluginInterface {

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

  /**
   * The Feeds entity finder service.
   *
   * @var \Drupal\feeds\EntityFinderInterface
   */
  protected $entityFinder;

  /**
   * The transliteration manager.
   *
   * @var \Drupal\Component\Transliteration\TransliterationInterface
   */
  protected $transliteration;

  /**
   * The manager for managing config schema type plugins.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfigManager;

  /**
   * Constructs a ConfigEntityReference object.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin id.
   * @param array $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\feeds\EntityFinderInterface $entity_finder
   *   The Feeds entity finder service.
   * @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration
   *   The transliteration manager.
   * @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config_manager
   *   The manager for managing config schema type plugins.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityFinderInterface $entity_finder, TransliterationInterface $transliteration, TypedConfigManagerInterface $typed_config_manager) {
    $this->entityTypeManager = $entity_type_manager;
    $this->entityFinder = $entity_finder;
    $this->transliteration = $transliteration;
    $this->typedConfigManager = $typed_config_manager;
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@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'), $container
      ->get('feeds.entity_finder'), $container
      ->get('transliteration'), $container
      ->get('config.typed'));
  }

  /**
   * {@inheritdoc}
   */
  protected static function prepareTarget(FieldDefinitionInterface $field_definition) {
    $type = $field_definition
      ->getSetting('target_type');
    if (!\Drupal::entityTypeManager()
      ->getDefinition($type)
      ->entityClassImplements(ConfigEntityInterface::class)) {
      return;
    }
    return FieldTargetDefinition::createFromFieldDefinition($field_definition)
      ->addProperty('target_id');
  }

  /**
   * {@inheritdoc}
   */
  public function setTarget(FeedInterface $feed, EntityInterface $entity, $field_name, array $raw_values) {
    $values = [];
    foreach ($raw_values as $delta => $columns) {
      try {
        $this
          ->prepareValue($delta, $columns);
        $values[] = $columns;
      } catch (ReferenceNotFoundException $e) {

        // The referenced entity is not found. We need to enforce Feeds to try
        // to import the same item again on the next import.
        // Feeds stores a hash of every imported item in order to make the
        // import process more efficient by ignoring items it has already seen.
        // In this case we need to destroy the hash in order to be able to
        // import the reference on a next import.
        $entity
          ->get('feeds_item')->hash = NULL;
        $feed
          ->getState(StateInterface::PROCESS)
          ->setMessage($e
          ->getFormattedMessage(), 'warning', TRUE);
      } catch (EmptyFeedException $e) {

        // Nothing wrong here.
      } catch (TargetValidationException $e) {

        // Validation failed.
        $this
          ->addMessage($e
          ->getFormattedMessage(), 'error');
      }
    }
    if (!empty($values)) {
      $entity_target = $this
        ->getEntityTarget($feed, $entity);
      if ($entity_target) {
        $item_list = $entity_target
          ->get($field_name);

        // Append these values to the existing values.
        $values = array_merge($item_list
          ->getValue(), $values);
        $item_list
          ->setValue($values);
      }
    }
  }

  /**
   * Returns possible fields to reference by for a config entity.
   *
   * @return array
   *   A list of fields to reference by.
   */
  protected function getPotentialFields() {

    /** @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $config_entity_type */
    $config_entity_type = $this->entityTypeManager
      ->getDefinition($this
      ->getEntityType());
    $config_name = $config_entity_type
      ->getConfigPrefix() . '.*';
    $definition = $this->typedConfigManager
      ->getDefinition($config_name);
    if (!empty($definition['mapping'])) {
      $options = [];
      foreach ($definition['mapping'] as $key => $mapper) {
        switch ($mapper['type']) {
          case 'integer':
          case 'label':
          case 'string':
          case 'text':
          case 'uuid':
            $options[$key] = $mapper['label'];
            break;
        }
      }
      return $options;
    }
    return [
      'id' => $this
        ->t('ID'),
      'uuid' => $this
        ->t('UUID'),
    ];
  }

  /**
   * Returns the entity type that can be referenced.
   *
   * @return string
   *   The entity type being referenced.
   */
  protected function getEntityType() {
    return $this->settings['target_type'];
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareValue($delta, array &$values) {

    // Check if there is a value for target ID.
    if (!isset($values['target_id']) || strlen(trim($values['target_id'])) === 0) {

      // No value.
      throw new EmptyFeedException();
    }
    if ($target_id = $this
      ->findEntity($this->configuration['reference_by'], $values['target_id'])) {
      $values['target_id'] = $target_id;
      return;
    }
    throw new ReferenceNotFoundException($this
      ->t('Referenced entity not found for field %field with value %target_id.', [
      '%target_id' => $values['target_id'],
      '%field' => $this->configuration['reference_by'],
    ]));
  }

  /**
   * Searches for an entity by entity key.
   *
   * @param string $field
   *   The subfield to search in.
   * @param string $search
   *   The value to search for.
   *
   * @return int|bool
   *   The entity id, or false, if not found.
   */
  protected function findEntity(string $field, $search) {
    $ids = $this->entityFinder
      ->findEntities($this
      ->getEntityType(), $field, $search);
    if ($ids) {
      return reset($ids);
    }
    return FALSE;
  }

  /**
   * Generates a machine name from a string.
   *
   * This is basically the same as what is done in
   * \Drupal\Core\Block\BlockBase::getMachineNameSuggestion() and
   * \Drupal\system\MachineNameController::transliterate(), but it seems
   * that so far there is no common service for handling this.
   *
   * @param string $string
   *   The string to generate a machine name for.
   *
   * @return string
   *   The generated machine name.
   *
   * @see \Drupal\Core\Block\BlockBase::getMachineNameSuggestion()
   * @see \Drupal\system\MachineNameController::transliterate()
   */
  protected function generateMachineName($string) {
    $transliterated = $this->transliteration
      ->transliterate($string, LanguageInterface::LANGCODE_DEFAULT, '_');
    $transliterated = mb_strtolower($transliterated);
    $transliterated = preg_replace('@[^a-z0-9_.]+@', '_', $transliterated);
    return $transliterated;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = [
      'reference_by' => 'id',
    ];
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $options = $this
      ->getPotentialFields();

    // Hack to find out the target delta.
    foreach ($form_state
      ->getValues() as $key => $value) {
      if (strpos($key, 'target-settings-') === 0) {
        list(, , $delta) = explode('-', $key);
        break;
      }
    }
    $form['reference_by'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Reference by'),
      '#options' => $options,
      '#default_value' => $this->configuration['reference_by'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $options = $this
      ->getPotentialFields();
    $summary = [];
    if ($this->configuration['reference_by'] && isset($options[$this->configuration['reference_by']])) {
      $summary[] = $this
        ->t('Reference by: %message', [
        '%message' => $options[$this->configuration['reference_by']],
      ]);
    }
    else {
      $summary[] = $this
        ->t('Please select a field to reference by.');
    }
    return $summary;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityReference::$entityFinder protected property The Feeds entity finder service.
ConfigEntityReference::$entityTypeManager protected property The entity type manager.
ConfigEntityReference::$transliteration protected property The transliteration manager.
ConfigEntityReference::$typedConfigManager protected property The manager for managing config schema type plugins.
ConfigEntityReference::buildConfigurationForm public function Form constructor. Overrides FieldTargetBase::buildConfigurationForm 1
ConfigEntityReference::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ConfigEntityReference::defaultConfiguration public function Gets default configuration for this plugin. Overrides FieldTargetBase::defaultConfiguration 1
ConfigEntityReference::findEntity protected function Searches for an entity by entity key. 1
ConfigEntityReference::generateMachineName protected function Generates a machine name from a string.
ConfigEntityReference::getEntityType protected function Returns the entity type that can be referenced.
ConfigEntityReference::getPotentialFields protected function Returns possible fields to reference by for a config entity.
ConfigEntityReference::getSummary public function Returns the summary for a target. Overrides FieldTargetBase::getSummary 1
ConfigEntityReference::prepareTarget protected static function Prepares a target definition. Overrides FieldTargetBase::prepareTarget
ConfigEntityReference::prepareValue protected function Prepares a single value. Overrides FieldTargetBase::prepareValue 1
ConfigEntityReference::setTarget public function Sets the values on an object. Overrides FieldTargetBase::setTarget 1
ConfigEntityReference::__construct public function Constructs a ConfigEntityReference object. Overrides FieldTargetBase::__construct
ConfigurablePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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.
FieldTargetBase::$fieldSettings protected property The field settings.
FieldTargetBase::$languageManager protected property The language manager.
FieldTargetBase::addMessage protected function Adds a message.
FieldTargetBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
FieldTargetBase::getEntityTarget public function Get entity, or entity translation to set the map.
FieldTargetBase::getLangcode public function Gets the configured language. Overrides TranslatableTargetInterface::getLangcode
FieldTargetBase::getLanguageManager protected function Gets the language manager.
FieldTargetBase::getMessenger protected function Returns the messenger to use.
FieldTargetBase::getUniqueQuery protected function Constructs a base query which is used to find an existing entity.
FieldTargetBase::getUniqueValue public function Looks for an existing entity and returns an entity ID if found.
FieldTargetBase::isEmpty public function Returns if the value for the target is empty. Overrides TargetInterface::isEmpty
FieldTargetBase::isMutable public function Returns if the target is mutable. Overrides TargetInterface::isMutable 1
FieldTargetBase::isTargetFieldTranslatable protected function Checks if the targeted field is translatable.
FieldTargetBase::isTargetTranslatable public function Checks if the target is translatable. Overrides TranslatableTargetInterface::isTargetTranslatable
FieldTargetBase::languageExists public function Checks if the language selected on the target exists. Overrides TranslatableTargetInterface::languageExists
FieldTargetBase::onDependencyRemoval public function Allows a plugin to define whether it should be removed. Overrides TargetBase::onDependencyRemoval
FieldTargetBase::prepareValues protected function Prepares the the values that will be mapped to an entity.
FieldTargetBase::setLanguageManager public function Sets the language manager.
FieldTargetBase::targets public static function Returns the targets defined by this plugin. Overrides TargetInterface::targets 1
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::$feedType protected property The importer this plugin is working for.
PluginBase::$linkGenerator protected property The link generator.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$urlGenerator protected property The url generator.
PluginBase::container private function Returns the service container.
PluginBase::defaultFeedConfiguration public function Returns default feed configuration. Overrides FeedsPluginInterface::defaultFeedConfiguration 3
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::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
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::l protected function Renders a link to a route given a route name and its parameters.
PluginBase::linkGenerator protected function Returns the link generator service.
PluginBase::onFeedDeleteMultiple public function A feed is being deleted. 3
PluginBase::onFeedSave public function A feed is being saved.
PluginBase::onFeedTypeDelete public function The feed type is being deleted. 1
PluginBase::onFeedTypeSave public function The feed type is being saved. 1
PluginBase::pluginType public function Returns the type of plugin. Overrides FeedsPluginInterface::pluginType
PluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
PluginBase::url protected function Generates a URL or path for a specific route based on the given parameters.
PluginBase::urlGenerator protected function Returns the URL generator service.
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.
TargetBase::$targetDefinition protected property The target definition.
TargetBase::getTargetDefinition public function Returns the target's definition. Overrides TargetInterface::getTargetDefinition
TargetBase::submitConfigurationForm public function Form submission handler. Overrides ConfigurablePluginBase::submitConfigurationForm