class ModulesListConfirmForm

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

Builds a confirmation form for enabling modules with dependencies.

@internal

Hierarchy

Expanded class hierarchy of ModulesListConfirmForm

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

File

core/modules/system/src/Form/ModulesListConfirmForm.php, line 20

Namespace

Drupal\system\Form
View source
class ModulesListConfirmForm extends ConfirmFormBase {
    
    /**
     * The module handler service.
     *
     * @var \Drupal\Core\Extension\ModuleHandlerInterface
     */
    protected $moduleHandler;
    
    /**
     * The expirable key value store.
     *
     * @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface
     */
    protected $keyValueExpirable;
    
    /**
     * An associative list of modules to enable or disable.
     *
     * @var array
     */
    protected $modules = [];
    
    /**
     * The module installer.
     *
     * @var \Drupal\Core\Extension\ModuleInstallerInterface
     */
    protected $moduleInstaller;
    
    /**
     * Constructs a ModulesListConfirmForm 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.
     */
    public function __construct(ModuleHandlerInterface $module_handler, ModuleInstallerInterface $module_installer, KeyValueStoreExpirableInterface $key_value_expirable) {
        $this->moduleHandler = $module_handler;
        $this->moduleInstaller = $module_installer;
        $this->keyValueExpirable = $key_value_expirable;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('module_handler'), $container->get('module_installer'), $container->get('keyvalue.expirable')
            ->get('module_list'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Some required modules must be enabled');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return new Url('system.modules_list');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Continue');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->t('Would you like to continue with the above?');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'system_modules_confirm_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $account = $this->currentUser()
            ->id();
        $this->modules = $this->keyValueExpirable
            ->get($account);
        // Redirect to the modules list page if the key value store is empty.
        if (!$this->modules) {
            return $this->redirect('system.modules_list');
        }
        $items = $this->buildMessageList();
        $form['message'] = [
            '#theme' => 'item_list',
            '#items' => $items,
        ];
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * Builds the message list for the confirmation form.
     *
     * @return \Drupal\Component\Render\MarkupInterface[]
     *   Array of markup for the list of messages on the form.
     *
     * @see \Drupal\system\Form\ModulesListForm::buildModuleList()
     */
    protected function buildMessageList() {
        $items = [];
        if (!empty($this->modules['dependencies'])) {
            // Display a list of required modules that have to be installed as well
            // but were not manually selected.
            foreach ($this->modules['dependencies'] as $module => $dependencies) {
                $items[] = $this->formatPlural(count($dependencies), 'You must enable the @required module to install @module.', 'You must enable the @required modules to install @module.', [
                    '@module' => $this->modules['install'][$module],
                    // It is safe to implode this because module names are not translated
                    // markup and so will not be double-escaped.
'@required' => implode(', ', $dependencies),
                ]);
            }
        }
        return $items;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        // Remove the key value store entry.
        $account = $this->currentUser()
            ->id();
        $this->keyValueExpirable
            ->delete($account);
        if (!empty($this->modules['install'])) {
            // Don't catch the exception that this can throw for missing dependencies:
            // the form doesn't allow modules with unmet dependencies, so the only way
            // this can happen is if the filesystem changed between form display and
            // submit, in which case the user has bigger problems.
            try {
                // Install the given modules.
                $this->moduleInstaller
                    ->install(array_keys($this->modules['install']));
            } catch (PreExistingConfigException $e) {
                $config_objects = $e->flattenConfigObjects($e->getConfigObjects());
                $this->messenger()
                    ->addError($this->formatPlural(count($config_objects), 'Unable to install @extension, %config_names already exists in active configuration.', 'Unable to install @extension, %config_names already exist in active configuration.', [
                    '%config_names' => implode(', ', $config_objects),
                    '@extension' => $this->modules['install'][$e->getExtension()],
                ]));
                return;
            } catch (UnmetDependenciesException $e) {
                $this->messenger()
                    ->addError($e->getTranslatedMessage($this->getStringTranslation(), $this->modules['install'][$e->getExtension()]));
                return;
            }
            $module_names = array_values($this->modules['install']);
            $this->messenger()
                ->addStatus($this->formatPlural(count($module_names), 'Module %name has been enabled.', '@count modules have been enabled: %names.', [
                '%name' => $module_names[0],
                '%names' => implode(', ', $module_names),
            ]));
        }
        $form_state->setRedirectUrl($this->getCancelUrl());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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 An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
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. Overrides UrlGeneratorTrait::redirect
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 73
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator 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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
ModulesListConfirmForm::$keyValueExpirable protected property The expirable key value store.
ModulesListConfirmForm::$moduleHandler protected property The module handler service.
ModulesListConfirmForm::$moduleInstaller protected property The module installer.
ModulesListConfirmForm::$modules protected property An associative list of modules to enable or disable.
ModulesListConfirmForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
ModulesListConfirmForm::buildMessageList protected function Builds the message list for the confirmation form. 1
ModulesListConfirmForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ModulesListConfirmForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ModulesListConfirmForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ModulesListConfirmForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
ModulesListConfirmForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 1
ModulesListConfirmForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion 1
ModulesListConfirmForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ModulesListConfirmForm::__construct public function Constructs a ModulesListConfirmForm 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.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.

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