class RegionalForm

Same name and namespace in other branches
  1. 9 core/modules/system/src/Form/RegionalForm.php \Drupal\system\Form\RegionalForm
  2. 8.9.x core/modules/system/src/Form/RegionalForm.php \Drupal\system\Form\RegionalForm
  3. 10 core/modules/system/src/Form/RegionalForm.php \Drupal\system\Form\RegionalForm

Configure regional settings for this site.

@internal

Hierarchy

Expanded class hierarchy of RegionalForm

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

File

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

Namespace

Drupal\system\Form
View source
class RegionalForm extends ConfigFormBase {
    use RedundantEditableConfigNamesTrait;
    
    /**
     * The country manager.
     *
     * @var \Drupal\Core\Locale\CountryManagerInterface
     */
    protected $countryManager;
    
    /**
     * Constructs a RegionalForm object.
     *
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The factory for configuration objects.
     * @param \Drupal\Core\Config\TypedConfigManagerInterface $typedConfigManager
     *   The typed config manager.
     * @param \Drupal\Core\Locale\CountryManagerInterface $country_manager
     *   The country manager.
     */
    public function __construct(ConfigFactoryInterface $config_factory, TypedConfigManagerInterface $typedConfigManager, CountryManagerInterface $country_manager) {
        parent::__construct($config_factory, $typedConfigManager);
        $this->countryManager = $country_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('config.factory'), $container->get('config.typed'), $container->get('country_manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'system_regional_settings';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $countries = $this->countryManager
            ->getList();
        // Date settings:
        $zones = TimeZoneFormHelper::getOptionsListByRegion();
        $form['locale'] = [
            '#type' => 'details',
            '#title' => $this->t('Locale'),
            '#open' => TRUE,
        ];
        $form['locale']['site_default_country'] = [
            '#type' => 'select',
            '#title' => $this->t('Default country'),
            '#empty_value' => '',
            '#config_target' => new ConfigTarget('system.date', 'country.default', toConfig: fn(?string $value) => $value ?: NULL),
            '#options' => $countries,
            '#attributes' => [
                'class' => [
                    'country-detect',
                ],
            ],
        ];
        $form['locale']['date_first_day'] = [
            '#type' => 'select',
            '#title' => $this->t('First day of week'),
            '#config_target' => 'system.date:first_day',
            '#options' => [
                0 => $this->t('Sunday'),
                1 => $this->t('Monday'),
                2 => $this->t('Tuesday'),
                3 => $this->t('Wednesday'),
                4 => $this->t('Thursday'),
                5 => $this->t('Friday'),
                6 => $this->t('Saturday'),
            ],
        ];
        $form['timezone'] = [
            '#type' => 'details',
            '#title' => $this->t('Time zones'),
            '#open' => TRUE,
        ];
        $form['timezone']['date_default_timezone'] = [
            '#type' => 'select',
            '#title' => $this->t('Default time zone'),
            '#config_target' => new ConfigTarget('system.date', 'timezone.default', static::class . '::loadDefaultTimeZone'),
            '#options' => $zones,
        ];
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * Prepares the saved timezone.default property to be displayed in the form.
     *
     * @param string|null $value
     *   The value saved in config.
     *
     * @return string
     *   The value of the form element.
     */
    public static function loadDefaultTimeZone(?string $value) : string {
        return $value ?: date_default_timezone_get();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigFormBase::CONFIG_KEY_TO_FORM_ELEMENT_MAP protected constant The $form_state key which stores a map of config keys to form elements.
ConfigFormBase::copyFormValuesToConfig private static function Copies form values to Config keys.
ConfigFormBase::doStoreConfigMap protected function Helper method for #after_build callback ::storeConfigKeyToFormElementMap().
ConfigFormBase::formatMultipleViolationsMessage protected function Formats multiple violation messages associated with a single form element. 1
ConfigFormBase::loadDefaultValuesFromConfig public function Process callback to recursively load default values from #config_target.
ConfigFormBase::storeConfigKeyToFormElementMap public function #after_build callback which stores a map of element names to config keys.
ConfigFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm 24
ConfigFormBase::typedConfigManager protected function Returns the typed config manager service.
ConfigFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm 13
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
FormBase::$configFactory protected property The config factory. 2
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. 2
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.
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.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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.
RedundantEditableConfigNamesTrait::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RegionalForm::$countryManager protected property The country manager.
RegionalForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
RegionalForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
RegionalForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RegionalForm::loadDefaultTimeZone public static function Prepares the saved timezone.default property to be displayed in the form.
RegionalForm::__construct public function Constructs a RegionalForm object. 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.