class DependencyFieldMapGenerator in Entity Reference Integrity 8

Create a map of reference fields.

Hierarchy

• class \Drupal\entity_reference_integrity\DependencyFieldMapGenerator implements DependencyFieldMapGeneratorInterface

1 file declares its use of DependencyFieldMapGenerator

DependencyFieldMapGeneratorTest.php in tests/src/Unit/DependencyFieldMapGeneratorTest.php

1 string reference to 'DependencyFieldMapGenerator'

entity_reference_integrity.services.yml in ./entity_reference_integrity.services.yml

entity_reference_integrity.services.yml

1 service uses DependencyFieldMapGenerator

entity_reference_integrity.field_map in ./entity_reference_integrity.services.yml

\Drupal\entity_reference_integrity\DependencyFieldMapGenerator

File

src/DependencyFieldMapGenerator.php, line 11

Namespace

Drupal\entity_reference_integrity

class DependencyFieldMapGenerator implements DependencyFieldMapGeneratorInterface {

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

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

  /**
   * The field type plugin ID.
   *
   * @var string
   */
  protected $fieldType;

  /**
   * The settings key for the target entity type ID.
   *
   * @var string
   */
  protected $targetEntitySettingsKey;

  /**
   * Construct a ReferenceFieldMapGenerator.
   */
  public function __construct(EntityFieldManagerInterface $entityFieldManager, EntityTypeManagerInterface $entityTypeManager, $fieldType, $targetEntitySettingsKey) {
    $this->entityFieldManager = $entityFieldManager;
    $this->entityTypeManager = $entityTypeManager;
    $this->fieldType = $fieldType;
    $this->targetEntitySettingsKey = $targetEntitySettingsKey;
  }

  /**
   * {@inheritdoc}
   */
  public function getReferentialFieldMap() {
    $referential_field_map = [];
    foreach ($this->entityFieldManager
      ->getFieldMapByFieldType($this->fieldType) as $source_entity_type_id => $fields) {
      $source_entity_storage_definitions = $this->entityFieldManager
        ->getFieldStorageDefinitions($source_entity_type_id);
      $source_entity_type = $this->entityTypeManager
        ->getDefinition($source_entity_type_id);
      foreach ($fields as $field_name => $field_data) {
        $field_storage_definition = !empty($source_entity_storage_definitions[$field_name]) ? $source_entity_storage_definitions[$field_name] : FALSE;

        // Some fields like computed fields do not show up in the return value
        // of getFieldStorageDefinitions.
        if (!$field_storage_definition) {
          continue;
        }

        // Fields with custom storage like term parents can't be used with
        // entity query.
        if ($field_storage_definition
          ->hasCustomStorage()) {
          continue;
        }

        // Don't query against revision metadata fields.
        if (in_array($field_name, $source_entity_type
          ->getRevisionMetadataKeys())) {
          continue;
        }
        $target_entity_type_id = $source_entity_storage_definitions[$field_name]
          ->getSetting($this->targetEntitySettingsKey);
        $referential_field_map[$target_entity_type_id][$source_entity_type_id][] = $field_name;
      }
    }
    return $referential_field_map;
  }

  /**
   * {@inheritdoc}
   */
  public function getReferencingFields($entity_type_id) {
    $map = $this
      ->getReferentialFieldMap();
    return isset($map[$entity_type_id]) ? $map[$entity_type_id] : [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencyFieldMapGenerator::$entityFieldManager	protected	property	The entity field manager.
DependencyFieldMapGenerator::$entityTypeManager	private	property	The entity type manager.
DependencyFieldMapGenerator::$fieldType	protected	property	The field type plugin ID.
DependencyFieldMapGenerator::$targetEntitySettingsKey	protected	property	The settings key for the target entity type ID.
DependencyFieldMapGenerator::getReferencingFields	public	function	Get the segment of the field map for a specific entity type ID. Overrides DependencyFieldMapGeneratorInterface::getReferencingFields
DependencyFieldMapGenerator::getReferentialFieldMap	public	function	A field map keyed by the entity type being targeted by reference fields. Overrides DependencyFieldMapGeneratorInterface::getReferentialFieldMap
DependencyFieldMapGenerator::__construct	public	function	Construct a ReferenceFieldMapGenerator.