class Term

Same name in this branch
  1. 9 core/modules/taxonomy/src/Entity/Term.php \Drupal\taxonomy\Entity\Term
  2. 9 core/modules/taxonomy/src/Plugin/views/argument_validator/Term.php \Drupal\taxonomy\Plugin\views\argument_validator\Term
  3. 9 core/modules/taxonomy/src/Plugin/migrate/source/d6/Term.php \Drupal\taxonomy\Plugin\migrate\source\d6\Term
Same name and namespace in other branches
  1. 8.9.x core/modules/taxonomy/src/Entity/Term.php \Drupal\taxonomy\Entity\Term
  2. 8.9.x core/modules/taxonomy/src/Plugin/views/argument_validator/Term.php \Drupal\taxonomy\Plugin\views\argument_validator\Term
  3. 8.9.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Term.php \Drupal\taxonomy\Plugin\migrate\source\d6\Term
  4. 8.9.x core/modules/taxonomy/src/Plugin/migrate/source/Term.php \Drupal\taxonomy\Plugin\migrate\source\Term
  5. 8.9.x core/modules/taxonomy/src/Plugin/migrate/source/d7/Term.php \Drupal\taxonomy\Plugin\migrate\source\d7\Term
  6. 10 core/modules/taxonomy/src/Entity/Term.php \Drupal\taxonomy\Entity\Term
  7. 10 core/modules/taxonomy/src/Plugin/migrate/source/d6/Term.php \Drupal\taxonomy\Plugin\migrate\source\d6\Term
  8. 10 core/modules/taxonomy/src/Plugin/migrate/source/d7/Term.php \Drupal\taxonomy\Plugin\migrate\source\d7\Term
  9. 11.x core/modules/taxonomy/src/Entity/Term.php \Drupal\taxonomy\Entity\Term
  10. 11.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Term.php \Drupal\taxonomy\Plugin\migrate\source\d6\Term
  11. 11.x core/modules/taxonomy/src/Plugin/migrate/source/d7/Term.php \Drupal\taxonomy\Plugin\migrate\source\d7\Term

Drupal 7 taxonomy term source from database.

Available configuration keys:

  • bundle: (optional) The taxonomy vocabulary (machine name) to filter terms retrieved from the source - can be a string or an array. If omitted, all terms are retrieved.

Examples:


source:
  plugin: d7_taxonomy_term
  bundle: tags

In this example terms of 'tags' vocabulary are retrieved from the source database.


source:
  plugin: d7_taxonomy_term
  bundle: [tags, forums]

In this example terms of 'tags' and 'forums' vocabularies are retrieved from the source database.

For additional configuration keys, refer to the parent classes.

@todo Support term_relation, term_synonym table if possible.

Plugin annotation


@MigrateSource(
  id = "d7_taxonomy_term",
  source_module = "taxonomy"
)

Hierarchy

Expanded class hierarchy of Term

See also

\Drupal\migrate\Plugin\migrate\source\SqlBase

\Drupal\migrate\Plugin\migrate\source\SourcePluginBase

14 string references to 'Term'
CommentTokenReplaceTest::testCommentTokenReplacement in core/modules/comment/tests/src/Functional/CommentTokenReplaceTest.php
Creates a comment, then tests the tokens generated from it.
comment_token_info in core/modules/comment/comment.tokens.inc
Implements hook_token_info().
CreateTestContentEntitiesTrait::createContent in core/modules/migrate_drupal/tests/src/Traits/CreateTestContentEntitiesTrait.php
Create several pieces of generic content.
CreateTestContentEntitiesTrait::createContentPostUpgrade in core/modules/migrate_drupal/tests/src/Traits/CreateTestContentEntitiesTrait.php
Create several pieces of generic content.
forum_views_data in core/modules/forum/forum.views.inc
Implements hook_views_data().

... See full list

File

core/modules/taxonomy/src/Plugin/migrate/source/d7/Term.php, line 48

Namespace

Drupal\taxonomy\Plugin\migrate\source\d7
View source
class Term extends FieldableEntity {
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->select('taxonomy_term_data', 'td')
            ->fields('td')
            ->distinct()
            ->orderBy('tid');
        $query->leftJoin('taxonomy_vocabulary', 'tv', '[td].[vid] = [tv].[vid]');
        $query->addField('tv', 'machine_name');
        if ($this->getDatabase()
            ->schema()
            ->fieldExists('taxonomy_vocabulary', 'i18n_mode')) {
            $query->addField('tv', 'i18n_mode');
        }
        if (isset($this->configuration['bundle'])) {
            $query->condition('tv.machine_name', (array) $this->configuration['bundle'], 'IN');
        }
        return $query;
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        $fields = [
            'tid' => $this->t('The term ID.'),
            'vid' => $this->t('Existing term VID'),
            'machine_name' => $this->t('Vocabulary machine name'),
            'name' => $this->t('The name of the term.'),
            'description' => $this->t('The term description.'),
            'weight' => $this->t('Weight'),
            'parent' => $this->t("The Drupal term IDs of the term's parents."),
            'format' => $this->t("Format of the term description."),
        ];
        return $fields;
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        $tid = $row->getSourceProperty('tid');
        $vocabulary = $row->getSourceProperty('machine_name');
        $default_language = (array) $this->variableGet('language_default', [
            'language' => 'en',
        ]);
        // If this entity was translated using Entity Translation, we need to get
        // its source language to get the field values in the right language.
        // The translations will be migrated by the d7_node_entity_translation
        // migration.
        $translatable_vocabularies = array_keys(array_filter($this->variableGet('entity_translation_taxonomy', [])));
        $entity_translatable = $this->isEntityTranslatable('taxonomy_term') && in_array($vocabulary, $translatable_vocabularies, TRUE);
        if ($entity_translatable) {
            $source_language = $this->getEntityTranslationSourceLanguage('taxonomy_term', $tid);
            $language = $entity_translatable && $source_language ? $source_language : $default_language['language'];
        }
        // If this is an i18n translation use the default language when i18n_mode
        // is localized.
        if ($row->get('i18n_mode')) {
            $language = $row->get('i18n_mode') === '1' ? $default_language['language'] : $row->get('language');
        }
        $language = $language ?? $default_language['language'];
        $row->setSourceProperty('language', $language);
        // Get Field API field values.
        foreach ($this->getFields('taxonomy_term', $vocabulary) as $field_name => $field) {
            // Ensure we're using the right language if the entity and the field are
            // translatable.
            $field_language = $entity_translatable && $field['translatable'] ? $language : NULL;
            $row->setSourceProperty($field_name, $this->getFieldValues('taxonomy_term', $field_name, $tid, NULL, $field_language));
        }
        // Find parents for this row.
        $parents = $this->select('taxonomy_term_hierarchy', 'th')
            ->fields('th', [
            'parent',
            'tid',
        ])
            ->condition('tid', $row->getSourceProperty('tid'))
            ->execute()
            ->fetchCol();
        $row->setSourceProperty('parent', $parents);
        // Determine if this is a forum container.
        $forum_container_tids = $this->variableGet('forum_containers', []);
        $current_tid = $row->getSourceProperty('tid');
        $row->setSourceProperty('is_container', in_array($current_tid, $forum_container_tids));
        // If the term name or term description were replaced by real fields using
        // the Drupal 7 Title module, use the fields value instead of the term name
        // or term description.
        if ($this->moduleExists('title')) {
            $name_field = $row->getSourceProperty('name_field');
            if (isset($name_field[0]['value'])) {
                $row->setSourceProperty('name', $name_field[0]['value']);
            }
            $description_field = $row->getSourceProperty('description_field');
            if (isset($description_field[0]['value'])) {
                $row->setSourceProperty('description', $description_field[0]['value']);
            }
            if (isset($description_field[0]['format'])) {
                $row->setSourceProperty('format', $description_field[0]['format']);
            }
        }
        return parent::prepareRow($row);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['tid']['type'] = 'integer';
        return $ids;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DrupalSqlBase::$entityTypeManager protected property The entity type manager.
DrupalSqlBase::$requirements protected property If the source provider is missing.
DrupalSqlBase::$systemData protected property The contents of the system table.
DrupalSqlBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 4
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 3
DrupalSqlBase::getModuleSchemaVersion protected function Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData public function Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists protected function Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet protected function Reads a variable from a source Drupal database.
DrupalSqlBase::__construct public function Overrides SqlBase::__construct 6
FieldableEntity::getEntityTranslationSourceLanguage protected function Gets an entity source language from the 'entity_translation' table.
FieldableEntity::getFields protected function Returns all non-deleted field instances attached to a specific entity type.
FieldableEntity::getFieldValues protected function Retrieves field values for a single field of a single entity.
FieldableEntity::isEntityTranslatable protected function Checks if an entity type uses Entity Translation.
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SourcePluginBase::$cache protected property The backend cache.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count. 1
SourcePluginBase::$cacheKey protected property Key to use for caching counts.
SourcePluginBase::$currentRow protected property The current row from the query.
SourcePluginBase::$currentSourceIds protected property The primary key of the current row.
SourcePluginBase::$highWaterProperty protected property Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage protected property The key-value storage for the high-water value.
SourcePluginBase::$idMap protected property The migration ID map.
SourcePluginBase::$iterator protected property The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded protected property Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration protected property The entity migration object.
SourcePluginBase::$moduleHandler protected property The module handler service. 2
SourcePluginBase::$originalHighWater protected property The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount protected property Whether this instance should not attempt to count the source. 1
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data. 1
SourcePluginBase::aboveHighWater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::count public function Gets the source count. 2
SourcePluginBase::current public function
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::getHighWater protected function The current value of the high water mark.
SourcePluginBase::getHighWaterField protected function Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty protected function Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage protected function Get the high water storage object.
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler protected function Gets the module handler.
SourcePluginBase::getSourceModule public function Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key public function Gets the iterator key.
SourcePluginBase::next public function
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater protected function Save the new high water mark.
SourcePluginBase::valid public function Checks whether the iterator is currently valid.
SqlBase::$batch protected property The count of the number of batches run.
SqlBase::$batchSize protected property Number of records to fetch from the database during each batch.
SqlBase::$database protected property The database object. 1
SqlBase::$query protected property The query string. 83
SqlBase::$state protected property State service for retrieving database info.
SqlBase::doCount protected function Gets the source count using countQuery(). Overrides SourcePluginBase::doCount 6
SqlBase::fetchNextBatch protected function Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow protected function Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase public function Gets the database connection object. 2
SqlBase::initializeIterator protected function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator 18
SqlBase::mapJoinable protected function Checks if we can join against the map table. 1
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
SqlBase::rewind public function Rewinds the iterator. Overrides SourcePluginBase::rewind
SqlBase::select protected function Wrapper for database select.
SqlBase::setUpDatabase protected function Gets a connection to the referenced database.
SqlBase::__sleep public function
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
Term::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields 2
Term::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds 2
Term::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow 2
Term::query public function Overrides SqlBase::query 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.