interface SqlEntityStorageInterface in Drupal 9

A common interface for SQL-based entity storage implementations.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface
  • interface \Drupal\Core\Entity\Sql\SqlEntityStorageInterface

4 files declare their use of SqlEntityStorageInterface

EntityViewsData.php in core/modules/views/src/EntityViewsData.php

KernelTestBase.php in core/tests/Drupal/KernelTests/KernelTestBase.php

Tables.php in core/lib/Drupal/Core/Entity/Query/Sql/Tables.php

views_test_query_access.module in core/modules/views/tests/modules/views_test_query_access/views_test_query_access.module

Module to test entity query access in Views.

File

core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php, line 10

Namespace

Drupal\Core\Entity\Sql

interface SqlEntityStorageInterface extends EntityStorageInterface {

  /**
   * Gets a table mapping for the entity's SQL tables.
   *
   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface[] $storage_definitions
   *   (optional) An array of field storage definitions to be used to compute
   *   the table mapping. Defaults to the ones provided by the entity field
   *   manager.
   *
   * @return \Drupal\Core\Entity\Sql\TableMappingInterface
   *   A table mapping object for the entity's tables.
   */
  public function getTableMapping(array $storage_definitions = NULL);

}

Members

Name	Modifiers	Type	Description	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	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::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.	1
EntityStorageInterface::loadMultiple	public	function	Loads one or more entities.	1
EntityStorageInterface::loadRevision	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
SqlEntityStorageInterface::getTableMapping	public	function	Gets a table mapping for the entity's SQL tables.	1