You are here

class ForumVocabulary in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/taxonomy/src/Plugin/migrate/process/ForumVocabulary.php \Drupal\taxonomy\Plugin\migrate\process\ForumVocabulary
  2. 10 core/modules/taxonomy/src/Plugin/migrate/process/ForumVocabulary.php \Drupal\taxonomy\Plugin\migrate\process\ForumVocabulary

Checks if the vocabulary being migrated is the one used for forums.

Drupal 8 Forum is expecting specific machine names for its field and vocabulary names. This process plugin forces a given machine name to the field or vocabulary that is being migrated.

The 'forum_vocabulary' source property is evaluated in the d6_taxonomy_vocabulary or d7_taxonomy_vocabulary source plugins and is set to true if the vocabulary vid being migrated is the same as the one in the 'forum_nav_vocabulary' variable on the source site.

Example:


process:
  field_name:
    plugin: forum_vocabulary
    machine_name: taxonomy_forums

Plugin annotation


@MigrateProcessPlugin(
  id = "forum_vocabulary"
)

Hierarchy

Expanded class hierarchy of ForumVocabulary

File

core/modules/taxonomy/src/Plugin/migrate/process/ForumVocabulary.php, line 34

Namespace

Drupal\taxonomy\Plugin\migrate\process
View source
class ForumVocabulary extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if ($row
      ->getSourceProperty('forum_vocabulary') && !empty($this->configuration['machine_name'])) {
      $value = $this->configuration['machine_name'];
    }
    return $value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
ForumVocabulary::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.