class Config
Provides Configuration Management destination plugin.
Persists data to the config system.
Available configuration keys:
- store null: (optional) Boolean, if TRUE, when a property is NULL, NULL is stored, otherwise the default is used. Defaults to FALSE.
- translations: (optional) Boolean, if TRUE, the destination will be associated with the langcode provided by the source plugin. Defaults to FALSE.
Destination properties expected in the imported row:
- config_name: The machine name of the config.
- langcode: (optional) The language code of the config.
Examples:
source:
  plugin: variable
  variables:
    - node_admin_theme
process:
  use_admin_theme: node_admin_theme
destination:
  plugin: config
  config_name: node.settings
This will add the value of the variable "node_admin_theme" to the config with the machine name "node.settings" as "node.settings.use_admin_theme".
source:
  plugin: d6_variable_translation
  variables:
    - site_offline_message
process:
  langcode: language
  message: site_offline_message
destination:
  plugin: config
  config_name: system.maintenance
  translations: true
This will add the value of the variable "site_offline_message" to the config with the machine name "system.maintenance" as "system.maintenance.message", coupled with the relevant langcode as obtained from the "d6_variable_translation" source plugin.
Plugin annotation
@MigrateDestination(
  id = "config"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \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 extends \Drupal\Component\Plugin\PluginBase- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\migrate\Plugin\migrate\destination\Config implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase
 
 
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of Config
See also
\Drupal\migrate_drupal\Plugin\migrate\source\d6\VariableTranslation
4 files declare their use of Config
- CheckRequirementsTest.php in core/modules/ migrate/ tests/ src/ Unit/ Plugin/ migrate/ destination/ CheckRequirementsTest.php 
- ConfigTest.php in core/modules/ migrate/ tests/ src/ Unit/ destination/ ConfigTest.php 
- DefaultLangcode.php in core/modules/ language/ src/ Plugin/ migrate/ destination/ DefaultLangcode.php 
- DestinationCategoryTest.php in core/modules/ migrate_drupal/ tests/ src/ Kernel/ Plugin/ migrate/ DestinationCategoryTest.php 
133 string references to 'Config'
- action_settings.yml in core/modules/ system/ migrations/ action_settings.yml 
- core/modules/system/migrations/action_settings.yml
- book_settings.yml in core/modules/ book/ migrations/ book_settings.yml 
- core/modules/book/migrations/book_settings.yml
- BootstrapConfigStorageFactory::getDatabaseStorage in core/lib/ Drupal/ Core/ Config/ BootstrapConfigStorageFactory.php 
- Returns a Database configuration storage implementation.
- CachedStorageTest::setUp in core/tests/ Drupal/ KernelTests/ Core/ Config/ Storage/ CachedStorageTest.php 
- ChangeUserRoleBase::calculateDependencies in core/modules/ user/ src/ Plugin/ Action/ ChangeUserRoleBase.php 
- Calculates dependencies for the configured plugin.
File
- 
              core/modules/ migrate/ src/ Plugin/ migrate/ destination/ Config.php, line 72 
Namespace
Drupal\migrate\Plugin\migrate\destinationView source
class Config extends DestinationBase implements ContainerFactoryPluginInterface, DependentPluginInterface {
  use DependencyTrait;
  
  /**
   * The config object.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;
  
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $language_manager;
  
  /**
   * Constructs a Config destination object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration entity.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, ConfigFactoryInterface $config_factory, LanguageManagerInterface $language_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->config = $config_factory->getEditable($configuration['config_name']);
    $this->language_manager = $language_manager;
    if ($this->isTranslationDestination()) {
      $this->supportsRollback = TRUE;
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('config.factory'), $container->get('language_manager'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    if ($this->isTranslationDestination()) {
      $this->config = $this->language_manager
        ->getLanguageConfigOverride($row->getDestinationProperty('langcode'), $this->config
        ->getName());
    }
    foreach ($row->getRawDestination() as $key => $value) {
      if (isset($value) || !empty($this->configuration['store null'])) {
        $this->config
          ->set(str_replace(Row::PROPERTY_SEPARATOR, '.', $key), $value);
      }
    }
    $this->config
      ->save();
    $ids[] = $this->config
      ->getName();
    if ($this->isTranslationDestination()) {
      $ids[] = $row->getDestinationProperty('langcode');
    }
    return $ids;
  }
  
  /**
   * {@inheritdoc}
   */
  public function fields() {
    // @todo Dynamically fetch fields using Config Schema API.
  }
  
  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['config_name']['type'] = 'string';
    if ($this->isTranslationDestination()) {
      $ids['langcode']['type'] = 'string';
    }
    return $ids;
  }
  
  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $provider = explode('.', $this->config
      ->getName(), 2)[0];
    $this->addDependency('module', $provider);
    return $this->dependencies;
  }
  
  /**
   * Get whether this destination is for translations.
   *
   * @return bool
   *   Whether this destination is for translations.
   */
  protected function isTranslationDestination() {
    return !empty($this->configuration['translations']);
  }
  
  /**
   * {@inheritdoc}
   */
  public function rollback(array $destination_identifier) {
    if ($this->isTranslationDestination()) {
      $language = $destination_identifier['langcode'];
      $config = $this->language_manager
        ->getLanguageConfigOverride($language, $this->config
        ->getName());
      $config->delete();
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDestinationModule() {
    if (!empty($this->configuration['destination_module'])) {
      return $this->configuration['destination_module'];
    }
    if (!empty($this->pluginDefinition['destination_module'])) {
      return $this->pluginDefinition['destination_module'];
    }
    // Config translations require the config_translation module so set the
    // migration provider to 'config_translation'. The corresponding non
    // translated configuration is expected to be handled in a separate
    // migration.
    if (isset($this->configuration['translations'])) {
      return 'config_translation';
    }
    // Get the module handling this configuration object from the config_name,
    // which is of the form <module_name>.<configuration object name>
    return !empty($this->configuration['config_name']) ? explode('.', $this->configuration['config_name'], 2)[0] : NULL;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| Config::$config | protected | property | The config object. | ||
| Config::$language_manager | protected | property | The language manager. | ||
| Config::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
| Config::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
| Config::fields | public | function | Returns an array of destination fields. | Overrides MigrateDestinationInterface::fields | |
| Config::getDestinationModule | public | function | Gets the destination module handling the destination data. | Overrides DestinationBase::getDestinationModule | |
| Config::getIds | public | function | Gets the destination IDs. | Overrides MigrateDestinationInterface::getIds | |
| Config::import | public | function | Import the row. | Overrides MigrateDestinationInterface::import | 1 | 
| Config::isTranslationDestination | protected | function | Get whether this destination is for translations. | ||
| Config::rollback | public | function | Delete the specified destination object from the target Drupal. | Overrides DestinationBase::rollback | |
| Config::__construct | public | function | Constructs a Config destination object. | Overrides DestinationBase::__construct | |
| 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | ||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | ||
| DestinationBase::$migration | protected | property | The migration. | ||
| DestinationBase::$rollbackAction | protected | property | The rollback action to be saved for the last imported item. | ||
| DestinationBase::$supportsRollback | protected | property | Indicates whether the destination can be rolled back. | ||
| DestinationBase::checkRequirements | public | function | Checks if requirements for this plugin are OK. | Overrides RequirementsInterface::checkRequirements | |
| DestinationBase::rollbackAction | public | function | The rollback action for the last imported item. | Overrides MigrateDestinationInterface::rollbackAction | |
| DestinationBase::setRollbackAction | protected | function | For a destination item being updated, set the appropriate rollback action. | ||
| DestinationBase::supportsRollback | public | function | Whether the destination can be rolled back or not. | Overrides MigrateDestinationInterface::supportsRollback | |
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| 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 | 2 | 
| 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. | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
