ActiveTheme.php

<?php

namespace Drupal\Core\Theme;


/**
 * Defines a theme and its information needed at runtime.
 *
 * The theme manager will store the active theme object.
 *
 * @see \Drupal\Core\Theme\ThemeManager
 * @see \Drupal\Core\Theme\ThemeInitialization
 */
class ActiveTheme {
    
    /**
     * The machine name of the active theme.
     *
     * @var string
     */
    protected $name;
    
    /**
     * The path to the logo.
     *
     * @var string
     */
    protected $logo;
    
    /**
     * The path to the theme.
     *
     * @var string
     */
    protected $path;
    
    /**
     * The engine of the theme.
     *
     * @var string
     */
    protected $engine;
    
    /**
     * The path to the theme engine for root themes.
     *
     * @var string
     */
    protected $owner;
    
    /**
     * An array of base theme active theme objects keyed by name.
     *
     * @var static[]
     *
     * @deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. Use
     *   $this->baseThemeExtensions instead.
     *
     * @see https://www.drupal.org/node/3019948
     */
    protected $baseThemes;
    
    /**
     * An array of base theme extension objects keyed by name.
     *
     * @var \Drupal\Core\Extension\Extension[]
     */
    protected $baseThemeExtensions = [];
    
    /**
     * The extension object.
     *
     * @var \Drupal\Core\Extension\Extension
     */
    protected $extension;
    
    /**
     * The stylesheets which are set to be removed by the theme.
     *
     * @var array
     */
    protected $styleSheetsRemove;
    
    /**
     * The libraries provided by the theme.
     *
     * @var array
     */
    protected $libraries;
    
    /**
     * The regions provided by the theme.
     *
     * @var array
     */
    protected $regions;
    
    /**
     * The libraries or library assets overridden by the theme.
     *
     * @var array
     */
    protected $librariesOverride;
    
    /**
     * The list of libraries-extend definitions.
     *
     * @var array
     */
    protected $librariesExtend;
    
    /**
     * Constructs an ActiveTheme object.
     *
     * @param array $values
     *   The properties of the object, keyed by the names.
     */
    public function __construct(array $values) {
        $values += [
            'path' => '',
            'engine' => 'twig',
            'owner' => 'twig',
            'logo' => '',
            'stylesheets_remove' => [],
            'libraries' => [],
            'extension' => 'html.twig',
            'base_theme_extensions' => [],
            'regions' => [],
            'libraries_override' => [],
            'libraries_extend' => [],
        ];
        $this->name = $values['name'];
        $this->logo = $values['logo'];
        $this->path = $values['path'];
        $this->engine = $values['engine'];
        $this->owner = $values['owner'];
        $this->styleSheetsRemove = $values['stylesheets_remove'];
        $this->libraries = $values['libraries'];
        $this->extension = $values['extension'];
        $this->baseThemeExtensions = $values['base_theme_extensions'];
        if (!empty($values['base_themes']) && empty($this->baseThemeExtensions)) {
            @trigger_error("The 'base_themes' key is deprecated in Drupal 8.7.0  and support for it will be removed in Drupal 9.0.0. Use 'base_theme_extensions' instead. See https://www.drupal.org/node/3019948", E_USER_DEPRECATED);
            foreach ($values['base_themes'] as $base_theme) {
                $this->baseThemeExtensions[$base_theme->getName()] = $base_theme->getExtension();
            }
        }
        $this->regions = $values['regions'];
        $this->librariesOverride = $values['libraries_override'];
        $this->librariesExtend = $values['libraries_extend'];
    }
    
    /**
     * Returns the machine name of the theme.
     *
     * @return string
     */
    public function getName() {
        return $this->name;
    }
    
    /**
     * Returns the path to the theme directory.
     *
     * @return string
     */
    public function getPath() {
        return $this->path;
    }
    
    /**
     * Returns the theme engine.
     *
     * @return string
     */
    public function getEngine() {
        return $this->engine;
    }
    
    /**
     * Returns the path to the theme engine for root themes.
     *
     * @see \Drupal\Core\Extension\ThemeExtensionList::doList()
     *
     * @return mixed
     */
    public function getOwner() {
        return $this->owner;
    }
    
    /**
     * Returns the extension object.
     *
     * @return \Drupal\Core\Extension\Extension
     */
    public function getExtension() {
        return $this->extension;
    }
    
    /**
     * Returns the libraries provided by the theme.
     *
     * @return mixed
     */
    public function getLibraries() {
        return $this->libraries;
    }
    
    /**
     * Returns the removed stylesheets by the theme.
     *
     * This method is used as a BC layer to access the contents of the deprecated
     * stylesheets-remove key in theme info.yml files. It will be removed once it
     * is no longer needed in Drupal 10.
     *
     * @return mixed
     *   The removed stylesheets.
     *
     * @see https://www.drupal.org/node/2497313
     *
     * @todo Remove in Drupal 10.0.x.
     *
     * @internal
     */
    public function getStyleSheetsRemove() {
        return $this->styleSheetsRemove;
    }
    
    /**
     * Returns an array of base theme active theme objects keyed by name.
     *
     * The order starts with the base theme of $this and ends with the root of
     * the dependency chain.
     *
     * @return static[]
     *
     * @deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. Use
     *   \Drupal\Core\Theme\ActiveTheme::getBaseThemeExtensions() instead.
     *
     * @see https://www.drupal.org/node/3019948
     */
    public function getBaseThemes() {
        @trigger_error('\\Drupal\\Core\\Theme\\ActiveTheme::getBaseThemes() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use \\Drupal\\Core\\Theme\\ActiveTheme::getBaseThemeExtensions() instead. See https://www.drupal.org/node/3019948', E_USER_DEPRECATED);
        
        /** @var \Drupal\Core\Theme\ThemeInitialization $theme_initialisation */
        $theme_initialisation = \Drupal::service('theme.initialization');
        $base_themes = array_combine(array_keys($this->baseThemeExtensions), array_keys($this->baseThemeExtensions));
        return array_map([
            $theme_initialisation,
            'getActiveThemeByName',
        ], $base_themes);
    }
    
    /**
     * Returns an array of base theme extension objects keyed by name.
     *
     * The order starts with the base theme of $this and ends with the root of
     * the dependency chain.
     *
     * @return \Drupal\Core\Extension\Extension[]
     */
    public function getBaseThemeExtensions() {
        return $this->baseThemeExtensions;
    }
    
    /**
     * Returns the logo provided by the theme.
     *
     * @return string
     *   The logo path.
     */
    public function getLogo() {
        return $this->logo;
    }
    
    /**
     * The regions used by the theme.
     *
     * @return string[]
     *   The list of region machine names supported by the theme.
     *
     * @see system_region_list()
     */
    public function getRegions() {
        return array_keys($this->regions);
    }
    
    /**
     * Returns the libraries or library assets overridden by the active theme.
     *
     * @return array
     *   The list of libraries overrides.
     */
    public function getLibrariesOverride() {
        return $this->librariesOverride;
    }
    
    /**
     * Returns the libraries extended by the active theme.
     *
     * @return array
     *   The list of libraries-extend definitions.
     */
    public function getLibrariesExtend() {
        return $this->librariesExtend;
    }

}