You are here

class EntityLastInstalledSchemaRepository in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Entity/EntityLastInstalledSchemaRepository.php \Drupal\Core\Entity\EntityLastInstalledSchemaRepository

Provides a repository for installed entity definitions.

Hierarchy

Expanded class hierarchy of EntityLastInstalledSchemaRepository

1 string reference to 'EntityLastInstalledSchemaRepository'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses EntityLastInstalledSchemaRepository
entity.last_installed_schema.repository in core/core.services.yml
Drupal\Core\Entity\EntityLastInstalledSchemaRepository

File

core/lib/Drupal/Core/Entity/EntityLastInstalledSchemaRepository.php, line 16
Contains \Drupal\Core\Entity\EntityLastInstalledSchemaRepository.

Namespace

Drupal\Core\Entity
View source
class EntityLastInstalledSchemaRepository implements EntityLastInstalledSchemaRepositoryInterface {

  /**
   * The key-value factory.
   *
   * @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface
   */
  protected $keyValueFactory;

  /**
   * Constructs a new EntityLastInstalledSchemaRepository.
   *
   * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
   *   The key-value factory.
   */
  public function __construct(KeyValueFactoryInterface $key_value_factory) {
    $this->keyValueFactory = $key_value_factory;
  }

  /**
   * {@inheritdoc}
   */
  public function getLastInstalledDefinition($entity_type_id) {
    return $this->keyValueFactory
      ->get('entity.definitions.installed')
      ->get($entity_type_id . '.entity_type');
  }

  /**
   * {@inheritdoc}
   */
  public function setLastInstalledDefinition(EntityTypeInterface $entity_type) {
    $entity_type_id = $entity_type
      ->id();
    $this->keyValueFactory
      ->get('entity.definitions.installed')
      ->set($entity_type_id . '.entity_type', $entity_type);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteLastInstalledDefinition($entity_type_id) {
    $this->keyValueFactory
      ->get('entity.definitions.installed')
      ->delete($entity_type_id . '.entity_type');

    // Clean up field storage definitions as well. Even if the entity type
    // isn't currently fieldable, there might be legacy definitions or an
    // empty array stored from when it was.
    $this->keyValueFactory
      ->get('entity.definitions.installed')
      ->delete($entity_type_id . '.field_storage_definitions');
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getLastInstalledFieldStorageDefinitions($entity_type_id) {
    return $this->keyValueFactory
      ->get('entity.definitions.installed')
      ->get($entity_type_id . '.field_storage_definitions', []);
  }

  /**
   * {@inheritdoc}
   */
  public function setLastInstalledFieldStorageDefinitions($entity_type_id, array $storage_definitions) {
    $this->keyValueFactory
      ->get('entity.definitions.installed')
      ->set($entity_type_id . '.field_storage_definitions', $storage_definitions);
  }

  /**
   * {@inheritdoc}
   */
  public function setLastInstalledFieldStorageDefinition(FieldStorageDefinitionInterface $storage_definition) {
    $entity_type_id = $storage_definition
      ->getTargetEntityTypeId();
    $definitions = $this
      ->getLastInstalledFieldStorageDefinitions($entity_type_id);
    $definitions[$storage_definition
      ->getName()] = $storage_definition;
    $this
      ->setLastInstalledFieldStorageDefinitions($entity_type_id, $definitions);
  }

  /**
   * {@inheritdoc}
   */
  public function deleteLastInstalledFieldStorageDefinition(FieldStorageDefinitionInterface $storage_definition) {
    $entity_type_id = $storage_definition
      ->getTargetEntityTypeId();
    $definitions = $this
      ->getLastInstalledFieldStorageDefinitions($entity_type_id);
    unset($definitions[$storage_definition
      ->getName()]);
    $this
      ->setLastInstalledFieldStorageDefinitions($entity_type_id, $definitions);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityLastInstalledSchemaRepository::$keyValueFactory protected property The key-value factory.
EntityLastInstalledSchemaRepository::deleteLastInstalledDefinition public function Deletes the entity type definition from the application state. Overrides EntityLastInstalledSchemaRepositoryInterface::deleteLastInstalledDefinition
EntityLastInstalledSchemaRepository::deleteLastInstalledFieldStorageDefinition public function Deletes the field storage definition from the application state. Overrides EntityLastInstalledSchemaRepositoryInterface::deleteLastInstalledFieldStorageDefinition
EntityLastInstalledSchemaRepository::getLastInstalledDefinition public function Gets the entity type definition in its most recently installed state. Overrides EntityLastInstalledSchemaRepositoryInterface::getLastInstalledDefinition
EntityLastInstalledSchemaRepository::getLastInstalledFieldStorageDefinitions public function Gets the entity type's most recently installed field storage definitions. Overrides EntityLastInstalledSchemaRepositoryInterface::getLastInstalledFieldStorageDefinitions
EntityLastInstalledSchemaRepository::setLastInstalledDefinition public function Stores the entity type definition in the application state. Overrides EntityLastInstalledSchemaRepositoryInterface::setLastInstalledDefinition
EntityLastInstalledSchemaRepository::setLastInstalledFieldStorageDefinition public function Stores the field storage definition in the application state. Overrides EntityLastInstalledSchemaRepositoryInterface::setLastInstalledFieldStorageDefinition
EntityLastInstalledSchemaRepository::setLastInstalledFieldStorageDefinitions public function Stores the entity type's field storage definitions in the application state. Overrides EntityLastInstalledSchemaRepositoryInterface::setLastInstalledFieldStorageDefinitions
EntityLastInstalledSchemaRepository::__construct public function Constructs a new EntityLastInstalledSchemaRepository.