interface DynamicallyFieldableEntityStorageInterface in Zircon Profile 8

A storage that supports entity types with dynamic field definitions.

A storage that implements this interface can react to the entity type's field definitions changing, due to modules being installed or uninstalled, or via field UI, or via code changes to the entity class.

For example, configurable fields defined and exposed by field.module.

Hierarchy

• interface \Drupal\Core\Entity\FieldableEntityStorageInterface; interface \Drupal\Core\Field\FieldStorageDefinitionListenerInterface; interface \Drupal\Core\Field\FieldDefinitionListenerInterface
  • interface \Drupal\Core\Entity\DynamicallyFieldableEntityStorageInterface

3 files declare their use of DynamicallyFieldableEntityStorageInterface

entity.api.php in core/lib/Drupal/Core/Entity/entity.api.php

Hooks and documentation related to entities.

field.module in core/modules/field/field.module

Attach custom data fields to Drupal entities.

FieldDefinitionListenerTest.php in core/tests/Drupal/Tests/Core/Field/FieldDefinitionListenerTest.php

Contains \Drupal\Tests\Core\Field\FieldDefinitionListenerTest.

File

core/lib/Drupal/Core/Entity/DynamicallyFieldableEntityStorageInterface.php, line 24

Contains \Drupal\Core\Entity\DynamicallyFieldableEntityStorageInterface.

Namespace

Drupal\Core\Entity

interface DynamicallyFieldableEntityStorageInterface extends FieldableEntityStorageInterface, FieldStorageDefinitionListenerInterface, FieldDefinitionListenerInterface {

  /**
   * Determines if the storage contains any data.
   *
   * @return bool
   *   TRUE if the storage contains data, FALSE if not.
   */
  public function hasData();

  /**
   * Purges a batch of field data.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The deleted field whose data is being purged.
   * @param $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 being purged.
   */
  public function finalizePurge(FieldStorageDefinitionInterface $storage_definition);

}

Members

Name	Modifiers	Type	Description	Overrides
DynamicallyFieldableEntityStorageInterface::finalizePurge	public	function	Performs final cleanup after all data of a field has been purged.	1
DynamicallyFieldableEntityStorageInterface::hasData	public	function	Determines if the storage contains any data.	1
DynamicallyFieldableEntityStorageInterface::purgeFieldData	public	function	Purges a batch of field data.	1
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	public	function	Delete a specific entity revision.	3
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::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::load	public	function	Loads one entity.	1
EntityStorageInterface::loadByProperties	public	function	Load entities by their property values.	1
EntityStorageInterface::loadMultiple	public	function	Loads one or more entities.	1
EntityStorageInterface::loadRevision	public	function	Load a specific entity revision.	3
EntityStorageInterface::loadUnchanged	public	function	Loads an unchanged entity from the database.	1
EntityStorageInterface::resetCache	public	function	Resets the internal, static entity cache.	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.	2
FieldDefinitionListenerInterface::onFieldDefinitionCreate	public	function	Reacts to the creation of a field.	3
FieldDefinitionListenerInterface::onFieldDefinitionDelete	public	function	Reacts to the deletion of a field.	3
FieldDefinitionListenerInterface::onFieldDefinitionUpdate	public	function	Reacts to the update of a field.	3
FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionCreate	public	function	Reacts to the creation of a field storage definition.	4
FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionDelete	public	function	Reacts to the deletion of a field storage definition.	4
FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionUpdate	public	function	Reacts to the update of a field storage definition.	4