config_packager-8.x-1.x-dev/src/Plugin/ConfigPackagerAssignment/ConfigPackagerAssignmentExclude.php

<?php

/**
 * @file
 * Contains \Drupal\config_packager\Plugin\ConfigPackagerAssignment\ConfigPackagerAssignmentExclude.
 */

namespace Drupal\config_packager\Plugin\ConfigPackagerAssignment;

use Drupal\component\Utility\Unicode;
use Drupal\config_packager\ConfigPackagerAssignmentMethodBase;
use Drupal\config_packager\ConfigPackagerManagerInterface;
use Drupal\Core\Config\ExtensionInstallStorage;

/**
 * Class for excluding configuration from packages.
 *
 * @Plugin(
 *   id = \Drupal\config_packager\Plugin\ConfigPackagerAssignment\ConfigPackagerAssignmentExclude::METHOD_ID,
 *   weight = -5,
 *   name = @Translation("Exclude"),
 *   description = @Translation("Exclude configuration items from packaging by various methods including by configuration type."),
 *   config_route_name = "config_packager.assignment_exclude"
 * )
 */
class ConfigPackagerAssignmentExclude extends ConfigPackagerAssignmentMethodBase {

  /**
   * The package assignment method id.
   */
  const METHOD_ID = 'exclude';

  /**
   * {@inheritdoc}
   */
  public function assignPackages() {
    $config_types = $this->configPackagerManager->listConfigTypes();
    $settings = $this->configFactory->get('config_packager.assignment');
    $config_collection = $this->configPackagerManager->getConfigCollection();

    // Exclude by configuration type.
    $exclude_types = $settings->get('exclude.types');
    if (!empty($exclude_types)) {
      foreach ($config_collection as $item_name => $item) {
        if (in_array($item['type'], $exclude_types)) {
          unset($config_collection[$item_name]);
        }
      }
    }

    // Exclude configuration already provided by modules.
    $exclude_module = $settings->get('exclude.module');
    if (!empty($exclude_module['enabled'])) {
      $extension_config_storage = new ExtensionInstallStorage($this->configStorage);
      $install_list = $extension_config_storage->listAll();
      // There are two settings that can limit what's included.
      // First, we can skipped configuration provided by the install profile.
      $module_profile = !empty($exclude_module['profile']);
      // Second, we can skip configuration provided by namespaced modules.
      $module_namespace = !empty($exclude_module['namespace']);
      if ($module_profile || $module_namespace) {
        $modules = array();
        // Load the names of any configuration objects provided by the install
        // profile.
        if ($module_profile) {
          $profile = drupal_get_profile();
          $modules = array_merge($modules, $this->configPackagerManager->getModuleList([$profile]));
        }
        // Load the names of any configuration objects provided by modules
        // having the namespace of the current package set.
        if ($module_namespace) {
          if ($machine_name = $this->configFactory->get('config_packager.settings')->get('profile.machine_name')) {
            $modules = array_merge($modules, $this->configPackagerManager->getModuleList([], $machine_name));
          }
        }
        // If any configuration was found, remove it from the list.
        foreach ($modules as $extension) {
          $extension_list = $this->configPackagerManager->listExtensionConfig($extension);
          $install_list = array_diff($install_list, $extension_list);
        }
      }
      foreach ($install_list as $item_name) {
        if (isset($config_collection[$item_name])) {
          unset($config_collection[$item_name]);
        }
      }
    }

    // Exclude configuration items on a curated list of site-specific
    // configuration.
    if ($settings->get('exclude.curated')) {
      $item_names = [
        'core.extension',
        'field.settings',
        'field_ui.settings',
        'filter.settings',
        'forum.settings',
        'image.settings',
        'node.settings',
        'system.authorize',
        'system.cron',
        'system.date',
        'system.file',
        'system.diff',
        'system.logging',
        'system.maintenance',
        'system.performance',
        'system.site',
        'system.theme',
        'system.theme.global',
        'update.settings',
      ];
      foreach ($item_names as $item_name) {
        unset($config_collection[$item_name]);
      }
    }

    // Register the updated data.
    $this->configPackagerManager->setConfigCollection($config_collection);
  }

}