class ThemeEngineExtensionList in Drupal 8

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

• class \Drupal\Core\Extension\ExtensionList
  • class \Drupal\Core\Extension\ThemeEngineExtensionList

2 files declare their use of ThemeEngineExtensionList

InstallerThemeEngineExtensionList.php in core/lib/Drupal/Core/Installer/InstallerThemeEngineExtensionList.php

ThemeExtensionListTest.php in core/tests/Drupal/Tests/Core/Extension/ThemeExtensionListTest.php

1 string reference to 'ThemeEngineExtensionList'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses ThemeEngineExtensionList

extension.list.theme_engine in core/core.services.yml

Drupal\Core\Extension\ThemeEngineExtensionList

File

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

Namespace

Drupal\Core\Extension

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

Name	Modifiers	Type	Description	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: "module", "theme" or "profile".
ExtensionList::checkIncompatibility	public	function	Tests the compatibility of an extension.
ExtensionList::createExtensionInfo	protected	function	Creates the info value for an extension object.	1
ExtensionList::doList	protected	function	Builds the list of extensions.	2
ExtensionList::doScanExtensions	protected	function	Scans the available extensions.	1
ExtensionList::exists	public	function	Determines if an extension exists in the filesystem.
ExtensionList::get	public	function	Returns a single extension.
ExtensionList::getAllAvailableInfo	public	function	Returns an array of info files information of available extensions.
ExtensionList::getAllInstalledInfo	public	function	Returns an array of info files information of installed extensions.
ExtensionList::getExtensionDiscovery	protected	function	Returns the extension discovery.	3
ExtensionList::getExtensionInfo	public	function	Returns information about a specified extension.
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.
ExtensionList::getPath	public	function	Gets the path to an extension of a specific type (module, theme, etc.).
ExtensionList::getPathname	public	function	Gets the info file path for an extension.
ExtensionList::getPathnames	public	function	Returns a list of extension file paths keyed by machine name.
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.
ExtensionList::recalculatePathnames	protected	function	Generates a sorted list of .info.yml file locations for all extensions.
ExtensionList::reset	public	function	Resets the stored extension list.	1
ExtensionList::setPathname	public	function	Sets the pathname for an extension.
ExtensionList::__construct	public	function	Constructs a new instance.	2
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