' . $used_config_split_text . '
'; - + \Drupal::service(ConfigSplitHooks::class)->formConfigAdminImportFormAlter($form, $form_state); } /** * Implements hook_help(). */ +#[LegacyHook] function config_split_help($route_name, RouteMatchInterface $route_match) { - switch ($route_name) { - case 'help.page.config_split': - $output = ''; - $output .= '' . t('
-The Drupal 8 configuration management works best when importing and exporting
-the whole set of the sites configuration. However, sometimes developers like to
-opt out of the robustness of CM and have a super-set of configuration active on
-their development machine. The canonical example for this is to have the
-devel module enabled or having a few block placements or views in
-the development environment and then not export them into the set of
-configuration to be deployed, yet still being able to share the development
-configuration with colleagues.
-
-This module allows to define sets of configuration that will get exported to
-separate directories when exporting, and get merged together when importing.
-It is possible to define in settings.php which of these sets should be active
-and considered for the export and import.
-
-For more information, see the online documentation for the Config Split module.',
- [
- ':online-documentation' => 'https://www.drupal.org/docs/8/modules/configuration-split',
- ])
- . '
-$settings["config_sync_directory"] = \'../config/sync\';
-
-Create a split with the folder `../config/my-split-folder` and create that
-directory. Now add a module that is currently active that you wish not to
-export, say `devel`. Next export all the configuration.
-This should have removed devel from `core.extensions` and moved the devel
-configuration to the split folder.') . '' . t('Config Split Help') . '
'; - $output .= '' . t('The configuration listed as part of a split - are exported to the split storage rather than the usual sync directory - when exporting the whole configuration. When importing the whole - configuration, the configuration in the split storages is merged with - the default sync directory and overrides the configuration. - The configuration does not end up being overwritten in the sense of - configuration overrides such as the overrides from settings.php.') . '
'; - - return $output; - } - - return NULL; + return \Drupal::service(ConfigSplitHooks::class)->help($route_name, $route_match); } /** @@ -118,12 +32,7 @@ function config_split_help($route_name, RouteMatchInterface $route_match) { * Automatically add any enabled database config splits' partial and complete * entries as whitelisted patterns for config_readonly. */ +#[LegacyHook] function config_split_config_readonly_whitelist_patterns() { - $patterns = []; - /** @var \Drupal\config_split\Entity\ConfigSplitEntityInterface[] $splits */ - $splits = \Drupal::entityTypeManager()->getStorage('config_split')->loadByProperties(['storage' => 'database', 'status' => TRUE]); - foreach ($splits as $split) { - $patterns = array_merge($patterns, $split->get('partial_list'), $split->get('complete_list')); - } - return $patterns; + return \Drupal::service(ConfigSplitHooks::class)->configReadonlyWhitelistPatterns(); } diff --git a/config_split.services.yml b/config_split.services.yml index db36555..670dd13 100644 --- a/config_split.services.yml +++ b/config_split.services.yml @@ -56,3 +56,7 @@ services: - "@state" tags: - { name: config.factory.override, priority: 5 } + + Drupal\config_split\Hook\ConfigSplitHooks: + class: Drupal\config_split\Hook\ConfigSplitHooks + autowire: true diff --git a/src/EventSubscriber/SplitImportExportSubscriber.php b/src/EventSubscriber/SplitImportExportSubscriber.php index e067be1..0ac6759 100644 --- a/src/EventSubscriber/SplitImportExportSubscriber.php +++ b/src/EventSubscriber/SplitImportExportSubscriber.php @@ -45,7 +45,7 @@ public function __construct(ConfigSplitManager $manager, ConfigFactoryInterface /** * {@inheritdoc} */ - public static function getSubscribedEvents() { + public static function getSubscribedEvents(): array { // We get the splits priority from the settings. // Unfortunately we can not load the existing splits from the drupal because // the subscribed events is compiled into the container in a compiler pass diff --git a/src/Hook/ConfigSplitHooks.php b/src/Hook/ConfigSplitHooks.php new file mode 100644 index 0000000..b099869 --- /dev/null +++ b/src/Hook/ConfigSplitHooks.php @@ -0,0 +1,133 @@ +t('You are not using any config split configuration'); + /** @var \Drupal\config_split\ConfigSplitManager $manager */ + $manager = \Drupal::service('config_split.manager'); + $sync = \Drupal::service('config.storage.sync'); + $splits = $manager->loadMultiple($manager->listAll($sync), $sync); + foreach ($splits as $split) { + if ($split->get('status')) { + $entity = $manager->getSplitEntity($split->getName()); + if ($entity instanceof \Drupal\Core\Config\Entity\ConfigEntityInterface) { + $enabled[] = \Drupal\Core\Link::fromTextAndUrl($entity->label(), $entity->toUrl())->toString(); + } else { + $enabled[] = $split->get('label') . ' (new)'; + } + } + } + if (!empty($enabled)) { + $used_config_split_text = $this->t('Used config split configuration:') . ' ' . implode(', ', $enabled); + } + $form['config_split']['#weight'] = -10; + $form['config_split']['#markup'] = '' . $used_config_split_text . '
'; + } + /** + * Implements hook_help(). + */ + #[Hook('help')] + public function help($route_name, \Drupal\Core\Routing\RouteMatchInterface $route_match) + { + switch ($route_name) { + case 'help.page.config_split': + $output = ''; + $output .= '' . $this->t('
+The Drupal 8 configuration management works best when importing and exporting
+the whole set of the sites configuration. However, sometimes developers like to
+opt out of the robustness of CM and have a super-set of configuration active on
+their development machine. The canonical example for this is to have the
+devel module enabled or having a few block placements or views in
+the development environment and then not export them into the set of
+configuration to be deployed, yet still being able to share the development
+configuration with colleagues.
+
+This module allows to define sets of configuration that will get exported to
+separate directories when exporting, and get merged together when importing.
+It is possible to define in settings.php which of these sets should be active
+and considered for the export and import.
+
+For more information, see the online documentation for the Config Split module.', [
+ ':online-documentation' => 'https://www.drupal.org/docs/8/modules/configuration-split',
+ ]) . '
+$settings["config_sync_directory"] = \'../config/sync\';
+
+Create a split with the folder `../config/my-split-folder` and create that
+directory. Now add a module that is currently active that you wish not to
+export, say `devel`. Next export all the configuration.
+This should have removed devel from `core.extensions` and moved the devel
+configuration to the split folder.') . '' . $this->t('Config Split Help') . '
'; + $output .= '' . $this->t('The configuration listed as part of a split + are exported to the split storage rather than the usual sync directory + when exporting the whole configuration. When importing the whole + configuration, the configuration in the split storages is merged with + the default sync directory and overrides the configuration. + The configuration does not end up being overwritten in the sense of + configuration overrides such as the overrides from settings.php.') . '
'; + return $output; + } + return NULL; + } + /** + * Implements hook_config_readonly_whitelist_patterns(). + * + * Automatically add any enabled database config splits' partial and complete + * entries as whitelisted patterns for config_readonly. + */ + #[Hook('config_readonly_whitelist_patterns')] + public static function configReadonlyWhitelistPatterns() + { + $patterns = [ + ]; + /** @var \Drupal\config_split\Entity\ConfigSplitEntityInterface[] $splits */ + $splits = \Drupal::entityTypeManager()->getStorage('config_split')->loadByProperties([ + 'storage' => 'database', + 'status' => TRUE, + ]); + foreach ($splits as $split) { + $patterns = array_merge($patterns, $split->get('partial_list'), $split->get('complete_list')); + } + return $patterns; + } +} diff --git a/tests/modules/config_split_sequence_test/config_split_sequence_test.module b/tests/modules/config_split_sequence_test/config_split_sequence_test.module index 2227d99..b31f7a7 100644 --- a/tests/modules/config_split_sequence_test/config_split_sequence_test.module +++ b/tests/modules/config_split_sequence_test/config_split_sequence_test.module @@ -1,5 +1,12 @@ configSchemaInfoAlter($definitions); } diff --git a/tests/modules/config_split_sequence_test/config_split_sequence_test.services.yml b/tests/modules/config_split_sequence_test/config_split_sequence_test.services.yml new file mode 100644 index 0000000..d770a21 --- /dev/null +++ b/tests/modules/config_split_sequence_test/config_split_sequence_test.services.yml @@ -0,0 +1,5 @@ + +services: + Drupal\config_split_sequence_test\Hook\ConfigSplitSequenceTestHooks: + class: Drupal\config_split_sequence_test\Hook\ConfigSplitSequenceTestHooks + autowire: true diff --git a/tests/modules/config_split_sequence_test/src/Hook/ConfigSplitSequenceTestHooks.php b/tests/modules/config_split_sequence_test/src/Hook/ConfigSplitSequenceTestHooks.php new file mode 100644 index 0000000..8ded595 --- /dev/null +++ b/tests/modules/config_split_sequence_test/src/Hook/ConfigSplitSequenceTestHooks.php @@ -0,0 +1,31 @@ +