protected function FileStorageSchema::getSharedTableFieldSchema in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/file/src/FileStorageSchema.php \Drupal\file\FileStorageSchema::getSharedTableFieldSchema()
2. 10 core/modules/file/src/FileStorageSchema.php \Drupal\file\FileStorageSchema::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

core/modules/file/src/FileStorageSchema.php, line 16

Class

FileStorageSchema

Defines the file schema handler.

Namespace

Drupal\file

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()) {
    switch ($field_name) {
      case 'status':
      case 'changed':
      case 'uri':
        $this
          ->addSharedTableFieldIndex($storage_definition, $schema, TRUE);
        break;
    }
  }

  // Entity keys automatically have not null assigned to TRUE, but for the
  // file entity, NULL is a valid value for uid.
  if ($field_name === 'uid') {
    $schema['fields']['uid']['not null'] = FALSE;
  }
  return $schema;
}