comparison core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php @ 5:12f9dff5fda9 tip

Update to Drupal core 8.7.1

    *   human-readable strings, each describing a change.
    */
   public function getChangeSummary();
 
   /**
+   * Gets a list of changes to entity type and field storage definitions.
+   *
+   * @return array
+   *   An associative array keyed by entity type ID of change descriptors. Every
+   *   entry is an associative array with the following optional keys:
+   *   - entity_type: a scalar having one value among:
+   *     - EntityDefinitionUpdateManagerInterface::DEFINITION_CREATED
+   *     - EntityDefinitionUpdateManagerInterface::DEFINITION_UPDATED
+   *   - field_storage_definitions: an associative array keyed by field name of
+   *     scalars having one value among:
+   *     - EntityDefinitionUpdateManagerInterface::DEFINITION_CREATED
+   *     - EntityDefinitionUpdateManagerInterface::DEFINITION_UPDATED
+   *     - EntityDefinitionUpdateManagerInterface::DEFINITION_DELETED
+   */
+  public function getChangeList();
+
+  /**
    * Applies all the detected valid changes.
    *
    * Use this with care, as it will apply updates for any module, which will
    * lead to unpredictable results.
    *
    * @throws \Drupal\Core\Entity\EntityStorageException
    *   This exception is thrown if a change cannot be applied without
    *   unacceptable data loss. In such a case, the site administrator needs to
    *   apply some other process, such as a custom update function or a
    *   migration via the Migrate module.
+   *
+   * @deprecated in Drupal 8.7.0, will be removed before Drupal 9.0.0. Use
+   *    \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface::getChangeList()
+   *    and execute each entity type and field storage update manually instead.
+   *
+   * @see https://www.drupal.org/node/3034742
    */
   public function applyUpdates();
 
   /**
    * Returns an entity type definition ready to be manipulated.

    *
    * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
    *   The entity type definition.
    */
   public function uninstallEntityType(EntityTypeInterface $entity_type);
+
+  /**
+   * Applies any change performed to a fieldable entity type definition.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
+   *   The updated entity type definition.
+   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface[] $field_storage_definitions
+   *   The updated field storage definitions, including possibly new ones.
+   * @param array &$sandbox
+   *   (optional) A sandbox array provided by a hook_update_N() implementation
+   *   or a Batch API callback. If the entity schema update requires a data
+   *   migration, this parameter is mandatory. Defaults to NULL.
+   */
+  public function updateFieldableEntityType(EntityTypeInterface $entity_type, array $field_storage_definitions, array &$sandbox = NULL);
 
   /**
    * Returns a field storage definition ready to be manipulated.
    *
    * When needing to apply updates to existing field storage definitions, this