class EntityLoadHelper in YAML Content 8

A helper class to support identification and loading of existing entities.

Hierarchy

• class \Drupal\yaml_content\Service\EntityLoadHelper implements ContainerInjectionInterface

1 file declares its use of EntityLoadHelper

EntityLoadHelperTest.php in tests/src/Unit/EntityLoadHelper/EntityLoadHelperTest.php

1 string reference to 'EntityLoadHelper'

yaml_content.services.yml in ./yaml_content.services.yml

yaml_content.services.yml

1 service uses EntityLoadHelper

yaml_content.entity_load_helper in ./yaml_content.services.yml

Drupal\yaml_content\Service\EntityLoadHelper

File

src/Service/EntityLoadHelper.php, line 12

Namespace

Drupal\yaml_content\Service

class EntityLoadHelper implements ContainerInjectionInterface {

  /**
   * An array of entity type machine names that require special handling.
   *
   * The entity types listed in this array cannot be loaded and treated the same
   * as other entity types and require special attention.
   *
   * @var string[] $requiresSpecialHandling
   *
   * @see https://www.drupal.org/project/yaml_content/issues/2893055
   */
  protected static $requiresSpecialHandling = [
    'paragraph',
    'media',
    'file',
  ];

  /**
   * Dependency injection container.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface $container
   */
  protected $container;

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

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

  /**
   * Constructs the entity load helper service.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The dependency injection container to laod dependent services.
   */
  public function __construct(ContainerInterface $container) {
    $this->container = $container;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container);
  }

  /**
   * Query if a target entity already exists and should be updated.
   *
   * @param string $entity_type
   *   The type of entity being imported.
   * @param array $content_data
   *   The import content structure representing the entity being searched for.
   *
   * @return \Drupal\Core\Entity\EntityInterface|false
   *   Return a matching entity if one is found, or FALSE otherwise.
   */
  public function entityExists($entity_type, array $content_data) {
    return (bool) $this
      ->loadEntity($entity_type, $content_data);
  }

  /**
   * Load an entity matching content data if available.
   *
   * Loading by `uuid` will be prioritized if one is defined in order to support
   * updating of entity properties when a unique match is defined.
   *
   * If a `uuid` property is not defined, an entity matching defined properties
   * is searched for instead.
   *
   * @param string $entity_type
   *   The type of entity being imported.
   * @param array $content_data
   *   The import content structure representing the entity being searched for.
   *
   * @return \Drupal\Core\Entity\EntityInterface|false
   *   Return a matching entity if one is found, or FALSE otherwise.
   */
  public function loadEntity($entity_type, array $content_data) {

    // Prioritize loading by UUID to enable changing of properties if a
    // confident match is identified.
    if (isset($content_data['uuid'])) {
      $entity = $this
        ->loadByUuid($entity_type, $content_data['uuid']);
    }
    else {
      $entity = $this
        ->loadByProperties($entity_type, $content_data);
    }
    return $entity;
  }

  /**
   * Load an existing entity by UUID.
   *
   * @param $entity_type
   *   The type of entity being imported.
   * @param string $uuid
   *   The UUID of the entity to be searched for.
   *
   * @return \Drupal\Core\Entity\EntityInterface|false
   */
  public function loadByUuid($entity_type, $uuid) {

    // Load the entity type storage handler.
    $entity_handler = $this
      ->getEntityStorage($entity_type);

    // Load by searching only for the `uuid` property.
    $entities = $entity_handler
      ->loadByProperties([
      'uuid' => $uuid,
    ]);
    return reset($entities);
  }

  /**
   * Load an entity storage handler.
   *
   * @param string $entity_type
   *   The entity type id of the definition to load.
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface
   *   The storage handler service for the entity type.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  protected function getEntityStorage($entity_type) {
    return $this
      ->getEntityTypeManager()
      ->getStorage($entity_type);
  }

  /**
   * Get the EntityTypeManager service.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   The EntityTypeManager service.
   */
  protected function getEntityTypeManager() {

    // Lazy load the entity type manager service.
    if (!isset($this->entityTypeManager)) {
      $this->entityTypeManager = $this->container
        ->get('entity_type.manager');
    }
    return $this->entityTypeManager;
  }

  /**
   * Load an existing entity by property data.
   *
   * Some entity types require special handling and will be handled uniquely.
   *
   * @see \Drupal\yaml_content\Service\EntityLoadHelper::$requiresSpecialHandling
   *
   * @param string $entity_type
   *   The type of entity being imported.
   * @param array $content_data
   *   The import content structure representing the entity being searched for.
   *
   * @return \Drupal\Core\Entity\EntityInterface|false
   *   Return a matching entity if one is found, or FALSE otherwise.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function loadByProperties($entity_type, array $content_data) {

    // Address entities requiring special handling separately.
    // [#2893055] Until this is resolved, these entities are not loaded.
    if (in_array($entity_type, $this::$requiresSpecialHandling)) {

      // @todo Add system to process these entities specifically.
      return FALSE;
    }

    // Load the entity type storage handler.
    $entity_handler = $this
      ->getEntityStorage($entity_type);
    $properties = $this
      ->extractContentProperties($entity_type, $content_data);
    $entity_ids = $entity_handler
      ->loadByProperties($properties);
    return reset($entity_ids);
  }

  /**
   * Identify entity properties from content data.
   *
   * @param $entity_type
   *   The entity type ID.
   * @param array $content_data
   *   The import content structure being parsed for properties.
   *
   * @return array
   *   An array of entity properties compatible with loadByProperties().
   *
   * @see \Drupal\yaml_content\Service\EntityLoadHelper::categorizeAttributes()
   */
  public function extractContentProperties($entity_type, array $content_data) {
    $attributes = $this
      ->categorizeAttributes($entity_type, $content_data);
    return $attributes['property'];
  }

  /**
   * Group content data attributes by type.
   *
   * @param $entity_type
   *   The entity type ID.
   * @param array $content_data
   *   The import content structure being parsed for properties.
   *
   * @return array
   *   An array of entity content keys grouped by attribute type:
   *     - 'property'
   *     - 'field'
   *     - 'other'
   */
  public function categorizeAttributes($entity_type, array $content_data) {

    // Parse properties for creation and fields for processing.
    $attributes = [
      'property' => [],
      'field' => [],
      'other' => [],
    ];
    foreach ($content_data as $key => $data) {
      $type = $this
        ->identifyAttributeType($entity_type, $key);

      // Process simple values as properties for initial creation.
      if ($type == 'field' && !is_array($data)) {
        $type = 'property';
      }
      $attributes[$type][$key] = $data;
    }
    return $attributes;
  }

  /**
   * Identify data keys as properties, fields, or other.
   *
   * @param string $entity_type
   *   The entity type ID.
   * @param string $key
   *   The data key being identified.
   *
   * @return string
   *   The type of attribute being identified. This value may be one of:
   *
   *   - property
   *     All values defined as entity keys will be indicated as properties.
   *   - field
   *     Defined fields for the entity type not indicated as entity keys will
   *     be indicated as fields.
   *   - other
   *     All other values will be categorized here.
   *
   * @todo Use entity type information to more accurately identify attributes.
   */
  protected function identifyAttributeType($entity_type, $key) {

    // Load the list of fields defined for the entity type.
    // @todo Add validation that the entity type is listed here.
    $field_list = $this
      ->getEntityFields($entity_type);
    $entity_definition = $this
      ->getEntityDefinition($entity_type);
    if ($entity_definition
      ->hasKey($key)) {
      $attribute_type = 'property';
    }
    elseif ($entity_definition instanceof ConfigEntityTypeInterface && in_array($key, $entity_definition
      ->getPropertiesToExport())) {
      $attribute_type = 'property';
    }
    elseif (is_array($field_list) && array_key_exists($key, $field_list)) {
      $attribute_type = 'field';
    }
    else {
      $attribute_type = 'other';
    }
    return $attribute_type;
  }

  /**
   * Get the list of fields available for an entity type.
   *
   * @param $entity_type
   *   The entity type ID.
   *
   * @return array
   *   The map of fields mapped for the given entity type.
   */
  protected function getEntityFields($entity_type) {
    $field_map = $this
      ->getEntityFieldManager()
      ->getFieldMap();
    return $field_map[$entity_type];
  }

  /**
   * Get the entity field manager service.
   *
   * @return \Drupal\Core\Entity\EntityFieldManagerInterface
   *   The entity field manager service.
   */
  protected function getEntityFieldManager() {

    // Lazy load the entity field manager service.
    if (!isset($this->entityFieldManager)) {
      $this->entityFieldManager = $this->container
        ->get('entity_field.manager');
    }
    return $this->entityFieldManager;
  }

  /**
   * Load an entity type definition.
   *
   * @param $entity_type
   *   The entity type ID.
   *
   * @return \Drupal\Core\Entity\EntityTypeInterface|null
   *   The entity type definition or NULL if it could not be loaded.
   */
  protected function getEntityDefinition($entity_type) {
    return $this
      ->getEntityTypeManager()
      ->getDefinition($entity_type);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityLoadHelper::$container	protected	property	Dependency injection container.
EntityLoadHelper::$entityFieldManager	protected	property	The entity field manager service.
EntityLoadHelper::$entityTypeManager	protected	property	The entity type manager interface.
EntityLoadHelper::$requiresSpecialHandling	protected static	property	An array of entity type machine names that require special handling.
EntityLoadHelper::categorizeAttributes	public	function	Group content data attributes by type.
EntityLoadHelper::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
EntityLoadHelper::entityExists	public	function	Query if a target entity already exists and should be updated.
EntityLoadHelper::extractContentProperties	public	function	Identify entity properties from content data.
EntityLoadHelper::getEntityDefinition	protected	function	Load an entity type definition.
EntityLoadHelper::getEntityFieldManager	protected	function	Get the entity field manager service.
EntityLoadHelper::getEntityFields	protected	function	Get the list of fields available for an entity type.
EntityLoadHelper::getEntityStorage	protected	function	Load an entity storage handler.
EntityLoadHelper::getEntityTypeManager	protected	function	Get the EntityTypeManager service.
EntityLoadHelper::identifyAttributeType	protected	function	Identify data keys as properties, fields, or other.
EntityLoadHelper::loadByProperties	public	function	Load an existing entity by property data.
EntityLoadHelper::loadByUuid	public	function	Load an existing entity by UUID.
EntityLoadHelper::loadEntity	public	function	Load an entity matching content data if available.
EntityLoadHelper::__construct	public	function	Constructs the entity load helper service.