function BlockContentStorageSchema::getSharedTableFieldSchema

Same name and namespace in other branches
  1. 11.x core/modules/block_content/src/BlockContentStorageSchema.php \Drupal\block_content\BlockContentStorageSchema::getSharedTableFieldSchema()

Gets the schema for a single field definition.

Entity types may override this method in order to optimize the generated schema for given field. While all optimizations that apply to a single field have to be added here, all cross-field optimizations should be via SqlContentEntityStorageSchema::getEntitySchema() instead; e.g., an index spanning multiple fields.

Parameters

\Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition: The storage definition of the field whose schema has to be returned.

string $table_name: The name of the table columns will be added to.

string[] $column_mapping: A mapping of field column names to database column names.

Return value

array The schema definition for the table with the following keys:

  • fields: The schema definition for the each field columns.
  • indexes: The schema definition for the indexes.
  • unique keys: The schema definition for the unique keys.
  • foreign keys: The schema definition for the foreign keys.

Overrides SqlContentEntityStorageSchema::getSharedTableFieldSchema

File

core/modules/block_content/src/BlockContentStorageSchema.php, line 16

Class

BlockContentStorageSchema
Defines the block content schema handler.

Namespace

Drupal\block_content

Code

protected function getSharedTableFieldSchema(FieldStorageDefinitionInterface $storage_definition, $table_name, array $column_mapping) : array {
  $schema = parent::getSharedTableFieldSchema($storage_definition, $table_name, $column_mapping);
  $field_name = $storage_definition->getName();
  if ($table_name === $this->storage
    ->getDataTable() && $field_name === 'reusable') {
    $this->addSharedTableFieldIndex($storage_definition, $schema);
  }
  return $schema;
}

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