protected function ComponentsLoader::setActiveTheme in Components! 8.2

Sets the namespaces based on the given active theme.

Parameters

\Drupal\Core\Theme\ActiveTheme $active_theme: The active theme.

Throws

\Twig\Error\LoaderError

1 call to ComponentsLoader::setActiveTheme()

ComponentsLoader::checkActiveTheme in src/Template/Loader/ComponentsLoader.php

Activates the proper namespaces if the active theme has changed.

File

src/Template/Loader/ComponentsLoader.php, line 103

Class

ComponentsLoader

Loads templates from the filesystem.

Namespace

Drupal\components\Template\Loader

Code

protected function setActiveTheme(ActiveTheme $active_theme) {
  $this->activeTheme = $active_theme
    ->getName();

  // Invalidate the cache.
  $this->cache = $this->errorCache = [];

  // Use the active theme cache, if available.
  if (isset($this->activeThemeNamespaces[$this->activeTheme])) {
    $this->paths = $this->activeThemeNamespaces[$this->activeTheme];
    return;
  }

  // Gather info about the active theme's base themes.
  $active_themes = [
    $this->activeTheme,
  ];
  foreach ($active_theme
    ->getBaseThemeExtensions() as $extension) {
    $active_themes[] = $extension
      ->getName();
  }
  $theme_info = $this->componentsInfo
    ->getAllThemeInfo();

  // Templates in namespaces should be loaded from paths in this priority:
  //
  //   1. active theme paths
  //   2. active theme's base themes paths
  //   3. module namespaces paths
  //
  // We accomplish this by loading default namespaces first (where the name of
  // of the namespace matches the name of the theme/module). And then prepend
  // paths in reverse order of the above priority.
  $this->paths = [];

  // Register module namespaces.
  if (!isset($this->moduleNamespaces)) {
    $this->moduleNamespaces = [];
    $module_info = $this->componentsInfo
      ->getAllModuleInfo();

    // Find default namespaces first.
    foreach ($module_info as $extensionName => $info) {
      if (isset($info['namespaces']) && isset($info['namespaces'][$extensionName])) {
        $this->moduleNamespaces[$extensionName] = $info['namespaces'][$extensionName];
      }
    }

    // Find other module namespaces.
    foreach ($module_info as $moduleName => $info) {
      if (isset($info['namespaces'])) {
        foreach ($info['namespaces'] as $namespace => $paths) {

          // Skip protected namespaces and log a warning.
          if ($this->componentsInfo
            ->isProtectedNamespace($namespace)) {
            $extensionInfo = $this->componentsInfo
              ->getProtectedNamespaceExtensionInfo($namespace);
            $this->componentsInfo
              ->logWarning(sprintf('The %s module attempted to alter the protected Twig namespace, %s, owned by the %s %s. See https://www.drupal.org/node/3190969#s-extending-a-default-twig-namespace to fix this error.', $moduleName, $namespace, $extensionInfo['name'], $extensionInfo['type']));
          }
          elseif ($namespace !== $moduleName) {
            if (!isset($this->moduleNamespaces[$namespace])) {
              $this->moduleNamespaces[$namespace] = [];
            }

            // Save paths in the same order specified in the .info.yml file.
            foreach (array_reverse($paths) as $path) {
              array_unshift($this->moduleNamespaces[$namespace], $path);
            }
          }
        }
      }
    }
  }
  foreach ($this->moduleNamespaces as $name => $paths) {
    $this
      ->setPaths($paths, $name);
  }

  // Add theme namespaces, starting with the most-base base theme.
  foreach (array_reverse($active_themes) as $theme_name) {
    if (isset($theme_info[$theme_name]) && isset($theme_info[$theme_name]['namespaces'])) {
      foreach ($theme_info[$theme_name]['namespaces'] as $namespace => $paths) {

        // Skip protected namespaces and log a warning.
        if ($this->componentsInfo
          ->isProtectedNamespace($namespace)) {
          $extensionInfo = $this->componentsInfo
            ->getProtectedNamespaceExtensionInfo($namespace);
          $this->componentsInfo
            ->logWarning(sprintf('The %s theme attempted to alter the protected Twig namespace, %s, owned by the %s %s. See https://www.drupal.org/node/3190969#s-extending-a-default-twig-namespace to fix this error.', $theme_name, $namespace, $extensionInfo['name'], $extensionInfo['type']));
        }
        else {

          // Save paths in the same order specified in the .info.yml file.
          foreach (array_reverse($paths) as $path) {
            $this
              ->prependPath($path, $namespace);
          }
        }
      }
    }
  }

  // Suppress warnings until the theme registry cache is rebuilt.
  $this->componentsInfo
    ->suppressWarnings();

  // Save the paths as a cache.
  $this->activeThemeNamespaces[$this->activeTheme] = $this->paths;
}