You are here

protected function UserStorageSchema::getEntitySchema in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/user/src/UserStorageSchema.php \Drupal\user\UserStorageSchema::getEntitySchema()
  2. 10 core/modules/user/src/UserStorageSchema.php \Drupal\user\UserStorageSchema::getEntitySchema()

Gets the entity schema for the specified entity type.

Entity types may override this method in order to optimize the generated schema of the entity tables. However, only cross-field optimizations should be added here; e.g., an index spanning multiple fields. Optimizations that apply to a single field have to be added via SqlContentEntityStorageSchema::getSharedTableFieldSchema() instead.

Parameters

\Drupal\Core\Entity\ContentEntityTypeInterface $entity_type: The entity type definition.

bool $reset: (optional) If set to TRUE static cache will be ignored and a new schema array generation will be performed. Defaults to FALSE.

Return value

array A Schema API array describing the entity schema, excluding dedicated field tables.

Overrides SqlContentEntityStorageSchema::getEntitySchema

File

core/modules/user/src/UserStorageSchema.php, line 17

Class

UserStorageSchema
Defines the user schema handler.

Namespace

Drupal\user

Code

protected function getEntitySchema(ContentEntityTypeInterface $entity_type, $reset = FALSE) {
  $schema = parent::getEntitySchema($entity_type, $reset);
  if ($data_table = $this->storage
    ->getDataTable()) {
    $schema[$data_table]['unique keys'] += [
      'user__name' => [
        'name',
        'langcode',
      ],
    ];
  }
  return $schema;
}