W3cubDocs

/Drupal 8

public function ContentEntityStorageBase::purgeFieldData

public ContentEntityStorageBase::purgeFieldData(FieldDefinitionInterface $field_definition, $batch_size)

Purges a batch of field data.

Parameters

\Drupal\Core\Field\FieldDefinitionInterface $field_definition: The deleted field whose data is being purged.

$batch_size: The maximum number of field data records to purge before returning, relating to the count of field data records returned by \Drupal\Core\Entity\FieldableEntityStorageInterface::countFieldData().

Return value

int The number of field data records that have been purged.

Overrides DynamicallyFieldableEntityStorageInterface::purgeFieldData

File

core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php, line 174

Class

ContentEntityStorageBase
Base class for content entity storage handlers.

Namespace

Drupal\Core\Entity

Code

public function purgeFieldData(FieldDefinitionInterface $field_definition, $batch_size) {
  $items_by_entity = $this->readFieldItemsToPurge($field_definition, $batch_size);

  foreach ($items_by_entity as $items) {
    $items->delete();
    $this->purgeFieldItems($items->getEntity(), $field_definition);
  }
  return count($items_by_entity);
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Entity!ContentEntityStorageBase.php/function/ContentEntityStorageBase::purgeFieldData/8.1.x