protected function MicrositeMenuItemOverrideStorageSchema::getSharedTableFieldSchema in Entity Reference Hierarchy 3.x

Same name and namespace in other branches

1. 8.2 modules/entity_hierarchy_microsite/src/MicrositeMenuItemOverrideStorageSchema.php \Drupal\entity_hierarchy_microsite\MicrositeMenuItemOverrideStorageSchema::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.

Throws

\Drupal\Core\Field\FieldException Exception thrown if the schema contains reserved column names or if the initial values definition is invalid.

Overrides SqlContentEntityStorageSchema::getSharedTableFieldSchema

File

modules/entity_hierarchy_microsite/src/MicrositeMenuItemOverrideStorageSchema.php, line 16

Class

MicrositeMenuItemOverrideStorageSchema

Defines a class for storage of overrides.

Namespace

Drupal\entity_hierarchy_microsite

Code

protected function getSharedTableFieldSchema(FieldStorageDefinitionInterface $storage_definition, $table_name, array $column_mapping) {
  $schema = parent::getSharedTableFieldSchema($storage_definition, $table_name, $column_mapping);
  $field_name = $storage_definition
    ->getName();
  if ($table_name == $this->storage
    ->getBaseTable() && $field_name === 'target') {

    // Target should have a unique index. This is a) for performance and b)
    // to prevent the presence of two overrides for the one derivative.
    $this
      ->addSharedTableFieldUniqueKey($storage_definition, $schema);
  }
  return $schema;
}