ContentTranslationUpdatesManager.php in Zircon Profile 8

Contains \Drupal\content_translation\ContentTranslationUpdatesManager.

Namespace

Drupal\content_translation

File

core/modules/content_translation/src/ContentTranslationUpdatesManager.php

<?php

/**
 * @file
 * Contains \Drupal\content_translation\ContentTranslationUpdatesManager.
 */
namespace Drupal\content_translation;

use Drupal\Core\Config\ConfigEvents;
use Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface;
use Drupal\Core\Entity\EntityManagerInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Provides the logic needed to update field storage definitions when needed.
 */
class ContentTranslationUpdatesManager implements EventSubscriberInterface {

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

  /**
   * The entity definition update manager.
   *
   * @var \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface
   */
  protected $updateManager;

  /**
   * Constructs an updates manager instance.
   *
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
   * @param \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface $update_manager
   *   The entity definition update manager.
   */
  public function __construct(EntityManagerInterface $entity_manager, EntityDefinitionUpdateManagerInterface $update_manager) {
    $this->entityManager = $entity_manager;
    $this->updateManager = $update_manager;
  }

  /**
   * Executes field storage definition updates if needed.
   *
   * @param array $entity_types
   *   A list of entity type definitions to be processed.
   */
  public function updateDefinitions(array $entity_types) {

    // Handle field storage definition creation, if needed.
    // @todo Generalize this code in https://www.drupal.org/node/2346013.
    // @todo Handle initial values in https://www.drupal.org/node/2346019.
    if ($this->updateManager
      ->needsUpdates()) {
      foreach ($entity_types as $entity_type_id => $entity_type) {
        $storage_definitions = $this->entityManager
          ->getFieldStorageDefinitions($entity_type_id);
        $installed_storage_definitions = $this->entityManager
          ->getLastInstalledFieldStorageDefinitions($entity_type_id);
        foreach (array_diff_key($storage_definitions, $installed_storage_definitions) as $storage_definition) {

          /** @var $storage_definition \Drupal\Core\Field\FieldStorageDefinitionInterface */
          if ($storage_definition
            ->getProvider() == 'content_translation') {
            $this->updateManager
              ->installFieldStorageDefinition($storage_definition
              ->getName(), $entity_type_id, 'content_translation', $storage_definition);
          }
        }
      }
    }
  }

  /**
   * Listener for the ConfigImporter import event.
   */
  public function onConfigImporterImport() {
    $entity_types = array_filter($this->entityManager
      ->getDefinitions(), function (EntityTypeInterface $entity_type) {
      return $entity_type
        ->isTranslatable();
    });
    $this
      ->updateDefinitions($entity_types);
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[ConfigEvents::IMPORT][] = [
      'onConfigImporterImport',
      60,
    ];
    return $events;
  }

}

Classes

Name	Description
ContentTranslationUpdatesManager	Provides the logic needed to update field storage definitions when needed.