diff --git a/cacheexclude.install b/cacheexclude.install new file mode 100644 index 0000000000000000000000000000000000000000..1c2b1e45ec90cac4b48b2dfb627eaaeb1e89afc7 --- /dev/null +++ b/cacheexclude.install @@ -0,0 +1,20 @@ +<?php + +/** + * @file + * Install, update and uninstall functions for the Cache Exclude module. + * + * @see cacheexclude.install + */ + +/** + * Fix config keys. + */ +function cacheexclude_update_21001(): void { + $config = \Drupal::configFactory()->getEditable('cacheexclude.settings'); + $types = $config->get('cacheexclude_node_types'); + if (is_array($types)) { + $filtered = array_keys(array_filter($types)); + $config->set('cacheexclude_node_types', $filtered)->save(); + } +} diff --git a/cacheexclude.links.menu.yml b/cacheexclude.links.menu.yml index b285bd3fc41e54a7ebde7a331f8385ff315e2fcd..02ccd64a801c9142e7b662c9c56b26f9a6d06b6f 100644 --- a/cacheexclude.links.menu.yml +++ b/cacheexclude.links.menu.yml @@ -1,5 +1,5 @@ cacheexclude.settings: - title: 'Cacheexclude settings' + title: 'Cache exclude settings' description: 'Manage Cache Exclude settings for your site.' parent: system.admin_config_system route_name: cacheexclude.settings diff --git a/config/install/cacheexclude.settings.yml b/config/install/cacheexclude.settings.yml new file mode 100644 index 0000000000000000000000000000000000000000..a05c1e53c107ca98575ee8129396a5c35fadf5f9 --- /dev/null +++ b/config/install/cacheexclude.settings.yml @@ -0,0 +1,2 @@ +cacheexclude_list: '' +cacheexclude_node_types: { } diff --git a/config/schema/cacheexclude.schema.yml b/config/schema/cacheexclude.schema.yml index 559a6388233eefe46b604afba8f79caee6fbd19b..7ec44a36b4853b691ae68d5f9f6b148e9d55fcc7 100644 --- a/config/schema/cacheexclude.schema.yml +++ b/config/schema/cacheexclude.schema.yml @@ -1,6 +1,8 @@ cacheexclude.settings: type: config_object label: 'Cache exclude settings' + constraints: + FullyValidatable: ~ mapping: cacheexclude_list: type: string @@ -11,3 +13,5 @@ cacheexclude.settings: sequence: type: string label: 'Node types' + constraints: + EntityBundleExists: node diff --git a/src/EventSubscriber/CacheexcludeSubscriber.php b/src/EventSubscriber/CacheexcludeSubscriber.php index b2f2b14d4658983bcbd747cb685903295cc9e741..4453e51006d3a0027cdca43878bd616471cb2fe8 100644 --- a/src/EventSubscriber/CacheexcludeSubscriber.php +++ b/src/EventSubscriber/CacheexcludeSubscriber.php @@ -75,7 +75,7 @@ class CacheexcludeSubscriber implements EventSubscriberInterface { $config = $this->configFactory->get('cacheexclude.settings'); $node_types = $config->get('cacheexclude_node_types'); - if (!is_null($node_types)) { + if (!empty($node_types)) { $node_types = array_filter($node_types); if (isset($node_type) && in_array($node_type, $node_types, TRUE)) { // Disable page cache temporarily. @@ -94,7 +94,7 @@ class CacheexcludeSubscriber implements EventSubscriberInterface { // Get cacheexclude page configuration. $config = $this->configFactory->get('cacheexclude.settings'); // Only trim if config exists. - $pages = !is_null($config->get('cacheexclude_list')) ? trim($config->get('cacheexclude_list')) : NULL; + $pages = !empty($config->get('cacheexclude_list')) ? trim($config->get('cacheexclude_list')) : NULL; // If the current page is one we want to exclude from the cache, // disable page cache temporarily. diff --git a/src/Form/AdminSettingsForm.php b/src/Form/AdminSettingsForm.php index 28cb6ec557e609b8a7a48870a2c7acdaafd78dd7..1acebd66126802946299b465ba5e935417110fce 100644 --- a/src/Form/AdminSettingsForm.php +++ b/src/Form/AdminSettingsForm.php @@ -31,10 +31,11 @@ class AdminSettingsForm extends ConfigFormBase { */ public function buildForm(array $form, FormStateInterface $form_state): array { $config = $this->config('cacheexclude.settings'); + $selected_types = $config->get('cacheexclude_node_types') ?? []; $form['cacheexclude_list'] = [ '#type' => 'textarea', - '#title' => t('Pages to exclude from caching'), + '#title' => $this->t('Pages to exclude from caching'), '#default_value' => $config->get('cacheexclude_list'), '#width' => 40, '#height' => 10, @@ -45,8 +46,8 @@ class AdminSettingsForm extends ConfigFormBase { $form['cacheexclude_node_types'] = [ '#type' => 'checkboxes', - '#title' => t('Content types to exclude from caching'), - '#default_value' => !is_null($config->get('cacheexclude_node_types')) ? $config->get('cacheexclude_node_types') : [], + '#title' => $this->t('Content types to exclude from caching'), + '#default_value' => array_combine($selected_types, $selected_types), '#options' => node_type_get_names(), '#description' => $this->t("Check all content types that you do not want to be cached."), ]; @@ -62,8 +63,10 @@ class AdminSettingsForm extends ConfigFormBase { drupal_flush_all_caches(); $config = $this->configFactory->getEditable('cacheexclude.settings'); + $values = $form_state->getValue('cacheexclude_node_types'); + $enabled = array_keys(array_filter($values)); $config->set('cacheexclude_list', $form_state->getValue('cacheexclude_list'))->save(); - $config->set('cacheexclude_node_types', $form_state->getValue('cacheexclude_node_types'))->save(); + $config->set('cacheexclude_node_types', $enabled)->save(); parent::submitForm($form, $form_state); } diff --git a/src/Plugin/migrate/process/CacheexcludeNodes.php b/src/Plugin/migrate/process/CacheexcludeNodes.php index 36b4ff20b80ad56dde6dc03ceadc73fe9f6198dd..38128552fe75d554d39dc1ce8b1b7a9d615fd80b 100644 --- a/src/Plugin/migrate/process/CacheexcludeNodes.php +++ b/src/Plugin/migrate/process/CacheexcludeNodes.php @@ -58,7 +58,7 @@ class CacheexcludeNodes extends ProcessPluginBase implements ContainerFactoryPlu $destination_node_type = $lookup_result[0]['type']; $node_types[$destination_node_type] = $data ? $destination_node_type : 0; } - return $node_types; + return array_keys(array_filter($node_types)); } } diff --git a/tests/src/Kernel/CacheExcludeMigrateTest.php b/tests/src/Kernel/CacheExcludeMigrateTest.php index e26db060e0c93ea3b7cb7d6ac0b0e4a6f170e6ab..fde876440b59b1f9950b71233c3722ba360e4a8d 100644 --- a/tests/src/Kernel/CacheExcludeMigrateTest.php +++ b/tests/src/Kernel/CacheExcludeMigrateTest.php @@ -59,14 +59,13 @@ class CacheExcludeMigrateTest extends MigrateDrupal7TestBase { 'cacheexclude_list' => '/node/3 /blog/*', 'cacheexclude_node_types' => [ - 'range' => 'range', - 'test_display' => 'test_display', - 'video' => 'video', - 'article' => '0', - 'page' => '0', + 'range', + 'test_display', + 'video', ], ]; $config = $this->config('cacheexclude.settings')->getRawData(); + unset($config['_core']); $this->assertSame($expected_config, $config); }