class ThemeInstallController
Same name in other branches
- 11.x core/modules/system/tests/modules/nightwatch_theme_install_utility/src/Controller/ThemeInstallController.php \Drupal\nightwatch_theme_install_utility\Controller\ThemeInstallController
Provides an easier way for Nightwatch tests to install themes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\AutowireTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\nightwatch_theme_install_utility\Controller\ThemeInstallController extends \Drupal\Core\Controller\ControllerBase
Expanded class hierarchy of ThemeInstallController
File
-
core/
modules/ system/ tests/ modules/ nightwatch_theme_install_utility/ src/ Controller/ ThemeInstallController.php, line 13
Namespace
Drupal\nightwatch_theme_install_utility\ControllerView source
class ThemeInstallController extends ControllerBase {
/**
* The theme installer service.
*
* @var \Drupal\Core\Extension\ThemeInstallerInterface
*/
protected $themeInstaller;
/**
* Constructs a new ThemeInstallController.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory.
* @param \Drupal\Core\Extension\ThemeInstallerInterface $theme_installer
* The theme installer.
*/
public function __construct(ConfigFactoryInterface $config_factory, ThemeInstallerInterface $theme_installer) {
$this->configFactory = $config_factory;
$this->themeInstaller = $theme_installer;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('config.factory'), $container->get('theme_installer'));
}
/**
* Install a theme as default.
*
* @param string $theme
* The theme to install as the default theme.
*
* @return array
* A render array confirming installation.
*/
public function installDefault(string $theme) {
return $this->installTheme($theme, 'default');
}
/**
* Install a theme as the admin theme.
* @param string $theme
* The theme to install as the admin theme.
*
* @return array
* A render array confirming installation.
*/
public function installAdmin($theme) {
return $this->installTheme($theme, 'admin');
}
/**
* Installs a theme.
*
* @param string $theme
* The theme to install.
* @param string $default_or_admin
* Which type of theme to install, can be `default` or `admin`.
*
* @return array
* A render array confirming installation.
*/
private function installTheme($theme, $default_or_admin) : array {
assert(in_array($default_or_admin, [
'default',
'admin',
]), 'The $default_or_admin parameter must be `default` or `admin`');
$config = $this->configFactory
->getEditable('system.theme');
$this->themeInstaller
->install([
$theme,
]);
$config->set($default_or_admin, $theme)
->save();
return [
'#type' => 'container',
'#attributes' => [
'id' => 'theme-installed',
],
'#markup' => "Installed {$theme} as {$default_or_admin} theme",
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ControllerBase::$configFactory | protected | property | The configuration factory. | ||
ControllerBase::$currentUser | protected | property | The current user service. | 2 | |
ControllerBase::$entityFormBuilder | protected | property | The entity form builder. | ||
ControllerBase::$entityTypeManager | protected | property | The entity type manager. | ||
ControllerBase::$formBuilder | protected | property | The form builder. | 1 | |
ControllerBase::$keyValue | protected | property | The key-value storage. | 1 | |
ControllerBase::$languageManager | protected | property | The language manager. | 1 | |
ControllerBase::$moduleHandler | protected | property | The module handler. | 1 | |
ControllerBase::$stateService | protected | property | The state service. | ||
ControllerBase::cache | protected | function | Returns the requested cache bin. | ||
ControllerBase::config | protected | function | Retrieves a configuration object. | ||
ControllerBase::container | private | function | Returns the service container. | ||
ControllerBase::currentUser | protected | function | Returns the current user. | 2 | |
ControllerBase::entityFormBuilder | protected | function | Retrieves the entity form builder. | ||
ControllerBase::entityTypeManager | protected | function | Retrieves the entity type manager. | ||
ControllerBase::formBuilder | protected | function | Returns the form builder service. | 1 | |
ControllerBase::keyValue | protected | function | Returns a key/value storage collection. | 1 | |
ControllerBase::languageManager | protected | function | Returns the language manager service. | 1 | |
ControllerBase::moduleHandler | protected | function | Returns the module handler. | 1 | |
ControllerBase::redirect | protected | function | Returns a redirect response object for the specified route. | ||
ControllerBase::state | protected | function | Returns the state storage service. | ||
LoggerChannelTrait::$loggerFactory | protected | property | The logger channel factory service. | ||
LoggerChannelTrait::getLogger | protected | function | Gets the logger for a specific channel. | ||
LoggerChannelTrait::setLoggerFactory | public | function | Injects the logger channel factory. | ||
MessengerTrait::$messenger | protected | property | The messenger. | 16 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 16 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 2 | |
RedirectDestinationTrait::getDestinationArray | protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | ||
RedirectDestinationTrait::getRedirectDestination | protected | function | Returns the redirect destination service. | ||
RedirectDestinationTrait::setRedirectDestination | public | function | Sets the redirect destination service. | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||
ThemeInstallController::$themeInstaller | protected | property | The theme installer service. | ||
ThemeInstallController::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | Overrides AutowireTrait::create | |
ThemeInstallController::installAdmin | public | function | Install a theme as the admin theme. | ||
ThemeInstallController::installDefault | public | function | Install a theme as default. | ||
ThemeInstallController::installTheme | private | function | Installs a theme. | ||
ThemeInstallController::__construct | public | function | Constructs a new ThemeInstallController. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.