protected function RegistrantStorageSchema::getSharedTableFieldSchema in RNG - Events and Registrations 3.x

Same name and namespace in other branches

1. 8.2 src/RegistrantStorageSchema.php \Drupal\rng\RegistrantStorageSchema::getSharedTableFieldSchema()
2. 8 src/RegistrantStorageSchema.php \Drupal\rng\RegistrantStorageSchema::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

src/RegistrantStorageSchema.php, line 16

Class

RegistrantStorageSchema

Defines the schema for Registrant entities.

Namespace

Drupal\rng

Code

protected function getSharedTableFieldSchema(FieldStorageDefinitionInterface $storage_definition, $table_name, array $column_mapping) {
  $schema = parent::getSharedTableFieldSchema($storage_definition, $table_name, $column_mapping);
  if ($storage_definition
    ->getName() == 'type') {

    // This field was added to the registrant entity in a hook_update_N
    // Since you cannot specifiy an initial value when installing a field,
    // and there previously was only a 'registrant' bundle, then use this
    // default value.
    // @see https://www.drupal.org/node/2346019#comment-11746237
    $schema['fields']['type']['initial'] = 'registrant';
  }
  return $schema;
}