function field_purge_batch in Drupal 8

Same name and namespace in other branches

1. 7 modules/field/field.crud.inc \field_purge_batch()
2. 9 core/modules/field/field.purge.inc \field_purge_batch()
3. 10 core/modules/field/field.purge.inc \field_purge_batch()

Purges a batch of deleted Field API data, field storages, or fields.

This function will purge deleted field data in batches. The batch size is defined as an argument to the function, and once each batch is finished, it continues with the next batch until all have completed. If a deleted field with no remaining data records is found, the field itself will be purged. If a deleted field storage with no remaining fields is found, the field storage itself will be purged.

Parameters

int $batch_size: The maximum number of field data records to purge before returning.

string $field_storage_unique_id: (optional) Limit the purge to a specific field storage. Defaults to NULL.

Related topics

15 calls to field_purge_batch()

BulkDeleteTest::testPurgeField in core/modules/field/tests/src/Kernel/BulkDeleteTest.php

Verify that field data items and fields are purged when a field storage is deleted.

BulkDeleteTest::testPurgeFieldStorage in core/modules/field/tests/src/Kernel/BulkDeleteTest.php

Verify that field storages are preserved and purged correctly as multiple fields are deleted and purged.

BulkDeleteTest::testPurgeWithDeletedAndActiveField in core/modules/field/tests/src/Kernel/BulkDeleteTest.php

Tests that recreating a field with the name as a deleted field works.

CommentFieldsTest::testCommentInstallAfterContentModule in core/modules/comment/tests/src/Functional/CommentFieldsTest.php

Tests that comment module works when installed after a content module.

CommentUninstallTest::testCommentUninstallWithoutField in core/modules/comment/tests/src/Kernel/CommentUninstallTest.php

Tests if uninstallation succeeds if the field has been deleted beforehand.

... See full list

File

core/modules/field/field.purge.inc, line 74

Provides support for field data purge after mass deletion.

Code

function field_purge_batch($batch_size, $field_storage_unique_id = NULL) {

  /** @var \Drupal\Core\Field\DeletedFieldsRepositoryInterface $deleted_fields_repository */
  $deleted_fields_repository = \Drupal::service('entity_field.deleted_fields_repository');
  $fields = $deleted_fields_repository
    ->getFieldDefinitions($field_storage_unique_id);
  $info = \Drupal::entityTypeManager()
    ->getDefinitions();
  foreach ($fields as $field) {
    $entity_type = $field
      ->getTargetEntityTypeId();

    // We cannot purge anything if the entity type is unknown (e.g. the
    // providing module was uninstalled).
    // @todo Revisit after https://www.drupal.org/node/2080823.
    if (!isset($info[$entity_type])) {
      \Drupal::logger('field')
        ->warning("Cannot remove field @field_name because the entity type is unknown: %entity_type", [
        '@field_name' => $field
          ->getName(),
        '%entity_type' => $entity_type,
      ]);
      continue;
    }
    $count_purged = \Drupal::entityTypeManager()
      ->getStorage($entity_type)
      ->purgeFieldData($field, $batch_size);
    if ($count_purged < $batch_size || $count_purged == 0) {

      // No field data remains for the field, so we can remove it.
      field_purge_field($field);
    }
    $batch_size -= $count_purged;

    // Only delete up to the maximum number of records.
    if ($batch_size == 0) {
      break;
    }
  }

  // Retrieve all deleted field storages. Any that have no fields can be purged.
  foreach ($deleted_fields_repository
    ->getFieldStorageDefinitions() as $field_storage) {
    if ($field_storage_unique_id && $field_storage
      ->getUniqueStorageIdentifier() != $field_storage_unique_id) {

      // If a specific UUID is provided, only purge the corresponding field.
      continue;
    }

    // We cannot purge anything if the entity type is unknown (e.g. the
    // providing module was uninstalled).
    // @todo Revisit after https://www.drupal.org/node/2080823.
    if (!isset($info[$field_storage
      ->getTargetEntityTypeId()])) {
      continue;
    }
    $fields = $deleted_fields_repository
      ->getFieldDefinitions($field_storage
      ->getUniqueStorageIdentifier());
    if (empty($fields)) {
      field_purge_field_storage($field_storage);
    }
  }
}