ThemeSettings.php

Same filename in this branch
  1. 8.9.x core/modules/system/src/Plugin/migrate/source/d7/ThemeSettings.php
  2. 8.9.x core/lib/Drupal/Core/Theme/ThemeSettings.php
Same filename in other branches
  1. 9 core/modules/system/src/Plugin/migrate/destination/d7/ThemeSettings.php
  2. 9 core/modules/system/src/Plugin/migrate/source/d7/ThemeSettings.php
  3. 9 core/lib/Drupal/Core/Theme/ThemeSettings.php
  4. 10 core/modules/system/src/Plugin/migrate/destination/d7/ThemeSettings.php
  5. 10 core/modules/system/src/Plugin/migrate/source/d7/ThemeSettings.php
  6. 10 core/lib/Drupal/Core/Theme/ThemeSettings.php
  7. 11.x core/modules/system/src/Plugin/migrate/destination/d7/ThemeSettings.php
  8. 11.x core/modules/system/src/Plugin/migrate/source/d7/ThemeSettings.php
  9. 11.x core/lib/Drupal/Core/Theme/ThemeSettings.php

Namespace

Drupal\system\Plugin\migrate\destination\d7

File

core/modules/system/src/Plugin/migrate/destination/d7/ThemeSettings.php

View source
<?php

namespace Drupal\system\Plugin\migrate\destination\d7;

use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\Row;
use Drupal\migrate\Plugin\migrate\destination\DestinationBase;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Persist theme settings to the config system.
 *
 * @MigrateDestination(
 *   id = "d7_theme_settings"
 * )
 */
class ThemeSettings extends DestinationBase implements ContainerFactoryPluginInterface {
    
    /**
     * The configuration factory.
     *
     * @var \Drupal\Core\Config\ConfigFactoryInterface
     */
    protected $configFactory;
    
    /**
     * Constructs a theme settings destination object.
     *
     * @param array $configuration
     *   Plugin configuration.
     * @param string $plugin_id
     *   The plugin ID.
     * @param mixed $plugin_definition
     *   The plugin definition.
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   The current migration.
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The configuration factory.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, ConfigFactoryInterface $config_factory) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
        $this->configFactory = $config_factory;
    }
    
    /**
     * {@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'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function import(Row $row, array $old_destination_id_values = []) {
        $imported = FALSE;
        $config = $this->configFactory
            ->getEditable($row->getDestinationProperty('configuration_name'));
        $theme_settings = $row->getDestination();
        // Remove keys not in theme settings.
        unset($theme_settings['configuration_name']);
        unset($theme_settings['theme_name']);
        if (isset($theme_settings)) {
            theme_settings_convert_to_config($theme_settings, $config);
            $config->save();
            $imported = TRUE;
        }
        return $imported;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['name']['type'] = 'string';
        return $ids;
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields(MigrationInterface $migration = NULL) {
        // Theme settings vary by theme, so no specific fields are defined.
        return [];
    }

}

Classes

Title Deprecated Summary
ThemeSettings Persist theme settings to the config system.

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