class ModulesUninstallForm
Same name in other branches
- 8.9.x core/modules/system/src/Form/ModulesUninstallForm.php \Drupal\system\Form\ModulesUninstallForm
- 10 core/modules/system/src/Form/ModulesUninstallForm.php \Drupal\system\Form\ModulesUninstallForm
- 11.x core/modules/system/src/Form/ModulesUninstallForm.php \Drupal\system\Form\ModulesUninstallForm
Provides a form for uninstalling modules.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\system\Form\ModulesUninstallForm extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of ModulesUninstallForm
1 string reference to 'ModulesUninstallForm'
- system.routing.yml in core/
modules/ system/ system.routing.yml - core/modules/system/system.routing.yml
File
-
core/
modules/ system/ src/ Form/ ModulesUninstallForm.php, line 22
Namespace
Drupal\system\FormView source
class ModulesUninstallForm extends FormBase {
/**
* The module handler service.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The module installer service.
*
* @var \Drupal\Core\Extension\ModuleInstallerInterface
*/
protected $moduleInstaller;
/**
* The expirable key value store.
*
* @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface
*/
protected $keyValueExpirable;
/**
* The module extension list.
*
* @var \Drupal\Core\Extension\ModuleExtensionList
*/
protected $moduleExtensionList;
/**
* The update registry service.
*
* @var \Drupal\Core\Update\UpdateHookRegistry
*/
protected $updateRegistry;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('module_handler'), $container->get('module_installer'), $container->get('keyvalue.expirable')
->get('modules_uninstall'), $container->get('extension.list.module'), $container->get('update.update_hook_registry'));
}
/**
* Constructs a ModulesUninstallForm object.
*
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Extension\ModuleInstallerInterface $module_installer
* The module installer.
* @param \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface $key_value_expirable
* The key value expirable factory.
* @param \Drupal\Core\Extension\ModuleExtensionList $extension_list_module
* The module extension list.
* @param \Drupal\Core\Update\UpdateHookRegistry|null $versioning_update_registry
* Versioning update registry service.
*/
public function __construct(ModuleHandlerInterface $module_handler, ModuleInstallerInterface $module_installer, KeyValueStoreExpirableInterface $key_value_expirable, ModuleExtensionList $extension_list_module, UpdateHookRegistry $versioning_update_registry = NULL) {
$this->moduleExtensionList = $extension_list_module;
$this->moduleHandler = $module_handler;
$this->moduleInstaller = $module_installer;
$this->keyValueExpirable = $key_value_expirable;
if ($versioning_update_registry === NULL) {
@trigger_error('The update.update_hook_registry service must be passed to ' . __NAMESPACE__ . '\\ModulesUninstallForm::__construct(). It was added in drupal:9.3.0 and will be required before drupal:10.0.0.', E_USER_DEPRECATED);
$versioning_update_registry = \Drupal::service('update.update_hook_registry');
}
$this->updateRegistry = $versioning_update_registry;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'system_modules_uninstall';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
// Make sure the install API is available.
include_once DRUPAL_ROOT . '/core/includes/install.inc';
// Get a list of all available modules that can be uninstalled.
$uninstallable = array_filter($this->moduleExtensionList
->getList(), function ($module) {
return empty($module->info['required']) && $module->status;
});
// Include system.admin.inc so we can use the sort callbacks.
$this->moduleHandler
->loadInclude('system', 'inc', 'system.admin');
$form['filters'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'table-filter',
'js-show',
],
],
];
$form['filters']['text'] = [
'#type' => 'search',
'#title' => $this->t('Filter modules'),
'#title_display' => 'invisible',
'#size' => 30,
'#placeholder' => $this->t('Filter by name or description'),
'#description' => $this->t('Enter a part of the module name or description'),
'#attributes' => [
'class' => [
'table-filter-text',
],
'data-table' => '#system-modules-uninstall',
'autocomplete' => 'off',
],
];
$form['modules'] = [];
// Only build the rest of the form if there are any modules available to
// uninstall;
if (empty($uninstallable)) {
return $form;
}
// Deprecated and obsolete modules should appear at the top of the
// uninstallation list.
$unstable_lifecycle = array_flip([
ExtensionLifecycle::DEPRECATED,
ExtensionLifecycle::OBSOLETE,
]);
// Sort all modules by their lifecycle identifier and name.
uasort($uninstallable, function ($a, $b) use ($unstable_lifecycle) {
$lifecycle_a = isset($unstable_lifecycle[$a->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER]]) ? -1 : 1;
$lifecycle_b = isset($unstable_lifecycle[$b->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER]]) ? -1 : 1;
if ($lifecycle_a === $lifecycle_b) {
return ModuleExtensionList::sortByName($a, $b);
}
return $lifecycle_a <=> $lifecycle_b;
});
$validation_reasons = $this->moduleInstaller
->validateUninstall(array_keys($uninstallable));
$form['uninstall'] = [
'#tree' => TRUE,
];
foreach ($uninstallable as $module_key => $module) {
$name = $module->info['name'] ?: $module->getName();
$form['modules'][$module->getName()]['#module_name'] = $name;
$form['modules'][$module->getName()]['name']['#markup'] = $name;
$form['modules'][$module->getName()]['description']['#markup'] = $this->t($module->info['description']);
$lifecycle = $module->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER];
if ($lifecycle !== ExtensionLifecycle::STABLE && !empty($module->info[ExtensionLifecycle::LIFECYCLE_LINK_IDENTIFIER])) {
$form['modules'][$module->getName()]['name']['#markup'] .= ' ' . Link::fromTextAndUrl('(' . $this->t('@lifecycle', [
'@lifecycle' => ucfirst($lifecycle),
]) . ')', Url::fromUri($module->info[ExtensionLifecycle::LIFECYCLE_LINK_IDENTIFIER], [
'attributes' => [
'class' => 'module-link--non-stable',
'aria-label' => $this->t('View information on the @lifecycle status of the module @module', [
'@lifecycle' => ucfirst($lifecycle),
'@module' => $module->info['name'],
]),
],
]))
->toString();
}
$form['uninstall'][$module->getName()] = [
'#type' => 'checkbox',
'#title' => $this->t('Uninstall @module module', [
'@module' => $name,
]),
'#title_display' => 'invisible',
];
// If a validator returns reasons not to uninstall a module,
// list the reasons and disable the check box.
if (isset($validation_reasons[$module_key])) {
$form['modules'][$module->getName()]['#validation_reasons'] = $validation_reasons[$module_key];
$form['uninstall'][$module->getName()]['#disabled'] = TRUE;
}
// All modules which depend on this one must be uninstalled first, before
// we can allow this module to be uninstalled.
foreach (array_keys($module->required_by) as $dependent) {
if ($this->updateRegistry
->getInstalledVersion($dependent) !== $this->updateRegistry::SCHEMA_UNINSTALLED) {
$form['modules'][$module->getName()]['#required_by'][] = $dependent;
$form['uninstall'][$module->getName()]['#disabled'] = TRUE;
}
}
}
$form['#attached']['library'][] = 'system/drupal.system.modules';
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Uninstall'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
// Form submitted, but no modules selected.
if (!array_filter($form_state->getValue('uninstall'))) {
$form_state->setErrorByName('', $this->t('No modules selected.'));
$form_state->setRedirect('system.modules_uninstall');
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Save all the values in an expirable key value store.
$modules = $form_state->getValue('uninstall');
$uninstall = array_keys(array_filter($modules));
$account = $this->currentUser()
->id();
// Store the values for 6 hours. This expiration time is also used in
// the form cache.
$this->keyValueExpirable
->setWithExpire($account, $uninstall, 6 * 60 * 60);
// Redirect to the confirm form.
$form_state->setRedirect('system.modules_uninstall_confirm');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
FormBase::$configFactory | protected | property | The config factory. | 3 | |
FormBase::$requestStack | protected | property | The request stack. | 1 | |
FormBase::$routeMatch | protected | property | The route match. | ||
FormBase::config | protected | function | Retrieves a configuration object. | ||
FormBase::configFactory | protected | function | Gets the config factory for this form. | 3 | |
FormBase::container | private | function | Returns the service container. | ||
FormBase::currentUser | protected | function | Gets the current user. | ||
FormBase::getRequest | protected | function | Gets the request object. | ||
FormBase::getRouteMatch | protected | function | Gets the route match. | ||
FormBase::logger | protected | function | Gets the logger for a specific channel. | ||
FormBase::redirect | protected | function | Returns a redirect response object for the specified route. | ||
FormBase::resetConfigFactory | public | function | Resets the configuration factory. | ||
FormBase::setConfigFactory | public | function | Sets the config factory for this form. | ||
FormBase::setRequestStack | public | function | Sets the request stack object to use. | ||
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. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
ModulesUninstallForm::$keyValueExpirable | protected | property | The expirable key value store. | ||
ModulesUninstallForm::$moduleExtensionList | protected | property | The module extension list. | ||
ModulesUninstallForm::$moduleHandler | protected | property | The module handler service. | ||
ModulesUninstallForm::$moduleInstaller | protected | property | The module installer service. | ||
ModulesUninstallForm::$updateRegistry | protected | property | The update registry service. | ||
ModulesUninstallForm::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | |
ModulesUninstallForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | |
ModulesUninstallForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
ModulesUninstallForm::submitForm | public | function | Form submission handler. | Overrides FormInterface::submitForm | |
ModulesUninstallForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | |
ModulesUninstallForm::__construct | public | function | Constructs a ModulesUninstallForm object. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 1 | |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.