protected function CommerceContentEntityStorageSchema::getSharedTableFieldSchema in Commerce Core 8.2

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

src/CommerceContentEntityStorageSchema.php, line 16

Class

CommerceContentEntityStorageSchema

Defines a schema handler that supports defining base field indexes.

Namespace

Drupal\commerce

Code

protected function getSharedTableFieldSchema(FieldStorageDefinitionInterface $storage_definition, $table_name, array $column_mapping) {
  $schema = parent::getSharedTableFieldSchema($storage_definition, $table_name, $column_mapping);
  $entity_type = $this->entityTypeManager
    ->getDefinition($storage_definition
    ->getTargetEntityTypeId());
  $field_indexes = $entity_type
    ->get('field_indexes');
  foreach ($field_indexes as $field_name) {
    if ($field_name == $storage_definition
      ->getName()) {
      $this
        ->addSharedTableFieldIndex($storage_definition, $schema);
    }
  }
  return $schema;
}