SqlEntityStorageInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php
  2. 8.9.x core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php
  3. 11.x core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php

Namespace

Drupal\Core\Entity\Sql

File

core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php

View source
<?php

namespace Drupal\Core\Entity\Sql;

use Drupal\Core\Entity\EntityStorageInterface;

/**
 * A common interface for SQL-based entity storage implementations.
 */
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);

}

Interfaces

Title Deprecated Summary
SqlEntityStorageInterface A common interface for SQL-based entity storage implementations.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.