diff --git a/core/lib/Drupal/Core/Entity/ContentEntityDatabaseStorage.php b/core/lib/Drupal/Core/Entity/ContentEntityDatabaseStorage.php index 6b7de03..0a045f2 100644 --- a/core/lib/Drupal/Core/Entity/ContentEntityDatabaseStorage.php +++ b/core/lib/Drupal/Core/Entity/ContentEntityDatabaseStorage.php @@ -8,7 +8,9 @@ namespace Drupal\Core\Entity; use Drupal\Core\Database\Connection; +use Drupal\Core\Database\Database; use Drupal\Core\Entity\Query\QueryInterface; +use Drupal\Core\Entity\Schema\ContentEntitySchemaHandler; use Drupal\Core\Language\Language; use Drupal\field\FieldInfo; use Drupal\field\FieldConfigUpdateForbiddenException; @@ -25,7 +27,7 @@ * This class can be used as-is by most simple entity types. Entity types * requiring special handling can extend the class. */ -class ContentEntityDatabaseStorage extends ContentEntityStorageBase { +class ContentEntityDatabaseStorage extends ContentEntityStorageBase implements SqlStorageInterface { /** * Name of entity's revision database table field, if it supports revisions. @@ -37,6 +39,13 @@ class ContentEntityDatabaseStorage extends ContentEntityStorageBase { protected $revisionKey = FALSE; /** + * The base table of the entity, if the entity has storage. + * + * @var string + */ + protected $baseTable; + + /** * The table that stores revisions, if the entity supports revisions. * * @var string @@ -79,13 +88,28 @@ class ContentEntityDatabaseStorage extends ContentEntityStorageBase { protected $fieldInfo; /** + * The entity manager. + * + * @var \Drupal\Core\Entity\EntityManagerInterface + */ + protected $entityManager; + + /** + * The entity schema builder. + * + * @var \Drupal\Core\Entity\Schema\ContentEntitySchemaHandlerInterface + */ + protected $schemaBuilder; + + /** * {@inheritdoc} */ public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) { return new static( $entity_type, $container->get('database'), - $container->get('field.info') + $container->get('field.info'), + $container->get('entity.manager') ); } @@ -98,12 +122,15 @@ public static function createInstance(ContainerInterface $container, EntityTypeI * The database connection to be used. * @param \Drupal\field\FieldInfo $field_info * The field info service. + * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager + * The entity manager. */ - public function __construct(EntityTypeInterface $entity_type, Connection $database, FieldInfo $field_info) { + public function __construct(EntityTypeInterface $entity_type, Connection $database, FieldInfo $field_info, EntityManagerInterface $entity_manager) { parent::__construct($entity_type); $this->database = $database; $this->fieldInfo = $field_info; + $this->entityManager = $entity_manager; // Check if the entity type supports IDs. if ($this->entityType->hasKey('id')) { @@ -113,6 +140,11 @@ public function __construct(EntityTypeInterface $entity_type, Connection $databa // Check if the entity type supports UUIDs. $this->uuidKey = $this->entityType->getKey('uuid'); + // Some entity types are not stored in the database at all. + if ($base_table = $this->entityType->getBaseTable()) { + $this->baseTable = $base_table; + } + // Check if the entity type supports revisions. if ($this->entityType->hasKey('revision')) { $this->revisionKey = $this->entityType->getKey('revision'); @@ -209,6 +241,7 @@ public function load($id) { */ protected function mapFromStorageRecords(array $records) { $entities = array(); + $field_definitions = $this->entityManager->getBaseFieldDefinitions($this->entityTypeId); foreach ($records as $id => $record) { $entities[$id] = array(); // Skip the item delta and item value levels (if possible) but let the @@ -219,12 +252,28 @@ protected function mapFromStorageRecords(array $records) { // that store several properties). if ($field_name = strstr($name, '__', TRUE)) { $property_name = substr($name, strpos($name, '__') + 2); - $entities[$id][$field_name][Language::LANGCODE_DEFAULT][$property_name] = $value; + + $field_definition = $field_definitions[$field_name]; + $serialize = !empty($field_definition->getColumns()[$property_name]['serialize']); + $entities[$id][$field_name][Language::LANGCODE_DEFAULT][$property_name] = $serialize ? unserialize($value) : $value; } else { // Handle columns named directly after the field (e.g if the field - // type only stores one property). - $entities[$id][$name][Language::LANGCODE_DEFAULT] = $value; + // type only stores one property). We allow for storage controllers to + // have schema fields which are not entity fields, which can be useful + // for normalization purposes. The 'default_langcode' field, for + // example, is simply a denormalization of checking the language code + // in the data table against the language code in the base table and + // similarly the 'isDefaultRevision' field (which we add as a query + // expression in FieldableDatabaseStorageController::buildQuery()) is + // a denormalization of checking the revision ID in the revision table + // against the revision ID in the base table. + $serialize = FALSE; + if (isset($field_definitions[$name])) { + $field_definition = $field_definitions[$name]; + $serialize = !empty($field_definition->getColumns()[$field_definition->getMainPropertyName()]['serialize']); + } + $entities[$id][$name][Language::LANGCODE_DEFAULT] = $serialize ? unserialize($value) : $value; } } // If we have no multilingual values we can instantiate entity objecs @@ -265,15 +314,18 @@ protected function attachPropertyData(array &$entities) { } $data = $query->execute(); - $field_definitions = \Drupal::entityManager()->getBaseFieldDefinitions($this->entityTypeId); + $field_definitions = $this->entityManager->getBaseFieldDefinitions($this->entityTypeId); + + $table_mapping = $this->getTableMapping(); $translations = array(); if ($this->revisionDataTable) { - $data_column_names = array_flip(array_diff(drupal_schema_fields_sql($this->entityType->getRevisionDataTable()), drupal_schema_fields_sql($this->entityType->getBaseTable()))); + $data_column_names = call_user_func_array('array_merge', array_diff_key($table_mapping['revision_data_table'], $table_mapping['base_table'])); } else { - $data_column_names = array_flip(drupal_schema_fields_sql($this->entityType->getDataTable())); + $data_column_names = call_user_func_array('array_merge', $table_mapping['data_table']); } + $data_column_names = array_combine($data_column_names, $data_column_names); foreach ($data as $values) { $id = $values[$this->idKey]; @@ -403,11 +455,12 @@ protected function buildQuery($ids, $revision_id = FALSE) { } // Add fields from the {entity} table. - $entity_fields = drupal_schema_fields_sql($this->entityType->getBaseTable()); + $table_mapping = $this->getTableMapping(); + $entity_fields = call_user_func_array('array_merge', $table_mapping['base_table']); if ($this->revisionTable) { // Add all fields from the {entity_revision} table. - $entity_revision_fields = drupal_schema_fields_sql($this->entityType->getRevisionTable()); + $entity_revision_fields = call_user_func_array('array_merge', $table_mapping['revision_table']); $entity_revision_fields = array_combine($entity_revision_fields, $entity_revision_fields); // The ID field is provided by entity, so remove it. unset($entity_revision_fields[$this->idKey]); @@ -552,7 +605,12 @@ public function save(EntityInterface $entity) { if (!$entity->isNew()) { if ($entity->isDefaultRevision()) { - $return = drupal_write_record($this->entityType->getBaseTable(), $record, $this->idKey); + $this->database + ->update($this->baseTable) + ->fields((array) $record) + ->condition($this->idKey, $record->{$this->idKey}) + ->execute(); + $return = SAVED_UPDATED; } else { // @todo, should a different value be returned when saving an entity @@ -560,7 +618,7 @@ public function save(EntityInterface $entity) { $return = FALSE; } if ($this->revisionTable) { - $record->{$this->revisionKey} = $this->saveRevision($entity); + $entity->{$this->revisionKey}->value = $this->saveRevision($entity); } if ($this->dataTable) { $this->savePropertyData($entity); @@ -582,7 +640,17 @@ public function save(EntityInterface $entity) { // Ensure the entity is still seen as new after assigning it an id, // while storing its data. $entity->enforceIsNew(); - $return = drupal_write_record($this->entityType->getBaseTable(), $record); + $insert_id = $this->database + ->insert($this->baseTable, array('return' => Database::RETURN_INSERT_ID)) + ->fields((array) $record) + ->execute(); + // Even if this is a new entity, the ID key might have been set in which + // case we should not override the provided ID. An empty value for the + // id is interpreted as NULL and thus overriden. + if (empty($record->{$this->idKey})) { + $record->{$this->idKey} = $insert_id; + } + $return = SAVED_NEW; $entity->{$this->idKey}->value = (string) $record->{$this->idKey}; if ($this->revisionTable) { $entity->setNewRevision(); @@ -595,7 +663,6 @@ public function save(EntityInterface $entity) { $this->savePropertyData($entity, 'revision_data_table'); } - $entity->enforceIsNew(FALSE); $this->invokeFieldMethod('insert', $entity); $this->saveFieldItems($entity, FALSE); @@ -670,18 +737,40 @@ protected function mapToStorageRecord(EntityInterface $entity, $table_key = 'bas $record = new \stdClass(); $values = array(); $definitions = $entity->getFieldDefinitions(); - $schema = drupal_get_schema($this->entityType->get($table_key)); + + $table_name = $this->entityType->get($table_key); + $schema = $this->schemaBuilder()->getSchema()[$table_name]; + $is_new = $entity->isNew(); $multi_column_fields = array(); - foreach (drupal_schema_fields_sql($this->entityType->get($table_key)) as $name) { + foreach (array_keys($schema['fields']) as $name) { // Check for fields which store data in multiple columns and process them // separately. if ($field = strstr($name, '__', TRUE)) { $multi_column_fields[$field] = TRUE; continue; } - $values[$name] = isset($definitions[$name]) && isset($entity->$name->value) ? $entity->$name->value : NULL; + $value = isset($definitions[$name]) && isset($entity->$name->value) ? $entity->$name->value : NULL; + + // We allow for storage controllers to have schema fields which are not + // entity fields, which can be useful for normalization purposes. The + // 'default_langcode' field, for example, is simply a denormalization of + // checking the language code in the data table against the language code + // in the base table and similarly the 'isDefaultRevision' field (which we + // add as a query expression in + // FieldableDatabaseStorageController::buildQuery()) is a denormalization + // of checking the revision ID in the revision table against the revision + // ID in the base table. + $serialize = FALSE; + if (isset($definitions[$name])) { + $definition = $definitions[$name]; + // Since this is not a multi-column field we can assume there is only + // one column. + $serialize = !empty($definition->getColumns()[$definition->getMainPropertyName()]['serialize']); + } + + $values[$name] = $serialize ? serialize($value) : $value; } // Handle fields that store multiple properties and match each property name @@ -689,9 +778,10 @@ protected function mapToStorageRecord(EntityInterface $entity, $table_key = 'bas foreach (array_keys($multi_column_fields) as $field_name) { $field_items = $entity->get($field_name); $field_value = $field_items->getValue(); - foreach (array_keys($field_items->getFieldDefinition()->getColumns()) as $field_schema_column) { - if (isset($schema['fields'][$field_name . '__' . $field_schema_column])) { - $values[$field_name . '__' . $field_schema_column] = isset($field_value[0][$field_schema_column]) ? $field_value[0][$field_schema_column] : NULL; + foreach ($field_items->getFieldDefinition()->getColumns() as $column_name => $column_info) { + if (isset($schema['fields'][$field_name . '__' . $column_name])) { + $value = isset($field_value[0][$column_name]) ? $field_value[0][$column_name] : NULL; + $values[$field_name . '__' . $column_name] = !empty($column_info['serialize']) ? serialize($value) : $value; } } } @@ -747,7 +837,15 @@ protected function saveRevision(EntityInterface $entity) { $entity->preSaveRevision($this, $record); if ($entity->isNewRevision()) { - drupal_write_record($this->revisionTable, $record); + $insert_id = $this->database + ->insert($this->revisionTable, array('return' => Database::RETURN_INSERT_ID)) + ->fields((array) $record) + ->execute(); + // Even if this is a new revsision, the revision ID key might have been + // set in which case we should not override the provided revision ID. + if (!isset($record->{$this->revisionKey})) { + $record->{$this->revisionKey} = $insert_id; + } if ($entity->isDefaultRevision()) { $this->database->update($this->entityType->getBaseTable()) ->fields(array($this->revisionKey => $record->{$this->revisionKey})) @@ -756,7 +854,11 @@ protected function saveRevision(EntityInterface $entity) { } } else { - drupal_write_record($this->revisionTable, $record, $this->revisionKey); + $this->database + ->update($this->revisionTable) + ->fields((array) $record) + ->condition($this->revisionKey, $record->{$this->revisionKey}) + ->execute(); } // Make sure to update the new revision key for the entity. @@ -1456,4 +1558,28 @@ static public function _fieldColumnName(FieldConfigInterface $field, $column) { return in_array($column, FieldConfig::getReservedColumns()) ? $column : $field->getName() . '_' . $column; } + /** + * Gets the schema builder for this storage controller. + */ + protected function schemaBuilder() { + if (!isset($this->schemaBuilder)) { + $this->schemaBuilder = new ContentEntitySchemaHandler($this->entityManager, $this->entityType); + } + return $this->schemaBuilder; + } + + /** + * {@inheritdoc} + */ + public function getTableMapping() { + return $this->schemaBuilder()->getTableMapping(); + } + + /** + * {@inheritdoc} + */ + public function getSchema() { + return $this->schemaBuilder()->getSchema(); + } + } diff --git a/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php index ee2bebc..5276c26 100644 --- a/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php +++ b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php @@ -12,6 +12,7 @@ use Drupal\Core\Entity\ContentEntityDatabaseStorage; use Drupal\Core\Entity\Plugin\DataType\EntityReference; use Drupal\Core\Entity\Query\QueryException; +use Drupal\Core\Entity\SqlStorageInterface; use Drupal\field\Entity\FieldConfig; use Drupal\field\Field as FieldInfo; @@ -35,7 +36,6 @@ class Tables implements TablesInterface { */ protected $entityTables = array(); - /** * Field table array, key is table name, value is alias. * @@ -46,10 +46,18 @@ class Tables implements TablesInterface { protected $fieldTables = array(); /** + * The entity manager. + * + * @var \Drupal\Core\Entity\EntityManager + */ + protected $entityManager; + + /** * @param \Drupal\Core\Database\Query\SelectInterface $sql_query */ public function __construct(SelectInterface $sql_query) { $this->sqlQuery = $sql_query; + $this->entityManager = \Drupal::entityManager(); } /** @@ -57,7 +65,6 @@ public function __construct(SelectInterface $sql_query) { */ public function addField($field, $type, $langcode) { $entity_type_id = $this->sqlQuery->getMetaData('entity_type'); - $entity_manager = \Drupal::entityManager(); $field_info = FieldInfo::fieldInfo(); $age = $this->sqlQuery->getMetaData('age'); // This variable ensures grouping works correctly. For example: @@ -74,7 +81,7 @@ public function addField($field, $type, $langcode) { // This will contain the definitions of the last specifier seen by the // system. $propertyDefinitions = array(); - $entity_type = $entity_manager->getDefinition($entity_type_id); + $entity_type = $this->entityManager->getDefinition($entity_type_id); // Use the lightweight and fast field map for checking whether a specifier // is a field or not. While calling field_info_field() on every specifier // delivers the same information, if no specifiers are using the field API @@ -141,7 +148,7 @@ public function addField($field, $type, $langcode) { if ($bundle_key = $entity_type->getKey('bundle')) { $values[$bundle_key] = reset($field_map[$entity_type_id][$field_name]['bundles']); } - $entity = $entity_manager + $entity = $this->entityManager ->getStorage($entity_type_id) ->create($values); $propertyDefinitions = $entity->$field_name->getFieldDefinition()->getPropertyDefinitions(); @@ -174,10 +181,10 @@ public function addField($field, $type, $langcode) { $entity_tables = array(); if ($data_table = $entity_type->getDataTable()) { $this->sqlQuery->addMetaData('simple_query', FALSE); - $entity_tables[$data_table] = drupal_get_schema($data_table); + $entity_tables[$data_table] = $this->getTableSchema($data_table); } $entity_base_table = $entity_type->getBaseTable(); - $entity_tables[$entity_base_table] = drupal_get_schema($entity_base_table); + $entity_tables[$entity_base_table] = $this->getTableSchema($entity_base_table); $sql_column = $specifier; $table = $this->ensureEntityTable($index_prefix, $specifier, $type, $langcode, $base_table, $entity_id_field, $entity_tables); } @@ -195,7 +202,7 @@ public function addField($field, $type, $langcode) { $bundles = entity_get_bundles($entity_type_id); $values[$bundle_key] = key($bundles); } - $entity = $entity_manager + $entity = $this->entityManager ->getStorage($entity_type_id) ->create($values); $propertyDefinitions = $entity->$specifier->getFieldDefinition()->getPropertyDefinitions(); @@ -206,7 +213,7 @@ public function addField($field, $type, $langcode) { if (isset($propertyDefinitions[$relationship_specifier]) && $entity->get($specifier)->first()->get('entity') instanceof EntityReference) { // If it is, use the entity type. $entity_type_id = $propertyDefinitions[$relationship_specifier]->getTargetDefinition()->getEntityTypeId(); - $entity_type = $entity_manager->getDefinition($entity_type_id); + $entity_type = $this->entityManager->getDefinition($entity_type_id); // Add the new entity base table using the table and sql column. $join_condition= '%alias.' . $entity_type->getKey('id') . " = $table.$sql_column"; $base_table = $this->sqlQuery->leftJoin($entity_type->getBaseTable(), NULL, $join_condition); @@ -272,4 +279,26 @@ protected function addJoin($type, $table, $join_condition, $langcode) { return $this->sqlQuery->addJoin($type, $table, NULL, $join_condition, $arguments); } + /** + * Returns the schema for the given table. + * + * @param string $table + * The table name. + * + * @return array|bool + * The schema for the given table or FALSE if not available. + */ + protected function getTableSchema($table) { + $entity_type_id = $this->sqlQuery->getMetaData('entity_type'); + $storage = $this->entityManager->getStorage($entity_type_id); + // @todo Stop calling drupal_get_schema() once menu links are converted + // to the Entity Field API. See https://drupal.org/node/1842858. + $schema = drupal_get_schema($table); + if (!$schema && $storage instanceof SqlStorageInterface) { + $storage_schema = $storage->getSchema(); + $schema = isset($storage_schema[$table]) ? $storage_schema[$table] : FALSE; + } + return $schema; + } + } diff --git a/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandler.php b/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandler.php new file mode 100644 index 0000000..463e84c --- /dev/null +++ b/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandler.php @@ -0,0 +1,553 @@ +entityType = $entity_type; + $this->fieldDefinitions = $entity_manager->getBaseFieldDefinitions($entity_type->id()); + + $this->entityKeys = array_filter(array( + 'id' => $this->entityType->getKey('id'), + 'revision' => $this->entityType->getKey('revision'), + 'bundle' => $this->entityType->getKey('bundle'), + 'uuid' => $this->entityType->getKey('uuid'), + )); + // @todo This will become unnecessary once https://drupal.org/node/2143729 + // has landed. + if ($this->entityType->getDataTable()) { + $this->entityKeys['langcode'] = 'langcode'; + $this->entityKeys['default_langcode'] = 'default_langcode'; + } + } + + /** + * Returns the current layout type. + * + * @return int + * An integer value identifiying the current layour type. + * + * @see static::LAYOUT_BASE + * @see static::LAYOUT_REV + * @see static::LAYOUT_MUL + * @see static::LAYOUT_MULREV + */ + public function getLayoutType() { + if (!isset($this->layoutType)) { + $this->layoutType = static::LAYOUT_BASE; + if ($this->entityType->hasKey('revision')) { + $this->layoutType |= static::LAYOUT_REV; + } + if ($this->entityType->isTranslatable()) { + $this->layoutType |= static::LAYOUT_MUL; + } + } + return $this->layoutType; + } + + /** + * {@inheritdoc} + */ + public function getTableMapping() { + if (!isset($this->tableMapping)) { + $tables = $this->getTables(); + + if (empty($tables)) { + $table_mapping = array(); + } + // @todo Remove this. This is currently needed because some entity types + // declare a schema that does not match their field definitions. + // Therefore we use the legacy schema if it's still declared. This + // allows to iteratively enable the automatic schema generation for all + // entity types. + elseif ($base_schema = drupal_get_schema($tables['base_table'])) { + foreach (array_keys($base_schema['fields']) as $field_name) { + $table_mapping['base_table'][$field_name] = array($field_name); + } + if (isset($tables['revision_table'])) { + foreach (array_keys(drupal_get_schema($tables['revision_table'])['fields']) as $field_name) { + $table_mapping['revision_table'][$field_name] = array($field_name); + } + } + if (isset($tables['data_table'])) { + foreach (array_keys(drupal_get_schema($tables['data_table'])['fields']) as $field_name) { + $table_mapping['data_table'][$field_name] = array($field_name); + } + } + if (isset($tables['revision_data_table'])) { + foreach (array_keys(drupal_get_schema($tables['revision_data_table'])['fields']) as $field_name) { + $table_mapping['revision_data_table'][$field_name] = array($field_name); + } + } + } + else { + $entity_keys = $this->entityKeys; + unset($entity_keys['default_langcode']); + $key_fields = array_values($entity_keys); + + $storable_definitions = array_filter($this->fieldDefinitions, function (FieldDefinitionInterface $field_definition) { + return !$field_definition->isComputed() && !$field_definition->hasCustomStorage(); + }); + $storable_fields = array_keys($storable_definitions); + + // @todo Provide automatic definitions for revision metadata fields. + // Rename 'log' to 'revision_log'. + $revision_metadata_fields = array('revision_timestamp', 'revision_uid', 'log'); + $revisionable_filter_callback = function (FieldDefinitionInterface $definition) { return $definition->isRevisionable(); }; + + $this->getLayoutType(); + switch (TRUE) { + // The base layout stores all the base field values in the base table. + case $this->layoutType == static::LAYOUT_BASE: + $table_mapping['base_table'] = $this->processFields(array_merge($key_fields, array_diff($storable_fields, $key_fields))); + break; + + // The base layout stores all the base field values in the base table. + // Revisionable fields are also stored in the revision table. + case $this->layoutType == static::LAYOUT_REV: + $table_mapping['base_table'] = $this->processFields(array_merge($key_fields, array_diff($storable_fields, $key_fields, $revision_metadata_fields))); + $revision_key_fields = array($this->entityKeys['id'], $this->entityKeys['revision']); + $revisionable_fields = array_keys(array_filter($storable_definitions, $revisionable_filter_callback)); + $table_mapping['revision_table'] = $this->processFields(array_merge($revision_key_fields, $revisionable_fields)); + break; + + // Multilingual layouts store key field values in the base table. The + // other base field values are stored in the data table, no matter + // whether they are translatable or not. The data table holds also a + // denormalized copy of the bundle field value to allow for more + // performant queries. + case $this->layoutType == static::LAYOUT_MUL: + $table_mapping['base_table'] = $this->processFields($key_fields); + $data_key_fields = array_diff($key_fields, array('uuid')); + $data_fields = array_diff($storable_fields, $key_fields); + $table_mapping['data_table'] = $this->processFields(array_merge($data_key_fields, $data_fields)); + break; + + // The revisionable multilingual layout stores key field values in the + // base table, except for language, which is stored in the revision + // table along with revision metadata. The revision data table holds + // data field values for all the available revisions without + // denormalizations. + case $this->layoutType == static::LAYOUT_MULREV: + $table_mapping['base_table'] = $this->processFields(array_diff($key_fields, array($this->entityKeys['langcode']))); + $data_key_fields = array_diff($key_fields, array('uuid')); + $data_fields = array_diff($storable_fields, $key_fields, $revision_metadata_fields); + $table_mapping['data_table'] = $this->processFields(array_merge($data_key_fields, $data_fields)); + $table_mapping['revision_table'] = $this->processFields(array_merge(array($this->entityKeys['id'], $this->entityKeys['revision'], $this->entityKeys['langcode']), $revision_metadata_fields)); + $revision_data_key_fields = array_diff($key_fields, array($this->entityKeys['bundle'], $this->entityKeys['uuid'])); + $revisionable_fields = array_keys(array_filter($storable_definitions, $revisionable_filter_callback)); + $revision_data_fields = array_diff($revisionable_fields, $revision_metadata_fields, $revision_data_key_fields); + $table_mapping['revision_data_table'] = $this->processFields(array_merge($revision_data_key_fields, $revision_data_fields)); + break; + } + } + + $this->tableMapping = $table_mapping; + } + + return $this->tableMapping; + } + + /** + * Returns a mapping between field and column names. + * + * @param array $field_names + * An array of names of fields to map. + * + * @return array + * An associative array of arrays of column names keyed by field name. + */ + protected function processFields($field_names) { + $mapping = array(); + foreach ($field_names as $field_name) { + $columns = isset($this->fieldDefinitions[$field_name]) ? array_keys($this->fieldDefinitions[$field_name]->getColumns()) : array(); + if (count($columns) > 1) { + foreach ($columns as $column) { + $mapping[$field_name][] = $field_name . '__' . $column; + } + } + else { + $mapping[$field_name] = array($field_name); + } + } + return $mapping; + } + + /** + * {@inheritdoc} + */ + public function getSchema() { + // Prepare basic information about the entity type. + $tables = $this->getTables(); + // If this entity type does not support storage, no schema information can + // be collected. + if (empty($tables)) { + $this->schema[$this->entityType->id()] = NULL; + } + + if (!isset($this->schema[$this->entityType->id()])) { + // @todo Remove this. This is currently needed because some entity types + // declare a schema that does not match their field definitions. + // Therefore we use the legacy schema if it's still declared. This + // allows to iteratively enable the automatic schema generation for all + // entity types. + if ($base_schema = drupal_get_schema($tables['base_table'])) { + $schema[$tables['base_table']] = $base_schema; + unset($tables['base_table']); + foreach ($tables as $table) { + $schema[$table] = drupal_get_schema($table); + } + } + else { + // Initialize the table schema. + $schema[$tables['base_table']] = $this->initializeBaseTable(); + if (isset($tables['revision_table'])) { + $schema[$tables['revision_table']] = $this->initializeRevisionTable(); + } + if (isset($tables['data_table'])) { + $schema[$tables['data_table']] = $this->initializeDataTable(); + } + if (isset($tables['revision_data_table'])) { + $schema[$tables['revision_data_table']] = $this->initializeRevisionDataTable(); + } + + // Add the schema from field definitions. + foreach ($this->getTableMapping() as $table_key => $field_names) { + foreach ($field_names as $field_name => $column_names) { + $table = $tables[$table_key]; + $this->addFieldSchema($schema[$table], $field_name); + } + } + + // Process tables after having gathered field information. + $this->processBaseTable($schema[$tables['base_table']]); + if (isset($tables['revision_table'])) { + $this->processRevisionTable($schema[$tables['revision_table']]); + } + if (isset($tables['data_table'])) { + $this->processDataTable($schema[$tables['data_table']]); + } + if (isset($tables['revision_data_table'])) { + $this->processRevisionDataTable($schema[$tables['revision_data_table']]); + } + } + + $this->schema[$this->entityType->id()] = $schema; + } + + return $this->schema[$this->entityType->id()]; + } + + /** + * Gets a list of entity type tables. + * + * @return array + * A list of entity type tables, keyed by table key. + */ + protected function getTables() { + return array_filter(array( + 'base_table' => $this->entityType->getBaseTable(), + 'revision_table' => $this->entityType->getRevisionTable(), + 'data_table' => $this->entityType->getDataTable(), + 'revision_data_table' => $this->entityType->getRevisionDataTable(), + )); + } + + /** + * Returns the schema for a single field definition. + * + * @param array $schema + * The table schema to add the field schema to, passed by reference. + * @param string $field_name + * The name of the field. + * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition + * The field definition to return the schema for. + */ + protected function addFieldSchema(array &$schema, $field_name) { + $field_definition = $this->fieldDefinitions[$field_name]; + $field_schema = $field_definition->getSchema(); + if (count($field_schema['columns']) == 1) { + $schema['fields'][$field_name] = $field_schema['columns'][$field_definition->getMainPropertyName()]; + $schema['fields'][$field_name]['description'] = $field_definition->getDescription(); + + // Only entity keys are required. + $schema['fields'][$field_name]['not null'] = !empty($this->entityKeys[$field_name]); + + if (!empty($field_schema['unique keys'])) { + $schema['unique keys'][$field_name] = array($field_name); + } + if (!empty($field_schema['indexes'])) { + // @todo Support indexes specified as an array of column name and + // length. + $schema['indexes'][$field_name] = array($field_name); + } + if (!empty($field_schema['foreign keys'])) { + $schema += array('foreign keys' => array()); + $schema['foreign keys'] += $field_schema['foreign keys']; + } + } + else { + foreach ($field_schema['columns'] as $column_name => $column_schema) { + // Only entity keys are required. + $column_schema['not null'] = !empty($this->entityKeys[$field_name]); + $schema['fields'][$field_name . '__' . $column_name] = $column_schema; + } + } + + // @todo Descriptions, unique keys, indexes and foreign keys. + } + + /** + * Returns the schema for the 'default_langcode' metadata field. + * + * @return array + * A schema field array for the 'default_langcode' metadata field. + */ + protected function getDefaultLangcodeSchema() { + return array( + 'description' => 'Boolean indicating whether field values are in the default entity language.', + 'type' => 'int', + 'not null' => TRUE, + 'default' => 1, + ); + } + + /** + * Initializes common information for a base table. + * + * @return array + * A partial schema array for the base table. + */ + protected function initializeBaseTable() { + return array( + 'description' => "The base table for {$this->entityType->id()} entities.", + 'primary key' => array($this->entityKeys['id']), + ); + } + + /** + * Initializes common information for a revision table. + * + * @return array + * A partial schema array for the revision table. + */ + protected function initializeRevisionTable() { + $id_key = $this->entityKeys['id']; + return array( + 'description' => "The revision table for {$this->entityType->id()} entities.", + 'primary key' => array($this->entityKeys['revision']), + 'foreign keys' => array( + $id_key => array( + 'table' => $this->entityType->getBaseTable(), + 'columns' => array($id_key => $id_key), + ), + ), + ); + } + + /** + * Initializes common information for a data table. + * + * @return array + * A partial schema array for the data table. + */ + protected function initializeDataTable() { + $id_key = $this->entityKeys['id']; + + return array( + 'description' => "The data table for {$this->entityType->id()} entities.", + // @todo Use the language entity key when https://drupal.org/node/2143729 + // is in. + 'primary key' => array($id_key, 'langcode'), + 'foreign keys' => array( + $id_key => array( + 'table' => $this->entityType->getBaseTable(), + 'columns' => array($id_key => $id_key), + ), + ), + ); + } + + /** + * Initializes common information for a revision data table. + * + * @return array + * A partial schema array for the revision data table. + */ + protected function initializeRevisionDataTable() { + $id_key = $this->entityKeys['id']; + $revision_key = $this->entityKeys['revision'];; + return array( + 'description' => "The revision data table for {$this->entityType->id()} entities.", + // @todo Use the language entity key when https://drupal.org/node/2143729 + // is in. + 'primary key' => array($revision_key, 'langcode'), + 'foreign keys' => array( + $id_key => array( + 'table' => $this->entityType->getBaseTable(), + 'columns' => array($id_key => $id_key), + ), + $revision_key => array( + 'table' => $this->entityType->getRevisionTable(), + 'columns' => array($revision_key => $revision_key), + ) + ), + ); + } + + /** + * Processes the gathered schema for a base table. + * + * @param array $schema + * The table schema, passed by reference. + * + * @return array + * A partial schema array for the base table. + */ + protected function processBaseTable(array &$schema) { + $id_key = $this->entityKeys['id']; + // Change the ID field in the base table to 'serial' if it is 'int'. + if ($schema['fields'][$id_key]['type'] == 'int') { + $schema['fields'][$id_key]['type'] = 'serial'; + unset($schema['fields'][$id_key]['default']); + } + } + + /** + * Processes the gathered schema for a base table. + * + * @param array $schema + * The table schema, passed by reference. + * + * @return array + * A partial schema array for the base table. + */ + protected function processRevisionTable(array &$schema) { + $revision_key = $this->entityKeys['revision']; + // Change the revision ID field in the revision table 'serial' if it is + // 'int'. + if ($schema['fields'][$revision_key]['type'] == 'int') { + $schema['fields'][$revision_key]['type'] = 'serial'; + unset($schema['fields'][$revision_key]['default']); + } + } + + /** + * Processes the gathered schema for a base table. + * + * @param array $schema + * The table schema, passed by reference. + * + * @return array + * A partial schema array for the base table. + */ + protected function processDataTable(array &$schema) { + $schema['fields']['default_langcode'] = $this->getDefaultLangcodeSchema(); + } + + /** + * Processes the gathered schema for a base table. + * + * @param array $schema + * The table schema, passed by reference. + * + * @return array + * A partial schema array for the base table. + */ + protected function processRevisionDataTable(array &$schema) { + $schema['fields']['default_langcode'] = $this->getDefaultLangcodeSchema(); + } + +} diff --git a/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandlerInterface.php b/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandlerInterface.php new file mode 100644 index 0000000..0be1b3d --- /dev/null +++ b/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandlerInterface.php @@ -0,0 +1,31 @@ +statistics = $comment_statistics; } @@ -54,6 +57,7 @@ public static function createInstance(ContainerInterface $container, EntityTypeI $entity_info, $container->get('database'), $container->get('field.info'), + $container->get('entity.manager'), $container->get('comment.statistics') ); } diff --git a/core/modules/entity/entity.module b/core/modules/entity/entity.module index d01563b..8cea4dd 100644 --- a/core/modules/entity/entity.module +++ b/core/modules/entity/entity.module @@ -9,6 +9,7 @@ */ use Drupal\Core\Config\Entity\ConfigEntityStorage; +use Drupal\Core\Entity\SqlStorageInterface; /** * Implements hook_help(). @@ -129,16 +130,57 @@ function entity_entity_bundle_delete($entity_type_id, $bundle) { } /** + * Implements hook_module_preinstall(). + */ +function entity_module_preinstall($module) { + // Install entity type tables. + $entity_manager = \Drupal::entityManager(); + $entity_manager->clearCachedDefinitions(); + $schema = \Drupal::database()->schema(); + + foreach ($entity_manager->getDefinitions() as $entity_type_id => $entity_type) { + if ($entity_type->getProvider() == $module) { + $storage = $entity_manager->getStorage($entity_type_id); + if ($storage instanceof SqlStorageInterface) { + foreach ($storage->getSchema() as $table_name => $table_schema) { + // Some test entity types share the same schema so we need a check to + // avoid attempting to create the schema more than once, which would + // result in an error. + // @todo Remove the drupal_get_schema() call once all entity types + // have been converted to an automatic schema. + if (!drupal_get_schema($table_name) && !$schema->tableExists($table_name)) { + $schema->createTable($table_name, $table_schema); + } + } + } + } + } +} + +/** * Implements hook_module_preuninstall(). */ function entity_module_preuninstall($module) { - // Clean up all entity bundles (including field instances) of every entity - // type provided by the module that is being uninstalled. - foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) { + $entity_manager = \Drupal::entityManager(); + $schema = \Drupal::database()->schema(); + + foreach ($entity_manager->getDefinitions() as $entity_type_id => $entity_type) { if ($entity_type->getProvider() == $module) { - foreach (array_keys(entity_get_bundles($entity_type_id)) as $bundle) { + // Clean up all entity bundles (including field instances) of every entity + // type provided by the module that is being uninstalled. + foreach (array_keys($entity_manager->getBundleInfo($entity_type_id)) as $bundle) { entity_invoke_bundle_hook('delete', $entity_type_id, $bundle); } + + // Remove entity tables. + $storage = $entity_manager->getStorage($entity_type->id()); + if ($storage instanceof SqlStorageInterface) { + foreach ($storage->getSchema() as $table_name => $table_schema) { + if ($schema->tableExists($table_name)) { + $schema->dropTable($table_name, $table_schema); + } + } + } } } } diff --git a/core/modules/shortcut/lib/Drupal/shortcut/Entity/Shortcut.php b/core/modules/shortcut/lib/Drupal/shortcut/Entity/Shortcut.php index eaf7079..a1001a4 100644 --- a/core/modules/shortcut/lib/Drupal/shortcut/Entity/Shortcut.php +++ b/core/modules/shortcut/lib/Drupal/shortcut/Entity/Shortcut.php @@ -95,8 +95,7 @@ public function setRouteName($route_name) { * {@inheritdoc} */ public function getRouteParams() { - $value = $this->get('route_parameters')->getValue(); - return reset($value); + return $this->get('route_parameters')->getValue(); } /** @@ -170,10 +169,6 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { ->setLabel(t('Language code')) ->setDescription(t('The language code of the shortcut.')); - $fields['default_langcode'] = FieldDefinition::create('boolean') - ->setLabel(t('Default language')) - ->setDescription(t('Flag to indicate whether this is the default language.')); - $fields['path'] = FieldDefinition::create('string') ->setLabel(t('Path')) ->setDescription(t('The computed shortcut path.')) diff --git a/core/modules/simpletest/lib/Drupal/simpletest/DrupalUnitTestBase.php b/core/modules/simpletest/lib/Drupal/simpletest/DrupalUnitTestBase.php index 7737cc8..9585ff7 100644 --- a/core/modules/simpletest/lib/Drupal/simpletest/DrupalUnitTestBase.php +++ b/core/modules/simpletest/lib/Drupal/simpletest/DrupalUnitTestBase.php @@ -7,8 +7,10 @@ namespace Drupal\simpletest; +use Drupal\Component\Utility\String; use Drupal\Core\DependencyInjection\ContainerBuilder; use Drupal\Core\DrupalKernel; +use Drupal\Core\Entity\SqlStorageInterface; use Drupal\Core\KeyValueStore\KeyValueMemoryFactory; use Drupal\Core\Language\Language; use Symfony\Component\DependencyInjection\Reference; @@ -332,6 +334,36 @@ protected function installSchema($module, $tables) { } /** + * Installs the tables for a specific entity type. + * + * @param string $entity_type_id + * The ID of the entity type. + */ + protected function installEntitySchema($entity_type_id) { + /** @var \Drupal\Core\Entity\EntityManagerInterface $entity_manager */ + $entity_manager = $this->container->get('entity.manager'); + /** @var \Drupal\Core\Database\Schema $schema_handler */ + $schema_handler = $this->container->get('database')->schema(); + + $storage = $entity_manager->getStorage($entity_type_id); + if ($storage instanceof SqlStorageInterface) { + $schema = $storage->getSchema(); + foreach ($schema as $table_name => $table_schema) { + $schema_handler->createTable($table_name, $table_schema); + } + $this->pass(String::format('Installed entity type tables for the %entity_type entity type: %tables', array( + '%entity_type' => $entity_type_id, + '%tables' => '{' . implode('}, {', array_keys($schema)) . '}', + ))); + } + else { + throw new \RuntimeException(String::format('Entity type %entity_type does not support automatic schema installation.', array( + '%entity-type' => $entity_type_id, + ))); + } + } + + /** * Enables modules for this test. * * @param array $modules diff --git a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityApiTest.php b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityApiTest.php index a9f0105..5d2364c 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityApiTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityApiTest.php @@ -25,16 +25,10 @@ public static function getInfo() { public function setUp() { parent::setUp(); - $this->installSchema('entity_test', array( - 'entity_test_mul', - 'entity_test_mul_property_data', - 'entity_test_rev', - 'entity_test_rev_revision', - 'entity_test_mulrev', - 'entity_test_mulrev_revision', - 'entity_test_mulrev_property_data', - 'entity_test_mulrev_property_revision' - )); + + $this->installEntitySchema('entity_test_rev'); + $this->installEntitySchema('entity_test_mul'); + $this->installEntitySchema('entity_test_mulrev'); } /** diff --git a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityFieldTest.php b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityFieldTest.php index 61c8c87..7435100 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityFieldTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityFieldTest.php @@ -42,16 +42,10 @@ public function setUp() { parent::setUp(); $this->installSchema('user', array('users_data')); $this->installSchema('node', array('node', 'node_revision', 'node_field_data', 'node_field_revision', 'node_access')); - $this->installSchema('entity_test', array( - 'entity_test_mul', - 'entity_test_mul_property_data', - 'entity_test_rev', - 'entity_test_rev_revision', - 'entity_test_mulrev', - 'entity_test_mulrev_revision', - 'entity_test_mulrev_property_data', - 'entity_test_mulrev_property_revision' - )); + + $this->installEntitySchema('entity_test_rev'); + $this->installEntitySchema('entity_test_mul'); + $this->installEntitySchema('entity_test_mulrev'); // Create the test field. entity_test_install(); diff --git a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityLanguageTestBase.php b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityLanguageTestBase.php index bd2ceb9..db45c92 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityLanguageTestBase.php +++ b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityLanguageTestBase.php @@ -50,16 +50,10 @@ function setUp() { $this->languageManager = $this->container->get('language_manager'); - $this->installSchema('entity_test', array( - 'entity_test_mul', - 'entity_test_mul_property_data', - 'entity_test_rev', - 'entity_test_rev_revision', - 'entity_test_mulrev', - 'entity_test_mulrev_revision', - 'entity_test_mulrev_property_data', - 'entity_test_mulrev_property_revision', - )); + $this->installEntitySchema('entity_test_rev'); + $this->installEntitySchema('entity_test_mul'); + $this->installEntitySchema('entity_test_mulrev'); + $this->installConfig(array('language')); // Create the test field. diff --git a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityQueryTest.php b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityQueryTest.php index 70f180e..4c2220f 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityQueryTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityQueryTest.php @@ -57,7 +57,9 @@ public static function getInfo() { function setUp() { parent::setUp(); - $this->installSchema('entity_test', array('entity_test_mulrev', 'entity_test_mulrev_revision', 'entity_test_mulrev_property_data', 'entity_test_mulrev_property_revision')); + + $this->installEntitySchema('entity_test_mulrev'); + $this->installConfig(array('language')); $figures = drupal_strtolower($this->randomName()); diff --git a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUUIDTest.php b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUUIDTest.php index ec7134c..a0ec726 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUUIDTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUUIDTest.php @@ -23,16 +23,9 @@ public static function getInfo() { public function setUp() { parent::setUp(); - $this->installSchema('entity_test', array( - 'entity_test_mul', - 'entity_test_mul_property_data', - 'entity_test_rev', - 'entity_test_rev_revision', - 'entity_test_mulrev', - 'entity_test_mulrev_revision', - 'entity_test_mulrev_property_data', - 'entity_test_mulrev_property_revision', - )); + $this->installEntitySchema('entity_test_rev'); + $this->installEntitySchema('entity_test_mul'); + $this->installEntitySchema('entity_test_mulrev'); } /** diff --git a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUnitTestBase.php b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUnitTestBase.php index 99fe76a..ffeb3c8 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUnitTestBase.php +++ b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUnitTestBase.php @@ -44,7 +44,9 @@ public function setUp() { $this->installSchema('user', array('users', 'users_roles')); $this->installSchema('system', 'sequences'); - $this->installSchema('entity_test', 'entity_test'); + + $this->installEntitySchema('entity_test'); + $this->installConfig(array('field')); } diff --git a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityValidationTest.php b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityValidationTest.php index 118abe9..169ab3d 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Entity/EntityValidationTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Entity/EntityValidationTest.php @@ -38,16 +38,10 @@ public static function getInfo() { public function setUp() { parent::setUp(); $this->installSchema('user', array('users_data')); - $this->installSchema('entity_test', array( - 'entity_test_mul', - 'entity_test_mul_property_data', - 'entity_test_rev', - 'entity_test_rev_revision', - 'entity_test_mulrev', - 'entity_test_mulrev_revision', - 'entity_test_mulrev_property_data', - 'entity_test_mulrev_property_revision' - )); + + $this->installEntitySchema('entity_test_rev'); + $this->installEntitySchema('entity_test_mul'); + $this->installEntitySchema('entity_test_mulrev'); // Create the test field. entity_test_install(); diff --git a/core/modules/system/lib/Drupal/system/Tests/Entity/FieldSqlStorageTest.php b/core/modules/system/lib/Drupal/system/Tests/Entity/FieldSqlStorageTest.php index 82e63b2..de4aa63 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Entity/FieldSqlStorageTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Entity/FieldSqlStorageTest.php @@ -66,7 +66,8 @@ public static function getInfo() { function setUp() { parent::setUp(); - $this->installSchema('entity_test', array('entity_test_rev', 'entity_test_rev_revision')); + + $this->installEntitySchema('entity_test_rev'); $entity_type = 'entity_test_rev'; $this->field_name = strtolower($this->randomName()); diff --git a/core/modules/system/tests/modules/entity_test/entity_test.install b/core/modules/system/tests/modules/entity_test/entity_test.install index 9e48029..f2db594 100644 --- a/core/modules/system/tests/modules/entity_test/entity_test.install +++ b/core/modules/system/tests/modules/entity_test/entity_test.install @@ -36,406 +36,3 @@ function entity_test_install() { ->save(); } } - -/** - * Implements hook_schema(). - */ -function entity_test_schema() { - // Schema for simple entity. - $schema['entity_test'] = array( - 'description' => 'Stores entity_test items.', - 'fields' => array( - 'id' => array( - 'type' => 'serial', - 'not null' => TRUE, - 'description' => 'Primary Key: Unique entity-test item ID.', - ), - 'uuid' => array( - 'description' => 'Unique Key: Universally unique identifier for this entity.', - 'type' => 'varchar', - 'length' => 128, - 'not null' => FALSE, - ), - 'type' => array( - 'description' => 'The bundle of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'langcode' => array( - 'description' => 'The {language}.langcode of the original variant of this test entity.', - 'type' => 'varchar', - 'length' => 12, - 'not null' => TRUE, - 'default' => '', - ), - 'name' => array( - 'description' => 'The name of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'user_id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => FALSE, - 'default' => NULL, - 'description' => 'The {users}.uid of the associated user.', - ), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'uuid' => array('uuid'), - ), - ); - - // Schema for entity with revisions. - $schema['entity_test_rev'] = array( - 'description' => 'Stores entity_test_rev items.', - 'fields' => array( - 'id' => array( - 'type' => 'serial', - 'not null' => TRUE, - 'description' => 'Primary Key: Unique entity-test item ID.', - ), - 'revision_id' => array( - 'description' => 'The current {entity_test_rev_property_revision}.revision_id version identifier.', - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'default' => 0, - ), - 'uuid' => array( - 'description' => 'Unique Key: Universally unique identifier for this entity.', - 'type' => 'varchar', - 'length' => 128, - 'not null' => FALSE, - ), - 'type' => array( - 'description' => 'The bundle of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'name' => array( - 'description' => 'The name of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'user_id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => FALSE, - 'default' => NULL, - 'description' => 'The {users}.uid of the associated user.', - ), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'uuid' => array('uuid'), - ), - ); - $schema['entity_test_rev_revision'] = array( - 'description' => 'Stores entity_test_rev item property revisions.', - 'fields' => array( - 'id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The {entity_test_rev}.id of the test entity.', - ), - 'revision_id' => array( - 'type' => 'serial', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The primary identifier for this version.', - ), - 'langcode' => array( - 'description' => 'The {language}.langcode of this variant of this test entity.', - 'type' => 'varchar', - 'length' => 12, - 'not null' => TRUE, - 'default' => '', - ), - 'name' => array( - 'description' => 'The name of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'user_id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => FALSE, - 'default' => NULL, - 'description' => 'The {users}.uid of the associated user.', - ), - ), - 'indexes' => array( - 'user_id' => array('user_id'), - ), - 'foreign keys' => array( - 'user_id' => array('users' => 'uid'), - 'id' => array('entity_test_rev' => 'id'), - ), - 'primary key' => array('revision_id'), - ); - - // Schema for entity with data table. - $schema['entity_test_mul'] = array( - 'description' => 'Stores entity_test_mul items.', - 'fields' => array( - 'id' => array( - 'type' => 'serial', - 'not null' => TRUE, - 'description' => 'Primary Key: Unique entity-test item ID.', - ), - 'uuid' => array( - 'description' => 'Unique Key: Universally unique identifier for this entity.', - 'type' => 'varchar', - 'length' => 128, - 'not null' => FALSE, - ), - 'type' => array( - 'description' => 'The bundle of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'langcode' => array( - 'description' => 'The {language}.langcode of the original variant of this test entity.', - 'type' => 'varchar', - 'length' => 12, - 'not null' => TRUE, - 'default' => '', - ), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'uuid' => array('uuid'), - ), - ); - $schema['entity_test_mul_property_data'] = array( - 'description' => 'Stores entity_test_mul item properties.', - 'fields' => array( - 'id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The {entity_test_mul}.id of the test entity.', - ), - 'langcode' => array( - 'description' => 'The {language}.langcode of this variant of this test entity.', - 'type' => 'varchar', - 'length' => 12, - 'not null' => TRUE, - 'default' => '', - ), - 'default_langcode' => array( - 'description' => 'Boolean indicating whether the current variant is in the original entity language.', - 'type' => 'int', - 'not null' => TRUE, - 'default' => 1, - ), - 'name' => array( - 'description' => 'The name of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => FALSE, - ), - 'user_id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => FALSE, - 'default' => NULL, - 'description' => 'The {users}.uid of the associated user.', - ), - ), - 'indexes' => array( - 'user_id' => array('user_id'), - ), - 'foreign keys' => array( - 'user_id' => array('users' => 'uid'), - 'id' => array('entity_test_mul' => 'id'), - ), - 'primary key' => array('id', 'langcode'), - ); - - // Schema for entity with data table and revisions. - $schema['entity_test_mulrev'] = array( - 'description' => 'Stores entity_test_mulrev items.', - 'fields' => array( - 'id' => array( - 'type' => 'serial', - 'not null' => TRUE, - 'description' => 'Primary Key: Unique entity-test item ID.', - ), - 'revision_id' => array( - 'description' => 'The current {entity_test_mulrev_property_revision}.revision_id version identifier.', - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'default' => 0, - ), - 'uuid' => array( - 'description' => 'Unique Key: Universally unique identifier for this entity.', - 'type' => 'varchar', - 'length' => 128, - 'not null' => FALSE, - ), - 'type' => array( - 'description' => 'The bundle of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'uuid' => array('uuid'), - ), - ); - $schema['entity_test_mulrev_revision'] = array( - 'description' => 'Stores entity_test_rev item property revisions.', - 'fields' => array( - 'id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The {entity_test_rev}.id of the test entity.', - ), - 'revision_id' => array( - 'type' => 'serial', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The primary identifier for this version.', - ), - 'langcode' => array( - 'description' => 'The {language}.langcode of this variant of this test entity.', - 'type' => 'varchar', - 'length' => 12, - 'not null' => TRUE, - 'default' => '', - ), - ), - 'foreign keys' => array( - 'id' => array('entity_test_rev' => 'id'), - ), - 'primary key' => array('revision_id'), - ); - $schema['entity_test_mulrev_property_data'] = array( - 'description' => 'Stores entity_test_mulrev item properties.', - 'fields' => array( - 'id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The {entity_test_mulrev}.id of the test entity.', - ), - 'revision_id' => array( - 'description' => 'The current {entity_test_mulrev_property_revision}.revision_id version identifier.', - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'default' => 0, - ), - 'langcode' => array( - 'description' => 'The {language}.langcode of this variant of this test entity.', - 'type' => 'varchar', - 'length' => 12, - 'not null' => TRUE, - 'default' => '', - ), - 'default_langcode' => array( - 'description' => 'Boolean indicating whether the current variant is in the original entity language.', - 'type' => 'int', - 'not null' => TRUE, - 'default' => 1, - ), - 'name' => array( - 'description' => 'The name of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'user_id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => FALSE, - 'default' => NULL, - 'description' => 'The {users}.uid of the associated user.', - ), - ), - 'indexes' => array( - 'user_id' => array('user_id'), - ), - 'foreign keys' => array( - 'user_id' => array('users' => 'uid'), - 'id' => array('entity_test_mulrev' => 'id'), - ), - 'primary key' => array('id', 'langcode'), - ); - $schema['entity_test_mulrev_property_revision'] = array( - 'description' => 'Stores entity_test_mulrev item property revisions.', - 'fields' => array( - 'id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The {entity_test_mulrev}.id of the test entity.', - ), - 'revision_id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The primary identifier for this version.', - ), - 'langcode' => array( - 'description' => 'The {language}.langcode of this variant of this test entity.', - 'type' => 'varchar', - 'length' => 12, - 'not null' => TRUE, - 'default' => '', - ), - 'default_langcode' => array( - 'description' => 'Boolean indicating whether the current variant is in the original entity language.', - 'type' => 'int', - 'not null' => TRUE, - 'default' => 1, - ), - 'name' => array( - 'description' => 'The name of the test entity.', - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - ), - 'user_id' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => FALSE, - 'default' => NULL, - 'description' => 'The {users}.uid of the associated user.', - ), - ), - 'indexes' => array( - 'user_id' => array('user_id'), - ), - 'foreign keys' => array( - 'user_id' => array('users' => 'uid'), - 'id' => array('entity_test_mulrev' => 'id'), - ), - 'primary key' => array('revision_id', 'langcode'), - ); - - return $schema; -} diff --git a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTest.php b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTest.php index 55a1611..bc2d36a 100644 --- a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTest.php +++ b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTest.php @@ -86,7 +86,8 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { $fields['type'] = FieldDefinition::create('string') ->setLabel(t('Type')) ->setDescription(t('The bundle of the test entity.')) - ->setRequired(TRUE); + ->setRequired(TRUE) + ->setSetting('max_length', 32); $fields['user_id'] = FieldDefinition::create('entity_reference') ->setLabel(t('User ID')) diff --git a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestBaseFieldDisplay.php b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestBaseFieldDisplay.php index c76cff7..6b7100a 100644 --- a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestBaseFieldDisplay.php +++ b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestBaseFieldDisplay.php @@ -28,7 +28,6 @@ * entity_keys = { * "id" = "id", * "uuid" = "uuid", - * "revision" = "revision_id", * "bundle" = "type" * }, * links = { diff --git a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestLabelCallback.php b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestLabelCallback.php index 481711f..e881b9a 100644 --- a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestLabelCallback.php +++ b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestLabelCallback.php @@ -15,7 +15,6 @@ * label = @Translation("Entity test label callback"), * field_cache = FALSE, * base_table = "entity_test", - * revision_table = "entity_test_revision", * label_callback = "entity_test_label_callback", * fieldable = TRUE, * entity_keys = { diff --git a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestMul.php b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestMul.php index 49f7d5f..bec368c 100644 --- a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestMul.php +++ b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestMul.php @@ -44,17 +44,4 @@ */ class EntityTestMul extends EntityTest { - /** - * {@inheritdoc} - */ - public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { - $fields = parent::baseFieldDefinitions($entity_type); - - $fields['default_langcode'] = FieldDefinition::create('boolean') - ->setLabel(t('Default language')) - ->setDescription(t('Flag to indicate whether this is the default language.')); - - return $fields; - } - } diff --git a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestMulRev.php b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestMulRev.php index 870af93..d1ea8da 100644 --- a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestMulRev.php +++ b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestMulRev.php @@ -44,22 +44,4 @@ */ class EntityTestMulRev extends EntityTestRev { - /** - * {@inheritdoc} - */ - public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { - $fields = parent::baseFieldDefinitions($entity_type); - - $fields['revision_id'] = FieldDefinition::create('integer') - ->setLabel(t('Revision ID')) - ->setDescription(t('The version id of the test entity.')) - ->setReadOnly(TRUE); - - $fields['default_langcode'] = FieldDefinition::create('boolean') - ->setLabel(t('Default language')) - ->setDescription(t('Flag to indicate whether this is the default language.')); - - return $fields; - } - } diff --git a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestRev.php b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestRev.php index b6b660e..6f98e44 100644 --- a/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestRev.php +++ b/core/modules/system/tests/modules/entity_test/lib/Drupal/entity_test/Entity/EntityTestRev.php @@ -60,6 +60,25 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { ->setDescription(t('The version id of the test entity.')) ->setReadOnly(TRUE); + $fields['revision_timestamp'] = FieldDefinition::create('timestamp') + ->setLabel(t('Revision timestamp')) + ->setDescription(t('The time that the current revision was created.')) + ->setQueryable(FALSE) + ->setRevisionable(TRUE); + + $fields['revision_uid'] = FieldDefinition::create('entity_reference') + ->setLabel(t('Revision user ID')) + ->setDescription(t('The user ID of the author of the current revision.')) + ->setSettings(array('target_type' => 'user')) + ->setQueryable(FALSE) + ->setRevisionable(TRUE); + + $fields['log'] = FieldDefinition::create('string') + ->setLabel(t('Log')) + ->setDescription(t('The log entry explaining the changes in this revision.')) + ->setRevisionable(TRUE) + ->setTranslatable(TRUE); + $fields['langcode']->setRevisionable(TRUE); $fields['name']->setRevisionable(TRUE); $fields['user_id']->setRevisionable(TRUE); diff --git a/core/modules/user/lib/Drupal/user/UserStorage.php b/core/modules/user/lib/Drupal/user/UserStorage.php index d3f4990..81266b4 100644 --- a/core/modules/user/lib/Drupal/user/UserStorage.php +++ b/core/modules/user/lib/Drupal/user/UserStorage.php @@ -9,7 +9,9 @@ use Drupal\Component\Uuid\UuidInterface; use Drupal\Core\Entity\EntityInterface; +use Drupal\Core\Entity\EntityManagerInterface; use Drupal\Core\Entity\EntityTypeInterface; +use Drupal\Core\Entity\Schema\ContentEntitySchemaHandlerInterface; use Drupal\Core\Password\PasswordInterface; use Drupal\Core\Database\Connection; use Drupal\field\FieldInfo; @@ -48,15 +50,17 @@ class UserStorage extends ContentEntityDatabaseStorage implements UserStorageInt * The database connection to be used. * @param \Drupal\field\FieldInfo $field_info * The field info service. - * @param \Drupal\Component\Uuid\UuidInterface $uuid_service - * The UUID Service. + * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager + * The entity manager. + * @param \Drupal\Core\Entity\Schema\ContentEntitySchemaHandlerInterface $schema_builder + * The entity schema builder. * @param \Drupal\Core\Password\PasswordInterface $password * The password hashing service. * @param \Drupal\user\UserDataInterface $user_data * The user data service. */ - public function __construct(EntityTypeInterface $entity_type, Connection $database, FieldInfo $field_info, UuidInterface $uuid_service, PasswordInterface $password, UserDataInterface $user_data) { - parent::__construct($entity_type, $database, $field_info, $uuid_service); + public function __construct(EntityTypeInterface $entity_type, Connection $database, FieldInfo $field_info, EntityManagerInterface $entity_manager, PasswordInterface $password, UserDataInterface $user_data) { + parent::__construct($entity_type, $database, $field_info, $entity_manager); $this->password = $password; $this->userData = $user_data; @@ -70,7 +74,7 @@ public static function createInstance(ContainerInterface $container, EntityTypeI $entity_type, $container->get('database'), $container->get('field.info'), - $container->get('uuid'), + $container->get('entity.manager'), $container->get('password'), $container->get('user.data') );