class ModulesUninstallConfirmForm

Same name in other branches
  1. 9 core/modules/system/src/Form/ModulesUninstallConfirmForm.php \Drupal\system\Form\ModulesUninstallConfirmForm
  2. 8.9.x core/modules/system/src/Form/ModulesUninstallConfirmForm.php \Drupal\system\Form\ModulesUninstallConfirmForm
  3. 11.x core/modules/system/src/Form/ModulesUninstallConfirmForm.php \Drupal\system\Form\ModulesUninstallConfirmForm

Builds a confirmation form to uninstall selected modules.

@internal

Hierarchy

Expanded class hierarchy of ModulesUninstallConfirmForm

1 string reference to 'ModulesUninstallConfirmForm'
system.routing.yml in core/modules/system/system.routing.yml
core/modules/system/system.routing.yml

File

core/modules/system/src/Form/ModulesUninstallConfirmForm.php, line 21

Namespace

Drupal\system\Form
View source
class ModulesUninstallConfirmForm extends ConfirmFormBase {
    use ConfigDependencyDeleteFormTrait;
    
    /**
     * The module installer service.
     *
     * @var \Drupal\Core\Extension\ModuleInstallerInterface
     */
    protected $moduleInstaller;
    
    /**
     * The expirable key value store.
     *
     * @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface
     */
    protected $keyValueExpirable;
    
    /**
     * The configuration manager.
     *
     * @var \Drupal\Core\Config\ConfigManagerInterface
     */
    protected $configManager;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * An array of modules to uninstall.
     *
     * @var array
     */
    protected $modules = [];
    
    /**
     * The module extension list.
     *
     * @var \Drupal\Core\Extension\ModuleExtensionList
     */
    protected $moduleExtensionList;
    
    /**
     * Constructs a ModulesUninstallConfirmForm object.
     *
     * @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\Config\ConfigManagerInterface $config_manager
     *   The configuration manager.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Extension\ModuleExtensionList $extension_list_module
     *   The module extension list.
     * @param string|false|null $installProfile
     *   The install profile.
     */
    public function __construct(ModuleInstallerInterface $module_installer, KeyValueStoreExpirableInterface $key_value_expirable, ConfigManagerInterface $config_manager, EntityTypeManagerInterface $entity_type_manager, ModuleExtensionList $extension_list_module, string|false|null $installProfile = NULL) {
        $this->moduleInstaller = $module_installer;
        $this->keyValueExpirable = $key_value_expirable;
        $this->configManager = $config_manager;
        $this->entityTypeManager = $entity_type_manager;
        $this->moduleExtensionList = $extension_list_module;
        $this->installProfile ??= \Drupal::installProfile();
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('module_installer'), $container->get('keyvalue.expirable')
            ->get('modules_uninstall'), $container->get('config.manager'), $container->get('entity_type.manager'), $container->get('extension.list.module'), $container->getParameter('install_profile'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Confirm uninstall');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Uninstall');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return new Url('system.modules_uninstall');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->t('Would you like to continue with uninstalling the above?');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'system_modules_uninstall_confirm_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        // Retrieve the list of modules from the key value store.
        $account = $this->currentUser()
            ->id();
        $this->modules = $this->keyValueExpirable
            ->get($account);
        // Prevent this page from showing when the module list is empty.
        if (empty($this->modules)) {
            $this->messenger()
                ->addError($this->t('The selected modules could not be uninstalled, either due to a website problem or due to the uninstall confirmation form timing out.'));
            return $this->redirect('system.modules_uninstall');
        }
        $data = $this->moduleExtensionList
            ->getList();
        $form['text']['#markup'] = '<p>' . $this->t('The following modules will be completely uninstalled from your site, and <em>all data from these modules will be lost</em>!') . '</p>';
        $form['modules'] = [
            '#theme' => 'item_list',
            '#items' => array_map(function ($module) use ($data) {
                return $data[$module]->info['name'];
            }, $this->modules),
        ];
        if (!empty($this->installProfile) && in_array($this->installProfile, $this->modules, TRUE)) {
            $form['profile']['#markup'] = '<p>' . $this->t('Once uninstalled, the %install_profile profile cannot be reinstalled.', [
                '%install_profile' => $data[$this->installProfile]->info['name'],
            ]) . '</p>';
        }
        // List the dependent entities.
        $this->addDependencyListsToForm($form, 'module', $this->modules, $this->configManager, $this->entityTypeManager);
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // Clear the key value store entry.
        $account = $this->currentUser()
            ->id();
        $this->keyValueExpirable
            ->delete($account);
        // Uninstall the modules.
        $this->moduleInstaller
            ->uninstall($this->modules);
        $this->messenger()
            ->addStatus($this->t('The selected modules have been uninstalled.'));
        $form_state->setRedirectUrl($this->getCancelUrl());
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigDependencyDeleteFormTrait::addDependencyListsToForm protected function Adds form elements to list affected configuration entities.
ConfigDependencyDeleteFormTrait::t abstract protected function Translates a string to the current language or to a given language.
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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. 2
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 57
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.
ModulesUninstallConfirmForm::$configManager protected property The configuration manager.
ModulesUninstallConfirmForm::$entityTypeManager protected property The entity type manager.
ModulesUninstallConfirmForm::$keyValueExpirable protected property The expirable key value store.
ModulesUninstallConfirmForm::$moduleExtensionList protected property The module extension list.
ModulesUninstallConfirmForm::$moduleInstaller protected property The module installer service.
ModulesUninstallConfirmForm::$modules protected property An array of modules to uninstall.
ModulesUninstallConfirmForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
ModulesUninstallConfirmForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ModulesUninstallConfirmForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ModulesUninstallConfirmForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ModulesUninstallConfirmForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
ModulesUninstallConfirmForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ModulesUninstallConfirmForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ModulesUninstallConfirmForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ModulesUninstallConfirmForm::__construct public function Constructs a ModulesUninstallConfirmForm object.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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

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