You are here

protected function CourseObjectFulfillmentStorageSchema::getSharedTableFieldSchema in Course 3.x

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/Schema/CourseObjectFulfillmentStorageSchema.php, line 17

Class

CourseObjectFulfillmentStorageSchema
Defines the course object fulfillment schema handler. Ensure that a user can only have one fulfillment per course object.

Namespace

Drupal\course\Schema

Code

protected function getSharedTableFieldSchema(FieldStorageDefinitionInterface $storage_definition, $table_name, array $column_mapping) {
  $schema = parent::getSharedTableFieldSchema($storage_definition, $table_name, $column_mapping);
  if ($table_name === 'course_object_fulfillment' && $storage_definition
    ->getName() == 'cofid') {
    $schema['unique keys']['coid_uid'] = [
      'coid',
      'uid',
    ];
  }
  return $schema;
}