class SiteConfigureForm
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Installer/Form/SiteConfigureForm.php \Drupal\Core\Installer\Form\SiteConfigureForm
- 10 core/lib/Drupal/Core/Installer/Form/SiteConfigureForm.php \Drupal\Core\Installer\Form\SiteConfigureForm
- 11.x core/lib/Drupal/Core/Installer/Form/SiteConfigureForm.php \Drupal\Core\Installer\Form\SiteConfigureForm
Provides the site configuration form.
@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\Core\Form\ConfigFormBase extends \Drupal\Core\Form\FormBase uses \Drupal\Core\Form\ConfigFormBaseTrait
- class \Drupal\Core\Installer\Form\SiteConfigureForm extends \Drupal\Core\Form\ConfigFormBase uses \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait
- class \Drupal\Core\Form\ConfigFormBase extends \Drupal\Core\Form\FormBase uses \Drupal\Core\Form\ConfigFormBaseTrait
Expanded class hierarchy of SiteConfigureForm
File
-
core/
lib/ Drupal/ Core/ Installer/ Form/ SiteConfigureForm.php, line 20
Namespace
Drupal\Core\Installer\FormView source
class SiteConfigureForm extends ConfigFormBase {
use DeprecatedServicePropertyTrait;
/**
* The site path.
*
* @var string
*/
protected $sitePath;
/**
* The user storage.
*
* @var \Drupal\user\UserStorageInterface
*/
protected $userStorage;
/**
* {@inheritdoc}
*/
protected $deprecatedProperties = [
'state' => 'state',
];
/**
* The module installer.
*
* @var \Drupal\Core\Extension\ModuleInstallerInterface
*/
protected $moduleInstaller;
/**
* The country manager.
*
* @var \Drupal\Core\Locale\CountryManagerInterface
*/
protected $countryManager;
/**
* The app root.
*
* @var string
*/
protected $root;
/**
* Constructs a new SiteConfigureForm.
*
* Note, for BC reasons, we cannot typehint the last 2 parameters since this
* function used to take 6 arguments, including the 'state' service as the
* fourth parameter.
*
* @todo Clean this up in drupal:10.0.0.
* @see https://www.drupal.org/node/3159456
*
* @param string $root
* The app root.
* @param string $site_path
* The site path.
* @param \Drupal\user\UserStorageInterface $user_storage
* The user storage.
* @param \Drupal\Core\Extension\ModuleInstallerInterface $module_installer
* The module installer.
* @param \Drupal\Core\Locale\CountryManagerInterface $country_manager
* The country manager.
*
* @throws \InvalidArgumentException
* Thrown when either the $module_installer or $country_manager parameters
* are not of the correct type.
*/
public function __construct($root, $site_path, UserStorageInterface $user_storage, $module_installer, $country_manager) {
$this->root = $root;
$this->sitePath = $site_path;
$this->userStorage = $user_storage;
if (!$module_installer instanceof ModuleInstallerInterface) {
@trigger_error('Passing the state service to ' . __METHOD__ . '() is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Only pass five parameters instead. See https://www.drupal.org/node/3158440', E_USER_DEPRECATED);
$module_installer = $country_manager;
$country_manager = @func_get_arg(5);
}
if (!$module_installer instanceof ModuleInstallerInterface) {
throw new \InvalidArgumentException('The fourth argument must implement \\Drupal\\Core\\Extension\\ModuleInstallerInterface.');
}
if (!$country_manager instanceof CountryManagerInterface) {
throw new \InvalidArgumentException('The fifth argument must implement \\Drupal\\Core\\Locale\\CountryManager.');
}
$this->moduleInstaller = $module_installer;
$this->countryManager = $country_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->getParameter('app.root'), $container->getParameter('site.path'), $container->get('entity_type.manager')
->getStorage('user'), $container->get('module_installer'), $container->get('country_manager'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'install_configure_form';
}
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [
'system.date',
'system.site',
'update.settings',
];
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
global $install_state;
$form['#title'] = $this->t('Configure site');
// Warn about settings.php permissions risk
$settings_dir = $this->sitePath;
$settings_file = $settings_dir . '/settings.php';
// Check that $_POST is empty so we only show this message when the form is
// first displayed, not on the next page after it is submitted. (We do not
// want to repeat it multiple times because it is a general warning that is
// not related to the rest of the installation process; it would also be
// especially out of place on the last page of the installer, where it would
// distract from the message that the Drupal installation has completed
// successfully.)
$post_params = $this->getRequest()->request
->all();
if (empty($post_params) && (Settings::get('skip_permissions_hardening') || !drupal_verify_install_file($this->root . '/' . $settings_file, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE) || !drupal_verify_install_file($this->root . '/' . $settings_dir, FILE_NOT_WRITABLE, 'dir'))) {
$this->messenger()
->addWarning($this->t('All necessary changes to %dir and %file have been made, so you should remove write permissions to them now in order to avoid security risks. If you are unsure how to do so, consult the <a href=":handbook_url">online handbook</a>.', [
'%dir' => $settings_dir,
'%file' => $settings_file,
':handbook_url' => 'https://www.drupal.org/server-permissions',
]));
}
$form['#attached']['library'][] = 'system/drupal.system';
// Add JavaScript time zone detection.
$form['#attached']['library'][] = 'core/drupal.timezone';
// We add these strings as settings because JavaScript translation does not
// work during installation.
$form['#attached']['drupalSettings']['copyFieldValue']['edit-site-mail'] = [
'edit-account-mail',
];
$form['site_information'] = [
'#type' => 'fieldgroup',
'#title' => $this->t('Site information'),
'#access' => empty($install_state['config_install_path']),
];
$form['site_information']['site_name'] = [
'#type' => 'textfield',
'#title' => $this->t('Site name'),
'#required' => TRUE,
'#weight' => -20,
'#access' => empty($install_state['config_install_path']),
];
// Use the default site mail if one is already configured, or fall back to
// PHP's configured sendmail_from.
$default_site_mail = $this->config('system.site')
->get('mail') ?: ini_get('sendmail_from');
$form['site_information']['site_mail'] = [
'#type' => 'email',
'#title' => $this->t('Site email address'),
'#default_value' => $default_site_mail,
'#description' => $this->t("Automated emails, such as registration information, will be sent from this address. Use an address ending in your site's domain to help prevent these emails from being flagged as spam."),
'#required' => TRUE,
'#weight' => -15,
'#access' => empty($install_state['config_install_path']),
];
$form['admin_account'] = [
'#type' => 'fieldgroup',
'#title' => $this->t('Site maintenance account'),
];
$form['admin_account']['account']['name'] = [
'#type' => 'textfield',
'#title' => $this->t('Username'),
'#maxlength' => UserInterface::USERNAME_MAX_LENGTH,
'#description' => $this->t("Several special characters are allowed, including space, period (.), hyphen (-), apostrophe ('), underscore (_), and the @ sign."),
'#required' => TRUE,
'#attributes' => [
'class' => [
'username',
],
],
];
$form['admin_account']['account']['pass'] = [
'#type' => 'password_confirm',
'#required' => TRUE,
'#size' => 25,
];
$form['admin_account']['account']['#tree'] = TRUE;
$form['admin_account']['account']['mail'] = [
'#type' => 'email',
'#title' => $this->t('Email address'),
'#required' => TRUE,
];
$form['regional_settings'] = [
'#type' => 'fieldgroup',
'#title' => $this->t('Regional settings'),
'#access' => empty($install_state['config_install_path']),
];
$countries = $this->countryManager
->getList();
$form['regional_settings']['site_default_country'] = [
'#type' => 'select',
'#title' => $this->t('Default country'),
'#empty_value' => '',
'#default_value' => $this->config('system.date')
->get('country.default'),
'#options' => $countries,
'#weight' => 0,
'#access' => empty($install_state['config_install_path']),
];
// Use the default site timezone if one is already configured, or fall back
// to the system timezone if set (and avoid throwing a warning in
// PHP >=5.4).
$default_timezone = $this->config('system.date')
->get('timezone.default') ?: @date_default_timezone_get();
$form['regional_settings']['date_default_timezone'] = [
'#type' => 'select',
'#title' => $this->t('Default time zone'),
'#default_value' => $default_timezone,
'#options' => system_time_zones(NULL, TRUE),
'#weight' => 5,
'#attributes' => [
'class' => [
'timezone-detect',
],
],
'#access' => empty($install_state['config_install_path']),
];
$form['update_notifications'] = [
'#type' => 'fieldgroup',
'#title' => $this->t('Update notifications'),
'#description' => $this->t('When checking for updates, anonymous information about your site is sent to <a href="@drupal">Drupal.org</a>.', [
'@drupal' => 'https://drupal.org',
]),
'#access' => empty($install_state['config_install_path']),
];
$form['update_notifications']['enable_update_status_module'] = [
'#type' => 'checkbox',
'#title' => $this->t('Check for updates automatically'),
'#default_value' => 1,
'#access' => empty($install_state['config_install_path']),
];
$form['update_notifications']['enable_update_status_emails'] = [
'#type' => 'checkbox',
'#title' => $this->t('Receive email notifications'),
'#default_value' => 1,
'#states' => [
'visible' => [
'input[name="enable_update_status_module"]' => [
'checked' => TRUE,
],
],
],
'#access' => empty($install_state['config_install_path']),
];
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Save and continue'),
'#weight' => 15,
'#button_type' => 'primary',
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
if ($error = user_validate_name($form_state->getValue([
'account',
'name',
]))) {
$form_state->setErrorByName('account][name', $error);
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
global $install_state;
if (empty($install_state['config_install_path'])) {
$this->config('system.site')
->set('name', (string) $form_state->getValue('site_name'))
->set('mail', (string) $form_state->getValue('site_mail'))
->save(TRUE);
$this->config('system.date')
->set('timezone.default', (string) $form_state->getValue('date_default_timezone'))
->set('country.default', (string) $form_state->getValue('site_default_country'))
->save(TRUE);
}
$account_values = $form_state->getValue('account');
// Enable update.module if this option was selected.
$update_status_module = $form_state->getValue('enable_update_status_module');
if (empty($install_state['config_install_path']) && $update_status_module) {
$this->moduleInstaller
->install([
'update',
]);
// Add the site maintenance account's email address to the list of
// addresses to be notified when updates are available, if selected.
$email_update_status_emails = $form_state->getValue('enable_update_status_emails');
if ($email_update_status_emails) {
// Reset the configuration factory so it is updated with the new module.
$this->resetConfigFactory();
$this->config('update.settings')
->set('notification.emails', [
$account_values['mail'],
])
->save(TRUE);
}
}
// We precreated user 1 with placeholder values. Let's save the real values.
$account = $this->userStorage
->load(1);
$account->init = $account->mail = $account_values['mail'];
$account->roles = $account->getRoles();
$account->activate();
$account->timezone = $form_state->getValue('date_default_timezone');
$account->pass = $account_values['pass'];
$account->name = $account_values['name'];
$account->save();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigFormBaseTrait::config | protected | function | Retrieves a configuration object. | ||
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
DeprecatedServicePropertyTrait::__get | public | function | Allows to access deprecated/removed properties. | ||
FormBase::$configFactory | protected | property | The config factory. | 3 | |
FormBase::$requestStack | protected | property | The request stack. | 1 | |
FormBase::$routeMatch | protected | property | The route match. | ||
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. | ||
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. | ||
SiteConfigureForm::$countryManager | protected | property | The country manager. | ||
SiteConfigureForm::$deprecatedProperties | protected | property | |||
SiteConfigureForm::$moduleInstaller | protected | property | The module installer. | ||
SiteConfigureForm::$root | protected | property | The app root. | ||
SiteConfigureForm::$sitePath | protected | property | The site path. | ||
SiteConfigureForm::$userStorage | protected | property | The user storage. | ||
SiteConfigureForm::buildForm | public | function | Form constructor. | Overrides ConfigFormBase::buildForm | |
SiteConfigureForm::create | public static | function | Instantiates a new instance of this class. | Overrides ConfigFormBase::create | |
SiteConfigureForm::getEditableConfigNames | protected | function | Gets the configuration names that will be editable. | Overrides ConfigFormBaseTrait::getEditableConfigNames | |
SiteConfigureForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
SiteConfigureForm::submitForm | public | function | Form submission handler. | Overrides ConfigFormBase::submitForm | |
SiteConfigureForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | |
SiteConfigureForm::__construct | public | function | Constructs a new SiteConfigureForm. | Overrides ConfigFormBase::__construct | |
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.