Commit 515a89ea authored by catch's avatar catch
Browse files

Issue #3285131 by andregp, daffie, catch, longwave: Fix constructor... 

Issue #3285131 by andregp, daffie, catch, longwave: Fix constructor deprecation in Drupal\Core\Theme\Registry::__construct()
parent feae261b

core/core.services.yml

+1 −1
Original line number Diff line number Diff line
@@ -1548,7 +1548,7 @@ services: 
    arguments: ['%app.root%', '@theme_handler', '@cache.bootstrap', '@module_handler']

  theme.registry:

    class: Drupal\Core\Theme\Registry

    arguments: ['%app.root%', '@cache.default', '@lock', '@module_handler', '@theme_handler', '@theme.initialization', null, '@cache.bootstrap', '@extension.list.module']

    arguments: ['%app.root%', '@cache.default', '@lock', '@module_handler', '@theme_handler', '@theme.initialization', '@cache.bootstrap', '@extension.list.module']

    tags:

      - { name: needs_destruction }

    calls:

core/lib/Drupal/Core/Theme/Registry.php

+8 −4
Original line number Diff line number Diff line
@@ -178,19 +178,22 @@ class Registry implements DestructableInterface { 
   *   The theme handler.

   * @param \Drupal\Core\Theme\ThemeInitializationInterface $theme_initialization

   *   The theme initialization.

   * @param string $theme_name

   *   (optional) The name of the theme for which to construct the registry.

   * @param \Drupal\Core\Cache\CacheBackendInterface $runtime_cache

   *   The cache backend interface to use for the runtime theme registry data.

   * @param \Drupal\Core\Extension\ModuleExtensionList $module_list

   *   The module list.

   * @param string $theme_name

   *   (optional) The name of the theme for which to construct the registry.

   */

  public function __construct($root, CacheBackendInterface $cache, LockBackendInterface $lock, ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler, ThemeInitializationInterface $theme_initialization, $theme_name = NULL, CacheBackendInterface $runtime_cache = NULL, ModuleExtensionList $module_list = NULL) {

  public function __construct($root, CacheBackendInterface $cache, LockBackendInterface $lock, ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler, ThemeInitializationInterface $theme_initialization, $runtime_cache = NULL, $module_list = NULL, $theme_name = NULL) {

    if (!($runtime_cache instanceof CacheBackendInterface) || !($module_list instanceof ModuleExtensionList)) {

      @trigger_error('Calling Registry::__construct() without the $runtime_cache as an instance of CacheBackendInterface or the $module_list as an instance of ModuleExtensionList is deprecated in drupal:9.5.0 and is required in drupal:10.0.0. See https://www.drupal.org/node/3285131', E_USER_DEPRECATED);

      [$runtime_cache, $module_list, $theme_name] = [$module_list, $theme_name, $runtime_cache];

    }

    $this->root = $root;

    $this->cache = $cache;

    $this->lock = $lock;

    $this->moduleHandler = $module_handler;

    $this->themeName = $theme_name;

    $this->themeHandler = $theme_handler;

    $this->themeInitialization = $theme_initialization;

    $this->runtimeCache = $runtime_cache;
@@ -199,6 +202,7 @@ public function __construct($root, CacheBackendInterface $cache, LockBackendInte 
      $module_list = \Drupal::service('extension.list.module');

    }

    $this->moduleList = $module_list;

    $this->themeName = $theme_name;

  }



  /**

core/tests/Drupal/KernelTests/Core/Theme/RegistryLegacyTest.php

+10 −2
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ public function testMultipleSubThemes() { 
    \Drupal::service('module_installer')->install(['theme_legacy_test']);

    \Drupal::service('theme_installer')->install(['test_basetheme']);



    $registry_base_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), 'test_basetheme');

    $registry_base_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), \Drupal::service('extension.list.module'), 'test_basetheme');

    $registry_base_theme->setThemeManager(\Drupal::theme());



    $preprocess_functions = $registry_base_theme->get()['theme_test_function_suggestions']['preprocess functions'];
@@ -51,7 +51,7 @@ public function testSuggestionPreprocessFunctions() { 
    $theme_handler = \Drupal::service('theme_handler');

    \Drupal::service('theme_installer')->install(['test_legacy_theme']);



    $registry_deprecated_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), 'test_legacy_theme');

    $registry_deprecated_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), \Drupal::service('extension.list.module'), 'test_legacy_theme');

    $registry_deprecated_theme->setThemeManager(\Drupal::theme());



    $expected_preprocess_functions = [
@@ -65,4 +65,12 @@ public function testSuggestionPreprocessFunctions() { 
    $this->assertSame($expected_preprocess_functions, $preprocess_functions, 'Suggestion implemented as a function correctly inherits preprocess functions.');

  }



  /**

   * Tests the order of registry parameters.

   */

  public function testRegistryConstructorParameters() {

    $this->expectDeprecation('Calling Registry::__construct() without the $runtime_cache as an instance of CacheBackendInterface or the $module_list as an instance of ModuleExtensionList is deprecated in drupal:9.5.0 and is required in drupal:10.0.0. See https://www.drupal.org/node/3285131');

    new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), \Drupal::service('theme_handler'), \Drupal::service('theme.initialization'), 'test_legacy_theme', \Drupal::service('cache.bootstrap'), \Drupal::service('extension.list.module'));

  }



}

core/tests/Drupal/KernelTests/Core/Theme/RegistryTest.php

+6 −6
Original line number Diff line number Diff line
@@ -74,11 +74,11 @@ public function testMultipleSubThemes() { 
    $module_list = $this->container->get('extension.list.module');

    assert($module_list instanceof ModuleExtensionList);



    $registry_subsub_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), 'test_subsubtheme', NULL, $module_list);

    $registry_subsub_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), $module_list, 'test_subsubtheme');

    $registry_subsub_theme->setThemeManager(\Drupal::theme());

    $registry_sub_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), 'test_subtheme', NULL, $module_list);

    $registry_sub_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), $module_list, 'test_subtheme');

    $registry_sub_theme->setThemeManager(\Drupal::theme());

    $registry_base_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), 'test_basetheme', NULL, $module_list);

    $registry_base_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), $module_list, 'test_basetheme');

    $registry_base_theme->setThemeManager(\Drupal::theme());



    $preprocess_functions = $registry_subsub_theme->get()['theme_test_template_test']['preprocess functions'];
@@ -112,7 +112,7 @@ public function testSuggestionPreprocessFunctions() { 


    $extension_list = $this->container->get('extension.list.module');

    assert($extension_list instanceof ModuleExtensionList);

    $registry_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), 'test_theme', NULL, $extension_list);

    $registry_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), $extension_list, 'test_theme');

    $registry_theme->setThemeManager(\Drupal::theme());



    $suggestions = ['__kitten', '__flamingo'];
@@ -154,7 +154,7 @@ public function testThemeRegistryAlterByTheme() { 


    $extension_list = $this->container->get('extension.list.module');

    assert($extension_list instanceof ModuleExtensionList);

    $registry = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), 'test_theme', NULL, $extension_list);

    $registry = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), $extension_list, 'test_theme');

    $registry->setThemeManager(\Drupal::theme());

    $this->assertEquals('value', $registry->get()['theme_test_template_test']['variables']['additional']);

  }
@@ -244,7 +244,7 @@ public function testThemeTemplatesRegisteredByModules() { 


    $extension_list = \Drupal::service('extension.list.module');

    assert($extension_list instanceof ModuleExtensionList);

    $registry_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), 'test_theme', NULL, $extension_list);

    $registry_theme = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $theme_handler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), $extension_list, 'test_theme');

    $registry_theme->setThemeManager(\Drupal::theme());



    $expected = [

core/tests/Drupal/KernelTests/Core/Theme/Stable9TemplateOverrideTest.php

+1 −1
Original line number Diff line number Diff line
@@ -87,7 +87,7 @@ protected function installAllModules() { 
   * Ensures that Stable 9 overrides all relevant core templates.

   */

  public function testStable9TemplateOverrides() {

    $registry = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $this->themeHandler, \Drupal::service('theme.initialization'), 'stable9', NULL, \Drupal::service('extension.list.module'));

    $registry = new Registry($this->root, \Drupal::cache(), \Drupal::lock(), \Drupal::moduleHandler(), $this->themeHandler, \Drupal::service('theme.initialization'), \Drupal::service('cache.bootstrap'), \Drupal::service('extension.list.module'), 'stable9');

    $registry->setThemeManager(\Drupal::theme());



    $registry_full = $registry->get();