class SelectProfileForm

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Installer/Form/SelectProfileForm.php \Drupal\Core\Installer\Form\SelectProfileForm
  2. 10 core/lib/Drupal/Core/Installer/Form/SelectProfileForm.php \Drupal\Core\Installer\Form\SelectProfileForm
  3. 11.x core/lib/Drupal/Core/Installer/Form/SelectProfileForm.php \Drupal\Core\Installer\Form\SelectProfileForm

Provides the profile selection form.

@internal

Hierarchy

Expanded class hierarchy of SelectProfileForm

1 file declares its use of SelectProfileForm
InstallerExistingConfigTestBase.php in core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigTestBase.php

File

core/lib/Drupal/Core/Installer/Form/SelectProfileForm.php, line 15

Namespace

Drupal\Core\Installer\Form
View source
class SelectProfileForm extends FormBase {
    
    /**
     * The key used in the profile list for the install from config option.
     *
     * This key must not be a valid profile extension name.
     */
    const CONFIG_INSTALL_PROFILE_KEY = '::existing_config::';
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'install_select_profile_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, $install_state = NULL) {
        $form['#title'] = $this->t('Select an installation profile');
        $profiles = [];
        $names = [];
        foreach ($install_state['profiles'] as $profile) {
            
            /** @var $profile \Drupal\Core\Extension\Extension */
            $details = install_profile_info($profile->getName());
            // Don't show hidden profiles. This is used by to hide the testing profile,
            // which only exists to speed up test runs.
            if ($details['hidden'] === TRUE && !drupal_valid_test_ua()) {
                continue;
            }
            $profiles[$profile->getName()] = $details;
            // Determine the name of the profile; default to file name if defined name
            // is unspecified.
            $name = isset($details['name']) ? $details['name'] : $profile->getName();
            $names[$profile->getName()] = $name;
        }
        // Display radio buttons alphabetically by human-readable name, but always
        // put the core profiles first (if they are present in the filesystem).
        natcasesort($names);
        if (isset($names['minimal'])) {
            // If the expert ("Minimal") core profile is present, put it in front of
            // any non-core profiles rather than including it with them alphabetically,
            // since the other profiles might be intended to group together in a
            // particular way.
            $names = [
                'minimal' => $names['minimal'],
            ] + $names;
        }
        if (isset($names['standard'])) {
            // If the default ("Standard") core profile is present, put it at the very
            // top of the list. This profile will have its radio button pre-selected,
            // so we want it to always appear at the top.
            $names = [
                'standard' => $names['standard'],
            ] + $names;
        }
        // The profile name and description are extracted for translation from the
        // .info file, so we can use $this->t() on them even though they are dynamic
        // data at this point.
        $form['profile'] = [
            '#type' => 'radios',
            '#title' => $this->t('Select an installation profile'),
            '#title_display' => 'invisible',
            '#options' => array_map([
                $this,
                't',
            ], $names),
            '#default_value' => 'standard',
        ];
        foreach (array_keys($names) as $profile_name) {
            $form['profile'][$profile_name]['#description'] = isset($profiles[$profile_name]['description']) ? $this->t($profiles[$profile_name]['description']) : '';
            // @todo Remove hardcoding of 'demo_umami' profile for a generic warning
            // system in https://www.drupal.org/project/drupal/issues/2822414.
            if ($profile_name === 'demo_umami') {
                $this->addUmamiWarning($form);
            }
        }
        $config_sync_directory = Settings::get('config_sync_directory');
        if (!empty($config_sync_directory)) {
            $sync = new FileStorage($config_sync_directory);
            $extensions = $sync->read('core.extension');
            $site = $sync->read('system.site');
            if (isset($site['name']) && isset($extensions['profile']) && in_array($extensions['profile'], array_keys($names), TRUE)) {
                // Ensure the profile can be installed from configuration. Install
                // profile's which implement hook_INSTALL() are not supported.
                // @todo https://www.drupal.org/project/drupal/issues/2982052 Remove
                //   this restriction.
                module_load_install($extensions['profile']);
                if (!function_exists($extensions['profile'] . '_install')) {
                    $form['profile']['#options'][static::CONFIG_INSTALL_PROFILE_KEY] = $this->t('Use existing configuration');
                    $form['profile'][static::CONFIG_INSTALL_PROFILE_KEY]['#description'] = [
                        'description' => [
                            '#markup' => $this->t('Install %name using existing configuration.', [
                                '%name' => $site['name'],
                            ]),
                        ],
                        'info' => [
                            '#type' => 'item',
                            '#markup' => $this->t('The configuration from the directory %sync_directory will be used.', [
                                '%sync_directory' => $config_sync_directory,
                            ]),
                            '#wrapper_attributes' => [
                                'class' => [
                                    'messages',
                                    'messages--status',
                                ],
                            ],
                            '#states' => [
                                'visible' => [
                                    ':input[name="profile"]' => [
                                        'value' => static::CONFIG_INSTALL_PROFILE_KEY,
                                    ],
                                ],
                            ],
                        ],
                    ];
                }
            }
        }
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Save and continue'),
            '#button_type' => 'primary',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        global $install_state;
        $profile = $form_state->getValue('profile');
        if ($profile === static::CONFIG_INSTALL_PROFILE_KEY) {
            $sync = new FileStorage(Settings::get('config_sync_directory'));
            $profile = $sync->read('core.extension')['profile'];
            $install_state['parameters']['existing_config'] = TRUE;
        }
        $install_state['parameters']['profile'] = $profile;
    }
    
    /**
     * Show profile warning if 'demo_umami' profile is selected.
     */
    protected function addUmamiWarning(array &$form) {
        // Warning to show when this profile is selected.
        $description = $form['profile']['demo_umami']['#description'];
        // Re-defines radio #description to show warning when selected.
        $form['profile']['demo_umami']['#description'] = [
            'warning' => [
                '#type' => 'item',
                '#markup' => $this->t('This profile is intended for demonstration purposes only.'),
                '#wrapper_attributes' => [
                    'class' => [
                        'messages',
                        'messages--warning',
                    ],
                ],
                '#states' => [
                    'visible' => [
                        ':input[name="profile"]' => [
                            'value' => 'demo_umami',
                        ],
                    ],
                ],
            ],
            'description' => [
                '#markup' => $description,
            ],
        ];
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
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.
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.
SelectProfileForm::addUmamiWarning protected function Show profile warning if 'demo_umami' profile is selected.
SelectProfileForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SelectProfileForm::CONFIG_INSTALL_PROFILE_KEY constant The key used in the profile list for the install from config option.
SelectProfileForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SelectProfileForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.