class ThemeEngineExtensionList

Same name in other branches
  1. 9 core/lib/Drupal/Core/Extension/ThemeEngineExtensionList.php \Drupal\Core\Extension\ThemeEngineExtensionList
  2. 8.9.x core/lib/Drupal/Core/Extension/ThemeEngineExtensionList.php \Drupal\Core\Extension\ThemeEngineExtensionList
  3. 10 core/lib/Drupal/Core/Extension/ThemeEngineExtensionList.php \Drupal\Core\Extension\ThemeEngineExtensionList

Provides a list of available theme engines.

@internal This class is not yet stable and therefore there are no guarantees that the internal implementations including constructor signature and protected properties / methods will not change over time. This will be reviewed after https://www.drupal.org/project/drupal/issues/2940481

Hierarchy

Expanded class hierarchy of ThemeEngineExtensionList

3 files declare their use of ThemeEngineExtensionList
ExtensionPathResolverTest.php in core/tests/Drupal/KernelTests/Core/Bootstrap/ExtensionPathResolverTest.php
InstallerThemeEngineExtensionList.php in core/lib/Drupal/Core/Installer/InstallerThemeEngineExtensionList.php
ThemeExtensionListTest.php in core/tests/Drupal/Tests/Core/Extension/ThemeExtensionListTest.php

File

core/lib/Drupal/Core/Extension/ThemeEngineExtensionList.php, line 14

Namespace

Drupal\Core\Extension
View source 
class ThemeEngineExtensionList extends ExtensionList {
    
    /**
     * {@inheritdoc}
     */
    protected $defaults = [
        'dependencies' => [],
        'description' => '',
        'package' => 'Other',
        'version' => NULL,
        'php' => \Drupal::MINIMUM_PHP,
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function getInstalledExtensionNames() {
        // Theme engines do not have an 'install' state, so return names of all
        // discovered theme engines.
        return array_keys($this->extensions);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ExtensionList::$addedPathNames protected property A list of extension folder names directly added in code (not discovered).
ExtensionList::$cache protected property The cache.
ExtensionList::$extensionInfo protected property Static caching for extension info.
ExtensionList::$extensions protected property The cached extensions.
ExtensionList::$infoParser protected property The info parser.
ExtensionList::$installProfile protected property The install profile used by the site.
ExtensionList::$moduleHandler protected property The module handler.
ExtensionList::$pathNames protected property A list of extension folder names keyed by extension name.
ExtensionList::$root protected property The app root.
ExtensionList::$state protected property The state store.
ExtensionList::$type protected property The type of the extension.
ExtensionList::checkIncompatibility public function Tests the compatibility of an extension. 1
ExtensionList::createExtensionInfo protected function Creates the info value for an extension object. 2
ExtensionList::doList protected function Builds the list of extensions. 3
ExtensionList::doScanExtensions protected function Scans the available extensions. 2
ExtensionList::exists public function Determines if an extension exists in the filesystem.
ExtensionList::get public function Returns a single extension. 1
ExtensionList::getAllAvailableInfo public function Returns an array of info files information of available extensions. 1
ExtensionList::getAllInstalledInfo public function Returns an array of info files information of installed extensions. 1
ExtensionList::getExtensionDiscovery protected function Returns the extension discovery. 3
ExtensionList::getExtensionInfo public function Returns information about a specified extension. 1
ExtensionList::getInfoCacheId protected function Returns the extension info cache ID.
ExtensionList::getList public function Returns all available extensions.
ExtensionList::getListCacheId protected function Returns the extension list cache ID.
ExtensionList::getName public function Returns the human-readable name of the extension. 1
ExtensionList::getPath public function Gets the path to an extension of a specific type (module, theme, etc.). 1
ExtensionList::getPathname public function Gets the info file path for an extension. 1
ExtensionList::getPathNames public function Returns a list of extension file paths keyed by machine name. 1
ExtensionList::getPathNamesCacheId protected function Returns the extension filenames cache ID.
ExtensionList::recalculateInfo protected function Generates the information from .info.yml files for extensions of this type. 1
ExtensionList::recalculatePathNames protected function Generates a sorted list of .info.yml file locations for all extensions. 1
ExtensionList::reset public function Resets the stored extension list. 1
ExtensionList::setPathname public function Sets the pathname for an extension. 1
ExtensionList::sortByName public static function Array sorting callback; sorts extensions by their name. 1
ExtensionList::__construct public function Constructs a new instance. 3
ThemeEngineExtensionList::$defaults protected property Default values to be merged into *.info.yml file arrays. Overrides ExtensionList::$defaults
ThemeEngineExtensionList::getInstalledExtensionNames protected function Returns a list of machine names of installed extensions. Overrides ExtensionList::getInstalledExtensionNames

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.