You are here

Home » API reference » Synonyms 8 » BaseField.php

class BaseField in Synonyms 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Synonyms/Provider/BaseField.php \Drupal\synonyms\Plugin\Synonyms\Provider\BaseField

Provide synonyms from base fields.

Plugin annotation


@SynonymsProvider(
  id = "base_field",
  deriver = "Drupal\synonyms\Plugin\Derivative\Field"
)

Hierarchy

Expanded class hierarchy of BaseField

File

src/Plugin/Synonyms/Provider/BaseField.php, line 27

Namespace

Drupal\synonyms\Plugin\Synonyms\Provider
View source 
class BaseField extends AbstractProvider implements SynonymsGetProviderInterface, SynonymsFindProviderInterface, SynonymsFormatWordingProviderInterface {
  use SynonymsGetTrait, SynonymsFindTrait, SynonymsFormatWordingTrait;

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

  /**
   * The field type to synonyms.
   *
   * @var \Drupal\synonyms\SynonymsService\FieldTypeToSynonyms
   */
  protected $fieldTypeToSynonyms;

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

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

  /**
   * BaseField constructor.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityFieldManagerInterface $entity_field_manager, FieldTypeToSynonyms $field_type_to_synonyms, EntityTypeManagerInterface $entity_type_manager, Connection $database, ContainerInterface $container) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $container);
    $this->entityFieldManager = $entity_field_manager;
    $this->fieldTypeToSynonyms = $field_type_to_synonyms;
    $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('synonyms.provider.field_type_to_synonyms'), $container
      ->get('entity_type.manager'), $container
      ->get('database'), $container);
  }

  /**
   * {@inheritdoc}
   */
  public function getSynonyms(ContentEntityInterface $entity) {
    $map = $this->fieldTypeToSynonyms
      ->getSimpleFieldTypeToPropertyMap();
    $field_type = $entity
      ->getFieldDefinition($this
      ->getPluginDefinition()['field'])
      ->getType();
    $synonyms = [];
    if (isset($map[$field_type])) {
      foreach ($entity
        ->get($this
        ->getPluginDefinition()['field']) as $item) {
        $synonyms[] = $item->{$map[$field_type]};
      }
    }
    return $synonyms;
  }

  /**
   * {@inheritdoc}
   */
  public function synonymsFind(ConditionInterface $condition) {
    $entity_type_definition = $this->entityTypeManager
      ->getDefinition($this
      ->getPluginDefinition()['controlled_entity_type']);
    $entity_keys = $entity_type_definition
      ->getKeys();
    $query = $this->database
      ->select($entity_type_definition
      ->getDataTable(), 'base');
    $query
      ->addField('base', $entity_keys['id'], 'entity_id');
    $query
      ->addField('base', $this
      ->getPluginDefinition()['field'], 'synonym');
    if ($this
      ->getPluginDefinition()['controlled_entity_type'] != $this
      ->getPluginDefinition()['controlled_bundle'] && isset($entity_keys['bundle']) && $entity_keys['bundle']) {
      $query
        ->condition($entity_keys['bundle'], $this
        ->getPluginDefinition()['controlled_bundle']);
    }
    $this
      ->synonymsFindProcessCondition($condition, $this
      ->getPluginDefinition()['field'], $entity_keys['id']);
    $query
      ->condition($condition);
    return $query
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $field = $this->entityFieldManager
      ->getFieldDefinitions($this
      ->getPluginDefinition()['controlled_entity_type'], $this
      ->getPluginDefinition()['controlled_bundle'])[$this
      ->getPluginDefinition()['field']];
    return [
      $field
        ->getConfigDependencyKey() => [
        $field
          ->getConfigDependencyName(),
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AbstractProvider::$container protected property The container.
AbstractProvider::getBehaviorService public function Fetch behavior service which corresponds to this provider. Overrides SynonymsProviderInterface::getBehaviorService
AbstractProvider::getBehaviorServiceInstance public function Fetch behavior service instance which corresponds to this provider. Overrides SynonymsProviderInterface::getBehaviorServiceInstance
BaseField::$database protected property The database connection.
BaseField::$entityFieldManager protected property The entity field manager.
BaseField::$entityTypeManager protected property The entity type manager.
BaseField::$fieldTypeToSynonyms protected property The field type to synonyms.
BaseField::calculateDependencies public function
BaseField::create public static function Creates an instance of the plugin. Overrides AbstractProvider::create
BaseField::getSynonyms public function Fetch synonyms from an entity. Overrides SynonymsGetTrait::getSynonyms
BaseField::synonymsFind public function Look up entities by their synonyms within a behavior implementation. Overrides SynonymsFindProviderInterface::synonymsFind
BaseField::__construct public function BaseField constructor. Overrides AbstractProvider::__construct
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.
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.
SynonymsFindProviderInterface::COLUMN_ENTITY_ID_PLACEHOLDER constant Constant which denotes placeholder of an entity ID column.
SynonymsFindProviderInterface::COLUMN_SYNONYM_PLACEHOLDER constant Constant which denotes placeholder of a synonym column.
SynonymsFormatWordingProviderInterface::formatWordingAvailableTokens public function Get available tokens for format wording.
SynonymsFormatWordingProviderInterface::synonymFormatWording public function Format a synonym into wording as requested by configuration.
SynonymsGetTrait::getSynonymsMultiple public function Fetch synonyms from multiple entities at once.