interface FieldableEntityStorageInterface
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php \Drupal\Core\Entity\FieldableEntityStorageInterface
- 8.9.x core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php \Drupal\Core\Entity\FieldableEntityStorageInterface
- 11.x core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php \Drupal\Core\Entity\FieldableEntityStorageInterface
A storage that supports entity types with field definitions.
Hierarchy
- interface \Drupal\Core\Entity\EntityStorageInterface
- interface \Drupal\Core\Entity\FieldableEntityStorageInterface extends \Drupal\Core\Entity\EntityStorageInterface
Expanded class hierarchy of FieldableEntityStorageInterface
All classes that implement FieldableEntityStorageInterface
3 files declare their use of FieldableEntityStorageInterface
- FieldConfig.php in core/
modules/ field/ src/ Entity/ FieldConfig.php - FieldStorageConfig.php in core/
modules/ field/ src/ Entity/ FieldStorageConfig.php - FieldStorageDefinitionListener.php in core/
lib/ Drupal/ Core/ Field/ FieldStorageDefinitionListener.php
File
-
core/
lib/ Drupal/ Core/ Entity/ FieldableEntityStorageInterface.php, line 11
Namespace
Drupal\Core\EntityView source
interface FieldableEntityStorageInterface extends EntityStorageInterface {
/**
* Determines the number of entities with values for a given field.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition
* The field for which to count data records.
* @param bool $as_bool
* (Optional) Optimizes the query for checking whether there are any records
* or not. Defaults to FALSE.
*
* @return bool|int
* The number of entities. If $as_bool parameter is TRUE then the
* value will either be TRUE or FALSE.
*
* @see \Drupal\Core\Entity\FieldableEntityStorageInterface::purgeFieldData()
*/
public function countFieldData($storage_definition, $as_bool = FALSE);
/**
* Purges a batch of field data.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The deleted field whose data is being purged.
* @param int $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 int
* The number of field data records that have been purged.
*/
public function purgeFieldData(FieldDefinitionInterface $field_definition, $batch_size);
/**
* Performs final cleanup after all data of a field has been purged.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition
* The field storage being purged.
*/
public function finalizePurge(FieldStorageDefinitionInterface $storage_definition);
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|---|
EntityStorageInterface::create | public | function | Constructs a new entity object, without permanently saving it. | 1 | |
EntityStorageInterface::delete | public | function | Deletes permanently saved entities. | 1 | |
EntityStorageInterface::deleteRevision | Deprecated | public | function | Delete a specific entity revision. | 4 |
EntityStorageInterface::FIELD_LOAD_CURRENT | constant | Load the most recent version of an entity's field data. | |||
EntityStorageInterface::FIELD_LOAD_REVISION | constant | Load the version of an entity's field data specified in the entity. | |||
EntityStorageInterface::getAggregateQuery | public | function | Gets an aggregated query instance. | 1 | |
EntityStorageInterface::getEntityClass | public | function | Retrieves the class name used to create the entity. | 1 | |
EntityStorageInterface::getEntityType | public | function | Gets the entity type definition. | 1 | |
EntityStorageInterface::getEntityTypeId | public | function | Gets the entity type ID. | 1 | |
EntityStorageInterface::getQuery | public | function | Gets an entity query instance. | 1 | |
EntityStorageInterface::hasData | public | function | Determines if the storage contains any data. | 1 | |
EntityStorageInterface::load | public | function | Loads one entity. | 1 | |
EntityStorageInterface::loadByProperties | public | function | Load entities by their property values without any access checks. | 1 | |
EntityStorageInterface::loadMultiple | public | function | Loads one or more entities. | 1 | |
EntityStorageInterface::loadRevision | Deprecated | public | function | Load a specific entity revision. | 4 |
EntityStorageInterface::loadUnchanged | public | function | Loads an unchanged entity from the database. | 1 | |
EntityStorageInterface::resetCache | public | function | Resets the internal entity cache. | 1 | |
EntityStorageInterface::restore | public | function | Restores a previously saved entity. | 1 | |
EntityStorageInterface::save | public | function | Saves the entity permanently. | 1 | |
FieldableEntityStorageInterface::countFieldData | public | function | Determines the number of entities with values for a given field. | ||
FieldableEntityStorageInterface::finalizePurge | public | function | Performs final cleanup after all data of a field has been purged. | ||
FieldableEntityStorageInterface::purgeFieldData | public | function | Purges a batch of field data. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.