class TermStorageSchema
Same name in other branches
- 8.9.x core/modules/taxonomy/src/TermStorageSchema.php \Drupal\taxonomy\TermStorageSchema
- 10 core/modules/taxonomy/src/TermStorageSchema.php \Drupal\taxonomy\TermStorageSchema
- 11.x core/modules/taxonomy/src/TermStorageSchema.php \Drupal\taxonomy\TermStorageSchema
Defines the term schema handler.
Hierarchy
- class \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema implements \Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Entity\Sql\SqlFieldableEntityTypeListenerTrait
- class \Drupal\taxonomy\TermStorageSchema extends \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema
Expanded class hierarchy of TermStorageSchema
File
-
core/
modules/ taxonomy/ src/ TermStorageSchema.php, line 12
Namespace
Drupal\taxonomyView source
class TermStorageSchema extends SqlContentEntityStorageSchema {
/**
* {@inheritdoc}
*/
protected function getEntitySchema(ContentEntityTypeInterface $entity_type, $reset = FALSE) {
$schema = parent::getEntitySchema($entity_type, $reset);
if ($data_table = $this->storage
->getDataTable()) {
$schema[$data_table]['indexes'] += [
'taxonomy_term__tree' => [
'vid',
'weight',
'name',
],
'taxonomy_term__vid_name' => [
'vid',
'name',
],
];
}
$schema['taxonomy_index'] = [
'description' => 'Maintains denormalized information about node/term relationships.',
'fields' => [
'nid' => [
'description' => 'The {node}.nid this record tracks.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
],
'tid' => [
'description' => 'The term ID.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
],
'status' => [
'description' => 'Boolean indicating whether the node is published (visible to non-administrators).',
'type' => 'int',
'not null' => TRUE,
'default' => 1,
],
'sticky' => [
'description' => 'Boolean indicating whether the node is sticky.',
'type' => 'int',
'not null' => FALSE,
'default' => 0,
'size' => 'tiny',
],
'created' => [
'description' => 'The Unix timestamp when the node was created.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
],
],
'primary key' => [
'nid',
'tid',
],
'indexes' => [
'term_node' => [
'tid',
'status',
'sticky',
'created',
],
],
'foreign keys' => [
'tracked_node' => [
'table' => 'node',
'columns' => [
'nid' => 'nid',
],
],
'term' => [
'table' => 'taxonomy_term_data',
'columns' => [
'tid' => 'tid',
],
],
],
];
return $schema;
}
/**
* {@inheritdoc}
*/
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 == 'taxonomy_term_field_data') {
// Remove unneeded indexes.
unset($schema['indexes']['taxonomy_term_field__vid__target_id']);
unset($schema['indexes']['taxonomy_term_field__description__format']);
switch ($field_name) {
case 'weight':
// Improves the performance of the taxonomy_term__tree index defined
// in getEntitySchema().
$schema['fields'][$field_name]['not null'] = TRUE;
break;
case 'name':
$this->addSharedTableFieldIndex($storage_definition, $schema, TRUE);
break;
}
}
return $schema;
}
/**
* {@inheritdoc}
*/
protected function getDedicatedTableSchema(FieldStorageDefinitionInterface $storage_definition, ContentEntityTypeInterface $entity_type = NULL) {
$dedicated_table_schema = parent::getDedicatedTableSchema($storage_definition, $entity_type);
// Add an index on 'bundle', 'delta' and 'parent_target_id' columns to
// increase the performance of the query from
// \Drupal\taxonomy\TermStorage::getVocabularyHierarchyType().
if ($storage_definition->getName() === 'parent') {
/** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
$table_mapping = $this->storage
->getTableMapping();
$dedicated_table_name = $table_mapping->getDedicatedDataTableName($storage_definition);
unset($dedicated_table_schema[$dedicated_table_name]['indexes']['bundle']);
$dedicated_table_schema[$dedicated_table_name]['indexes']['bundle_delta_target_id'] = [
'bundle',
'delta',
$table_mapping->getFieldColumnName($storage_definition, 'target_id'),
];
}
return $dedicated_table_schema;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | ||||
DependencySerializationTrait::$_serviceIds | protected | property | ||||
DependencySerializationTrait::__sleep | public | function | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
SqlContentEntityStorageSchema::$database | protected | property | The database connection to be used. | |||
SqlContentEntityStorageSchema::$deletedFieldsRepository | protected | property | The deleted fields repository. | |||
SqlContentEntityStorageSchema::$entityFieldManager | protected | property | The entity field manager service. | |||
SqlContentEntityStorageSchema::$entityType | protected | property | The entity type this schema builder is responsible for. | |||
SqlContentEntityStorageSchema::$entityTypeManager | protected | property | The entity type manager. | |||
SqlContentEntityStorageSchema::$fieldStorageDefinitions | protected | property | The storage field definitions for this entity type. | |||
SqlContentEntityStorageSchema::$installedStorageSchema | protected | property | The key-value collection for tracking installed storage schema. | |||
SqlContentEntityStorageSchema::$schema | protected | property | A static cache of the generated schema array. | |||
SqlContentEntityStorageSchema::$storage | protected | property | The storage object for the given entity type. | |||
SqlContentEntityStorageSchema::$updateBackupRepository | protected | property | The key-value collection for tracking entity update backup repository. | |||
SqlContentEntityStorageSchema::addIndex | protected | function | Creates an index, dropping it if already existing. | |||
SqlContentEntityStorageSchema::addSharedTableFieldForeignKey | protected | function | Adds a foreign key for the specified field to the given schema definition. | |||
SqlContentEntityStorageSchema::addSharedTableFieldIndex | protected | function | Adds an index for the specified field to the given schema definition. | |||
SqlContentEntityStorageSchema::addSharedTableFieldUniqueKey | protected | function | Adds a unique key for the specified field to the given schema definition. | |||
SqlContentEntityStorageSchema::addTableDefaults | protected | function | Adds defaults to a table schema definition. | |||
SqlContentEntityStorageSchema::addUniqueKey | protected | function | Creates a unique key, dropping it if already existing. | |||
SqlContentEntityStorageSchema::castValue | public static | function | Typecasts values to the proper data type. | |||
SqlContentEntityStorageSchema::checkEntityType | protected | function | Checks that we are dealing with the correct entity type. | |||
SqlContentEntityStorageSchema::createDedicatedTableSchema | protected | function | Creates the schema for a field stored in a dedicated table. | |||
SqlContentEntityStorageSchema::createEntitySchemaIndexes | protected | function | Creates the specified entity schema indexes and keys. | |||
SqlContentEntityStorageSchema::createSharedTableSchema | protected | function | Creates the schema for a field stored in a shared table. | |||
SqlContentEntityStorageSchema::deleteDedicatedTableSchema | protected | function | Deletes the schema for a field stored in a dedicated table. | |||
SqlContentEntityStorageSchema::deletedFieldsRepository | protected | function | Gets the deleted fields repository. | |||
SqlContentEntityStorageSchema::deleteEntitySchemaData | protected | function | Deletes schema data for the given entity type definition. | |||
SqlContentEntityStorageSchema::deleteEntitySchemaIndexes | protected | function | Deletes the specified entity schema indexes and keys. | |||
SqlContentEntityStorageSchema::deleteFieldSchemaData | protected | function | Deletes schema data for the given field storage definition. | |||
SqlContentEntityStorageSchema::deleteSharedTableSchema | protected | function | Deletes the schema for a field stored in a shared table. | |||
SqlContentEntityStorageSchema::finalizePurge | public | function | Performs final cleanup after all data of a field has been purged. | Overrides DynamicallyFieldableEntityStorageSchemaInterface::finalizePurge | ||
SqlContentEntityStorageSchema::getColumnSchemaRelevantKeys | protected | function | Returns a list of column schema keys affecting data storage. | |||
SqlContentEntityStorageSchema::getEntityIndexName | protected | function | Gets the name to be used for the given entity index. | |||
SqlContentEntityStorageSchema::getEntitySchemaData | protected | function | Gets entity schema definitions for index and key definitions. | |||
SqlContentEntityStorageSchema::getEntitySchemaTables | protected | function | Gets a list of entity type tables. | |||
SqlContentEntityStorageSchema::getFieldForeignKeys | protected | function | Gets field foreign keys. | |||
SqlContentEntityStorageSchema::getFieldIndexes | protected | function | Gets an index schema array for a given field. | |||
SqlContentEntityStorageSchema::getFieldIndexName | protected | function | Generates an index name for a field data table. | |||
SqlContentEntityStorageSchema::getFieldSchemaData | protected | function | Gets field schema data for the given key. | |||
SqlContentEntityStorageSchema::getFieldSchemaIdentifierName | protected | function | Generates a safe schema identifier (name of an index, column name etc.). | |||
SqlContentEntityStorageSchema::getFieldUniqueKeys | protected | function | Gets a unique key schema array for a given field. | |||
SqlContentEntityStorageSchema::getSchemaFromStorageDefinition | protected | function | Gets the schema data for the given field storage definition. | |||
SqlContentEntityStorageSchema::getSelectQueryForFieldStorageDeletion | protected | function | Returns a SELECT query suitable for inserting data into a dedicated table. | |||
SqlContentEntityStorageSchema::getTableMapping | protected | function | Refreshes the table mapping with updated definitions. | |||
SqlContentEntityStorageSchema::getTableNames | private | function | Gets a list of table names for this entity type, field storage and mapping. | |||
SqlContentEntityStorageSchema::getTemporaryTableMappingPrefix | public static | function | Gets a string to be used as a prefix for a temporary table mapping object. | |||
SqlContentEntityStorageSchema::handleEntityTypeSchemaUpdateExceptionOnDataCopy | protected | function | Handles the case when an error occurs during the data copying step. | Overrides SqlFieldableEntityTypeListenerTrait::handleEntityTypeSchemaUpdateExceptionOnDataCopy | ||
SqlContentEntityStorageSchema::hasColumnChanges | protected | function | Compares schemas to check for changes in the column definitions. | |||
SqlContentEntityStorageSchema::hasNullFieldPropertyData | protected | function | Checks whether a field property has NULL values. | |||
SqlContentEntityStorageSchema::hasSharedTableNameChanges | protected | function | Detects whether any table name got renamed in an entity type update. | |||
SqlContentEntityStorageSchema::hasSharedTableStructureChange | protected | function | Detects whether there is a change in the shared table structure. | |||
SqlContentEntityStorageSchema::initializeBaseTable | protected | function | Initializes common information for a base table. | |||
SqlContentEntityStorageSchema::initializeDataTable | protected | function | Initializes common information for a data table. | |||
SqlContentEntityStorageSchema::initializeRevisionDataTable | protected | function | Initializes common information for a revision data table. | |||
SqlContentEntityStorageSchema::initializeRevisionTable | protected | function | Initializes common information for a revision table. | |||
SqlContentEntityStorageSchema::installedStorageSchema | protected | function | Gets the keyvalue collection for tracking the installed schema. | |||
SqlContentEntityStorageSchema::isTableEmpty | protected | function | Checks whether a database table is non-existent or empty. | |||
SqlContentEntityStorageSchema::loadEntitySchemaData | protected | function | Loads stored schema data for the given entity type definition. | |||
SqlContentEntityStorageSchema::loadFieldSchemaData | protected | function | Loads stored schema data for the given field storage definition. | |||
SqlContentEntityStorageSchema::onEntityTypeCreate | public | function | Reacts to the creation of the entity type. | Overrides EntityTypeListenerInterface::onEntityTypeCreate | ||
SqlContentEntityStorageSchema::onEntityTypeDelete | public | function | Reacts to the deletion of the entity type. | Overrides EntityTypeListenerInterface::onEntityTypeDelete | ||
SqlContentEntityStorageSchema::onEntityTypeUpdate | public | function | Reacts to the update of the entity type. | Overrides EntityTypeListenerInterface::onEntityTypeUpdate | ||
SqlContentEntityStorageSchema::onFieldableEntityTypeCreate | public | function | Reacts to the creation of the fieldable entity type. | Overrides EntityTypeListenerInterface::onFieldableEntityTypeCreate | ||
SqlContentEntityStorageSchema::onFieldableEntityTypeUpdate | public | function | Reacts to the update of a fieldable entity type. | Overrides EntityTypeListenerInterface::onFieldableEntityTypeUpdate | ||
SqlContentEntityStorageSchema::onFieldStorageDefinitionCreate | public | function | Reacts to the creation of a field storage definition. | Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionCreate | ||
SqlContentEntityStorageSchema::onFieldStorageDefinitionDelete | public | function | Reacts to the deletion of a field storage definition. | Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionDelete | ||
SqlContentEntityStorageSchema::onFieldStorageDefinitionUpdate | public | function | Reacts to the update of a field storage definition. | Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionUpdate | ||
SqlContentEntityStorageSchema::performFieldSchemaOperation | protected | function | Performs the specified operation on a field. | |||
SqlContentEntityStorageSchema::postUpdateEntityTypeSchema | protected | function | Allows subscribers to do any cleanup necessary after data copying. | Overrides SqlFieldableEntityTypeListenerTrait::postUpdateEntityTypeSchema | ||
SqlContentEntityStorageSchema::preUpdateEntityTypeSchema | protected | function | Allows subscribers to prepare their schema before data copying. | Overrides SqlFieldableEntityTypeListenerTrait::preUpdateEntityTypeSchema | ||
SqlContentEntityStorageSchema::processDataTable | protected | function | Processes the gathered schema for a base table. | |||
SqlContentEntityStorageSchema::processFieldStorageSchema | protected | function | Processes the schema for a field storage definition. | |||
SqlContentEntityStorageSchema::processIdentifierSchema | protected | function | Processes the specified entity key. | |||
SqlContentEntityStorageSchema::processRevisionDataTable | protected | function | Processes the gathered schema for a base table. | |||
SqlContentEntityStorageSchema::requiresEntityDataMigration | public | function | Checks if existing data would be lost if the schema changes were applied. | Overrides EntityStorageSchemaInterface::requiresEntityDataMigration | ||
SqlContentEntityStorageSchema::requiresEntityStorageSchemaChanges | public | function | Checks if the changes to the entity type requires storage schema changes. | Overrides EntityStorageSchemaInterface::requiresEntityStorageSchemaChanges | ||
SqlContentEntityStorageSchema::requiresFieldDataMigration | public | function | Checks if existing data would be lost if the schema changes were applied. | Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldDataMigration | ||
SqlContentEntityStorageSchema::requiresFieldStorageSchemaChanges | public | function | Checks if the changes to the storage definition requires schema changes. | Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldStorageSchemaChanges | ||
SqlContentEntityStorageSchema::saveEntitySchemaData | protected | function | Stores schema data for the given entity type definition. | |||
SqlContentEntityStorageSchema::saveFieldSchemaData | protected | function | Stores schema data for the given field storage definition. | |||
SqlContentEntityStorageSchema::updateBackupRepository | protected | function | Gets the key/value collection for tracking the entity update backups. | |||
SqlContentEntityStorageSchema::updateDedicatedTableSchema | protected | function | Updates the schema for a field stored in a shared table. | |||
SqlContentEntityStorageSchema::updateSharedTableSchema | protected | function | Updates the schema for a field stored in a shared table. | |||
SqlContentEntityStorageSchema::__construct | public | function | Constructs a SqlContentEntityStorageSchema. | |||
SqlFieldableEntityTypeListenerTrait::copyData | protected | function | Copies entity data from the original storage to the temporary one. | |||
SqlFieldableEntityTypeListenerTrait::onFieldableEntityTypeUpdate | public | function | Aliased as: traitOnFieldableEntityTypeUpdate | |||
TermStorageSchema::getDedicatedTableSchema | protected | function | Gets the SQL schema for a dedicated table. | Overrides SqlContentEntityStorageSchema::getDedicatedTableSchema | ||
TermStorageSchema::getEntitySchema | protected | function | Gets the entity schema for the specified entity type. | Overrides SqlContentEntityStorageSchema::getEntitySchema | ||
TermStorageSchema::getSharedTableFieldSchema | protected | function | Gets the schema for a single field definition. | Overrides SqlContentEntityStorageSchema::getSharedTableFieldSchema |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.