You are here

Home » API reference » Synonyms 2.0.x » EntityReferenceField.php

class EntityReferenceField in Synonyms 2.0.x

Same name in this branch
  1. 2.0.x src/Plugin/Derivative/EntityReferenceField.php \Drupal\synonyms\Plugin\Derivative\EntityReferenceField
  2. 2.0.x src/Plugin/Synonyms/Provider/EntityReferenceField.php \Drupal\synonyms\Plugin\Synonyms\Provider\EntityReferenceField
Same name and namespace in other branches
  1. 8 src/Plugin/Synonyms/Provider/EntityReferenceField.php \Drupal\synonyms\Plugin\Synonyms\Provider\EntityReferenceField

Provide synonyms from entity reference field type.

Plugin annotation


@Provider(
  id = "entityreference_field",
  deriver = "Drupal\synonyms\Plugin\Derivative\EntityReferenceField"
)

Hierarchy

Expanded class hierarchy of EntityReferenceField

File

src/Plugin/Synonyms/Provider/EntityReferenceField.php, line 25

Namespace

Drupal\synonyms\Plugin\Synonyms\Provider
View source 
class EntityReferenceField extends AbstractProvider implements DependentPluginInterface {

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

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

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * EntityReferenceField constructor.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityFieldManagerInterface $entity_field_manager, EntityTypeManagerInterface $entity_type_manager, Connection $database, ContainerInterface $container) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $container);
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeManager = $entity_type_manager;
    $this->database = $database;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getSynonyms(ContentEntityInterface $entity) {
    $synonyms = [];
    foreach ($entity
      ->get($this
      ->getPluginDefinition()['field']) as $item) {
      if (!$item
        ->isEmpty()) {
        $synonyms[] = $item->entity
          ->label();
      }
    }
    return $synonyms;
  }

  /**
   * {@inheritdoc}
   */
  public function synonymsFind(ConditionInterface $condition) {
    $entity_type_definition = $this->entityTypeManager
      ->getDefinition($this
      ->getPluginDefinition()['controlled_entity_type']);
    $field = $this
      ->getFieldDefinition();
    $query = new FieldQuery($entity_type_definition, 'AND', $this->database, QueryBase::getNamespaces($this->entityTypeManager
      ->getStorage($entity_type_definition
      ->id())
      ->getQuery()));
    if ($entity_type_definition
      ->hasKey('bundle')) {
      $query
        ->condition($entity_type_definition
        ->getKey('bundle'), $this
        ->getPluginDefinition()['controlled_bundle']);
    }
    $target_entity_type_definition = $this->entityTypeManager
      ->getDefinition($field
      ->getSetting('target_type'));
    $label_column = $target_entity_type_definition
      ->getKey('label');

    // User entity type does not declare its label, while it does have one.
    if (!$label_column && $target_entity_type_definition
      ->id() == 'user') {
      $label_column = 'name';
    }
    if (!$label_column) {

      // No label column is defined on target entity type, there's nothing we
      // can do.
      return [];
    }
    $synonym_column = $field
      ->getName() . '.entity.' . $label_column;
    $this
      ->synonymsFindProcessCondition($condition, $synonym_column, $entity_type_definition
      ->getKey('id'));
    $conditions_array = $condition
      ->conditions();
    $entity_condition = new Condition($conditions_array['#conjunction'], $query);

    // We will insert a dummy condition for a synonym column just to have the
    // actual table.column data on the synonym column.
    $hash = md5($synonym_column);
    $query
      ->condition($synonym_column, $hash);
    unset($conditions_array['#conjunction']);
    foreach ($conditions_array as $v) {
      $entity_condition
        ->condition($v['field'], $v['value'], $v['operator']);
    }
    $query
      ->condition($entity_condition);

    // We need run the entity query in order to force it into building a normal
    // SQL query.
    $query
      ->execute();

    // Now let's get "demapped" normal SQL query that will tell us explicitly
    // where all entity properties/fields are stored among the SQL tables. Such
    // data is what we need and we do not want to demap it manually.
    $sql_query = $query
      ->getSqlQuery();

    // Swap the entity_id column into the alias "entity_id" as we are supposed
    // to do in this method implementation.
    $select_fields =& $sql_query
      ->getFields();
    $select_fields = [
      'entity_id' => $select_fields[$entity_type_definition
        ->getKey('id')],
    ];
    $select_fields['entity_id']['alias'] = 'entity_id';

    // We need some dummy extra condition to force them into re-compilation.
    $sql_query
      ->where('1 = 1');
    $conditions_array =& $sql_query
      ->conditions();
    foreach ($conditions_array as $k => $condition_array) {
      if (isset($condition_array['value']) && $condition_array['value'] == $hash) {
        list($table_alias, $column) = explode('.', $condition_array['field']);
        unset($conditions_array[$k]);

        // Also unsetting the table aliased by this condition.
        $tables =& $sql_query
          ->getTables();
        $real_table = $tables[$table_alias]['table'];
        foreach ($tables as $k2 => $v2) {
          if ($k2 != $table_alias && $real_table == $v2['table']) {
            unset($tables[$table_alias]);
            $table_alias = $k2;
          }
        }
        $sql_query
          ->addField($table_alias, $column, 'synonym');
        break;
      }
    }
    $result = $sql_query
      ->execute();
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $field = $this
      ->getFieldDefinition();
    $dependencies = [];
    if ($field instanceof FieldConfigInterface) {
      $dependencies[$field
        ->getConfigDependencyKey()] = [
        $field
          ->getConfigDependencyName(),
      ];
    }
    return $dependencies;
  }

  /**
   * Retrieve the field definition against which this plugin is configured.
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface
   *   Field definition against which this plugin is configured.
   */
  protected function getFieldDefinition() {
    $field = $this->entityFieldManager
      ->getFieldDefinitions($this
      ->getPluginDefinition()['controlled_entity_type'], $this
      ->getPluginDefinition()['controlled_bundle']);
    return $field[$this
      ->getPluginDefinition()['field']];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AbstractProvider::$container protected property The container.
ConfigurationTrait::buildConfigurationForm public function
ConfigurationTrait::defaultConfiguration public function
ConfigurationTrait::getConfiguration public function
ConfigurationTrait::setConfiguration public function
ConfigurationTrait::submitConfigurationForm public function
ConfigurationTrait::validateConfigurationForm public function
EntityReferenceField::$database protected property The database connection.
EntityReferenceField::$entityFieldManager protected property The entity field manager.
EntityReferenceField::$entityTypeManager protected property The entity type manager.
EntityReferenceField::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
EntityReferenceField::create public static function Creates an instance of the plugin. Overrides AbstractProvider::create
EntityReferenceField::getFieldDefinition protected function Retrieve the field definition against which this plugin is configured.
EntityReferenceField::getSynonyms public function Fetch synonyms from an entity. Overrides GetInterface::getSynonyms
EntityReferenceField::synonymsFind public function Look up entities by their synonyms within a behavior implementation. Overrides FindInterface::synonymsFind
EntityReferenceField::__construct public function EntityReferenceField constructor. Overrides AbstractProvider::__construct
FindInterface::COLUMN_ENTITY_ID_PLACEHOLDER constant Constant which denotes placeholder of an entity ID column.
FindInterface::COLUMN_SYNONYM_PLACEHOLDER constant Constant which denotes placeholder of a synonym column.
FindInterface::synonymsFindProcessCondition public function Supportive method to process $condition argument in synonymsFind().
FormatWordingInterface::formatWordingAvailableTokens public function Get available tokens for format wording.
FormatWordingInterface::synonymFormatWording public function Format a synonym into wording as requested by configuration.
GetInterface::getSynonymsMultiple public function Fetch synonyms from multiple entities at once.
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 2
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.