class Term

Drupal 6 taxonomy term source from database.

Available configuration keys:

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

Examples:

source:
  plugin: d6_taxonomy_term
  bundle: 0

In this example terms of vocabulary with 'vid' equal to 0 are retrieved from the source database.

source:
  plugin: d6_taxonomy_term
  bundle: [1, 3, 5]

In this example terms of vocabularies with 'vid' one of 1, 3, 5 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 = "d6_taxonomy_term",
  source_module = "taxonomy"
)

Attributes

#[ContentEntityType(id: 'taxonomy_term', label: new TranslatableMarkup('Taxonomy term'), label_collection: new TranslatableMarkup('Taxonomy terms'), label_singular: new TranslatableMarkup('taxonomy term'), label_plural: new TranslatableMarkup('taxonomy terms'), entity_keys: ['id' => 'tid', 'revision' => 'revision_id', 'bundle' => 'vid', 'label' => 'name', 'langcode' => 'langcode', 'uuid' => 'uuid', 'published' => 'status'], handlers: ['storage' => TermStorage::class, 'storage_schema' => TermStorageSchema::class, 'view_builder' => EntityViewBuilder::class, 'list_builder' => EntityListBuilder::class, 'access' => TermAccessControlHandler::class, 'views_data' => TermViewsData::class, 'form' => ['default' => TermForm::class, 'delete' => TermDeleteForm::class, 'revision-delete' => RevisionDeleteForm::class, 'revision-revert' => RevisionRevertForm::class], 'route_provider' => ['revision' => RevisionHtmlRouteProvider::class], 'translation' => TermTranslationHandler::class], links: ['canonical' => '/taxonomy/term/{taxonomy_term}', 'delete-form' => '/taxonomy/term/{taxonomy_term}/delete', 'edit-form' => '/taxonomy/term/{taxonomy_term}/edit', 'create' => '/taxonomy/term', 'revision' => '/taxonomy/term/{taxonomy_term}/revision/{taxonomy_term_revision}/view', 'revision-delete-form' => '/taxonomy/term/{taxonomy_term}/revision/{taxonomy_term_revision}/delete', 'revision-revert-form' => '/taxonomy/term/{taxonomy_term}/revision/{taxonomy_term_revision}/revert', 'version-history' => '/taxonomy/term/{taxonomy_term}/revisions'], collection_permission: 'access taxonomy overview', permission_granularity: 'bundle', bundle_entity_type: 'taxonomy_vocabulary', bundle_label: new TranslatableMarkup('Vocabulary'), base_table: 'taxonomy_term_data', data_table: 'taxonomy_term_field_data', revision_table: 'taxonomy_term_revision', revision_data_table: 'taxonomy_term_field_revision', translatable: TRUE, show_revision_ui: TRUE, label_count: ['singular' => '@count taxonomy term', 'plural' => '@count taxonomy terms'], field_ui_base_route: 'entity.taxonomy_vocabulary.overview_form', common_reference_target: TRUE, constraints: ['TaxonomyHierarchy' => []], revision_metadata_keys: ['revision_user' => 'revision_user', 'revision_created' => 'revision_created', 'revision_log_message' => 'revision_log_message'])]

Hierarchy

• class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
    • class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase extends \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface implements \Drupal\Core\Plugin\PluginBase
      • class \Drupal\migrate\Plugin\migrate\source\SqlBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface implements \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
        • class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase extends \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait implements \Drupal\migrate\Plugin\migrate\source\SqlBase
          • class \Drupal\taxonomy\Plugin\migrate\source\d6\Term implements \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase

Expanded class hierarchy of Term

See also

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

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

File

core/modules/taxonomy/src/Plugin/migrate/source/d6/Term.php, line 50

Namespace

class Term extends DrupalSqlBase {
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->select('term_data', 'td')
            ->fields('td')
            ->distinct()
            ->orderBy('td.tid');
        if (isset($this->configuration['bundle'])) {
            $query->condition('td.vid', (array) $this->configuration['bundle'], 'IN');
        }
        return $query;
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        $fields = [
            'tid' => $this->t('The term ID.'),
            'vid' => $this->t('Existing term VID'),
            '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."),
        ];
        if (isset($this->configuration['translations'])) {
            $fields['language'] = $this->t('The term language.');
            $fields['trid'] = $this->t('Translation ID.');
        }
        return $fields;
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        // Find parents for this row.
        $parents = $this->select('term_hierarchy', 'th')
            ->fields('th', [
            'parent',
            'tid',
        ])
            ->condition('tid', $row->getSourceProperty('tid'))
            ->execute()
            ->fetchCol();
        $row->setSourceProperty('parent', $parents);
        return parent::prepareRow($row);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['tid']['type'] = 'integer';
        return $ids;
    }

}

Members