You are here

Home » API reference » CRM Core 8.3 » RelationLookup.php

class RelationLookup in CRM Core 8.3

This plugin looks up relations of users to CRM individuals.

@codingStandardsIgnoreStart Example:


  field_crm_id:
    plugin: crm_core_user_relation_lookup
    source: id

@codingStandardsIgnoreEnd

Plugin annotation


@MigrateProcessPlugin(
  id = "crm_core_user_relation_lookup",
  handle_multiples = TRUE
)

Hierarchy

Expanded class hierarchy of RelationLookup

File

modules/crm_core_user_sync/src/Plugin/migrate/process/RelationLookup.php, line 31

Namespace

Drupal\crm_core_user_sync\Plugin\migrate\process
View source 
class RelationLookup extends ProcessPluginBase implements ContainerFactoryPluginInterface {

  /**
   * Entity Type Manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * The migration.
   *
   * @var \Drupal\migrate\Plugin\MigrationInterface
   */
  protected $migration;

  /**
   * The selection plugin.
   *
   * @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface
   */
  protected $selectionPluginManager;

  /**
   * User Sync Relation.
   *
   * @var \Drupal\crm_core_user_sync\CrmCoreUserSyncRelationInterface
   */
  protected $crmCoreUserSyncRelation;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $pluginId, $pluginDefinition, MigrationInterface $migration, CrmCoreUserSyncRelationInterface $crmCoreUserSyncRelation) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->migration = $migration;
    $this->crmCoreUserSyncRelation = $crmCoreUserSyncRelation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition, MigrationInterface $migration = NULL) {
    return new static($configuration, $pluginId, $pluginDefinition, $migration, $container
      ->get('crm_core_user_sync.relation'));
  }

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrateExecutable, Row $row, $destinationProperty) {

    // If the source data is an empty array, return the same.
    if (is_array($value) && count($value) === 0) {
      return [];
    }
    return $this
      ->query($value);
  }

  /**
   * Lookup value.
   *
   * @param mixed $value
   *   The value to query.
   *
   * @return mixed|null
   *   Entity id if the queried entity exists. Otherwise NULL.
   */
  protected function query($value) {
    $multiple = is_array($value);
    $results = [];
    if ($multiple) {
      foreach ($value as $id) {
        $results[] = $this->crmCoreUserSyncRelation
          ->getIndividualIdFromUserId($id);
      }
    }
    else {
      $results[] = $this->crmCoreUserSyncRelation
        ->getIndividualIdFromUserId($value);
    }
    return $multiple ? array_values($results) : reset($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
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.
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
RelationLookup::$crmCoreUserSyncRelation protected property User Sync Relation.
RelationLookup::$entityTypeManager protected property Entity Type Manager.
RelationLookup::$migration protected property The migration.
RelationLookup::$selectionPluginManager protected property The selection plugin.
RelationLookup::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RelationLookup::query protected function Lookup value.
RelationLookup::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
RelationLookup::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.