Same name in this branch
  1. 10 core/modules/taxonomy/src/Entity/Vocabulary.php \Drupal\taxonomy\Entity\Vocabulary
  2. 10 core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d6\Vocabulary
  3. 10 core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d7\Vocabulary
Same name and namespace in other branches
  1. 8.9.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d6\Vocabulary
  2. 9 core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d6\Vocabulary

Drupal 6 vocabularies source from database.

For available configuration keys, refer to the parent classes.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of Vocabulary

See also

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

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

1 file declares its use of Vocabulary
forum.module in core/modules/forum/forum.module
Provides discussion forums.
5 string references to 'Vocabulary'
taxonomy.schema.yml in core/modules/taxonomy/config/schema/taxonomy.schema.yml
core/modules/taxonomy/config/schema/taxonomy.schema.yml
taxonomy.views.schema.yml in core/modules/taxonomy/config/schema/taxonomy.views.schema.yml
core/modules/taxonomy/config/schema/taxonomy.views.schema.yml
TaxonomyIndexTid::buildExtraOptionsForm in core/modules/taxonomy/src/Plugin/views/filter/TaxonomyIndexTid.php
taxonomy_token_info in core/modules/taxonomy/taxonomy.tokens.inc
Implements hook_token_info().
Term::baseFieldDefinitions in core/modules/taxonomy/src/Entity/Term.php
Provides base field definitions for an entity type.

File

core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php, line 22

Namespace

Drupal\taxonomy\Plugin\migrate\source\d6
View source
class Vocabulary extends DrupalSqlBase {

  /**
   * {@inheritdoc}
   */
  public function query() {
    $query = $this
      ->select('vocabulary', 'v')
      ->fields('v', [
      'vid',
      'name',
      'description',
      'help',
      'relations',
      'hierarchy',
      'multiple',
      'required',
      'tags',
      'module',
      'weight',
    ]);
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'vid' => $this
        ->t('The vocabulary ID.'),
      'name' => $this
        ->t('The name of the vocabulary.'),
      'description' => $this
        ->t('The description of the vocabulary.'),
      'help' => $this
        ->t('Help text to display for the vocabulary.'),
      'relations' => $this
        ->t('Whether or not related terms are enabled within the vocabulary. (0 = disabled, 1 = enabled)'),
      'hierarchy' => $this
        ->t('The type of hierarchy allowed within the vocabulary. (0 = disabled, 1 = single, 2 = multiple)'),
      'multiple' => $this
        ->t('Whether or not multiple terms from this vocabulary may be assigned to a node. (0 = disabled, 1 = enabled)'),
      'required' => $this
        ->t('Whether or not terms are required for nodes using this vocabulary. (0 = disabled, 1 = enabled)'),
      'tags' => $this
        ->t('Whether or not free tagging is enabled for the vocabulary. (0 = disabled, 1 = enabled)'),
      'weight' => $this
        ->t('The weight of the vocabulary in relation to other vocabularies.'),
      'parents' => $this
        ->t("The Drupal term IDs of the term's parents."),
      'node_types' => $this
        ->t('The names of the node types the vocabulary may be used with.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {

    // Find node types for this row.
    $node_types = $this
      ->select('vocabulary_node_types', 'nt')
      ->fields('nt', [
      'type',
      'vid',
    ])
      ->condition('vid', $row
      ->getSourceProperty('vid'))
      ->execute()
      ->fetchCol();
    $row
      ->setSourceProperty('node_types', $node_types);
    $row
      ->setSourceProperty('cardinality', $row
      ->getSourceProperty('tags') == 1 || $row
      ->getSourceProperty('multiple') == 1 ? FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED : 1);

    // If the vocabulary being migrated is the one defined in the
    // 'forum_nav_vocabulary' variable, set the 'forum_vocabulary' source
    // property to true so we know this is the vocabulary used by Forum.
    if ($this
      ->variableGet('forum_nav_vocabulary', 0) == $row
      ->getSourceProperty('vid')) {
      $row
        ->setSourceProperty('forum_vocabulary', TRUE);
    }
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['vid']['type'] = 'integer';
    return $ids;
  }

}

Members

Namesort ascending Modifiers Type Description Overrides
Vocabulary::query public function Overrides SqlBase::query 3
Vocabulary::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow 1
Vocabulary::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds 2
Vocabulary::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
SqlBase::__sleep public function Overrides DependencySerializationTrait::__sleep
SqlBase::setUpDatabase protected function Gets a connection to the referenced database.
SqlBase::select protected function Wrapper for database select.
SqlBase::rewind public function Overrides SourcePluginBase::rewind
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
SqlBase::mapJoinable protected function Checks if we can join against the map table. 1
SqlBase::initializeIterator protected function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator 18
SqlBase::getDatabase public function Gets the database connection object. 2
SqlBase::fetchNextRow protected function Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::fetchNextBatch protected function Prepares query for the next set of data from the source database.
SqlBase::doCount protected function Gets the source count using countQuery(). Overrides SourcePluginBase::doCount 6
SqlBase::$state protected property State service for retrieving database info.
SqlBase::$query protected property The query string.
SqlBase::$database protected property The database object. 1
SqlBase::$batchSize protected property Number of records to fetch from the database during each batch.
SqlBase::$batch protected property The count of the number of batches run.
SourcePluginBase::valid public function
SourcePluginBase::saveHighWater protected function Save the new high water mark.
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::next public function
SourcePluginBase::key public function
SourcePluginBase::getSourceModule public function Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::getModuleHandler protected function Gets the module handler.
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getHighWaterStorage protected function Get the high water storage object.
SourcePluginBase::getHighWaterProperty protected function Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterField protected function Get the name of the field used as the high watermark.
SourcePluginBase::getHighWater protected function The current value of the high water mark.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::current public function
SourcePluginBase::count public function 2
SourcePluginBase::aboveHighWater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data. 1
SourcePluginBase::$skipCount protected property Whether this instance should not attempt to count the source. 1
SourcePluginBase::$originalHighWater protected property The high water mark at the beginning of the import operation.
SourcePluginBase::$moduleHandler protected property The module handler service. 2
SourcePluginBase::$migration protected property The entity migration object.
SourcePluginBase::$mapRowAdded protected property Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$iterator protected property The iterator to iterate over the source rows.
SourcePluginBase::$idMap protected property The migration ID map.
SourcePluginBase::$highWaterStorage protected property The key-value storage for the high-water value.
SourcePluginBase::$highWaterProperty protected property Information on the property used as the high-water mark.
SourcePluginBase::$currentSourceIds protected property The primary key of the current row.
SourcePluginBase::$currentRow protected property The current row from the query.
SourcePluginBase::$cacheKey protected property Key to use for caching counts.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count. 1
SourcePluginBase::$cache protected property The backend cache.
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
MessengerTrait::setMessenger public function Sets the messenger.
MessengerTrait::messenger public function Gets the messenger. 10
MessengerTrait::$messenger protected property The messenger. 10
DrupalSqlBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct 5
DrupalSqlBase::variableGet protected function Reads a variable from a source Drupal database.
DrupalSqlBase::moduleExists protected function Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::getSystemData public function Retrieves all system data information from the source Drupal database.
DrupalSqlBase::getModuleSchemaVersion protected function Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 2
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 4
DrupalSqlBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
DrupalSqlBase::$systemData protected property The contents of the system table.
DrupalSqlBase::$requirements protected property If the source provider is missing.
DrupalSqlBase::$entityTypeManager protected property The entity type manager.
DependencyTrait::addDependency protected function Adds a dependency.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::$dependencies protected property The object's dependencies.
DependencySerializationTrait::__wakeup public function 2
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::$_entityStorages protected property