class RegionalForm in Zircon Profile 8

Configure regional settings for this site.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\system\Form\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 19

Contains \Drupal\system\Form\RegionalForm.

Namespace

Drupal\system\Form

class RegionalForm extends ConfigFormBase {

  /**
   * 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\Locale\CountryManagerInterface $country_manager
   *   The country manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, CountryManagerInterface $country_manager) {
    parent::__construct($config_factory);
    $this->countryManager = $country_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('country_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'system_regional_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'system.date',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $countries = $this->countryManager
      ->getList();
    $system_date = $this
      ->config('system.date');

    // Date settings:
    $zones = system_time_zones();
    $form['locale'] = array(
      '#type' => 'details',
      '#title' => t('Locale'),
      '#open' => TRUE,
    );
    $form['locale']['site_default_country'] = array(
      '#type' => 'select',
      '#title' => t('Default country'),
      '#empty_value' => '',
      '#default_value' => $system_date
        ->get('country.default'),
      '#options' => $countries,
      '#attributes' => array(
        'class' => array(
          'country-detect',
        ),
      ),
    );
    $form['locale']['date_first_day'] = array(
      '#type' => 'select',
      '#title' => t('First day of week'),
      '#default_value' => $system_date
        ->get('first_day'),
      '#options' => array(
        0 => t('Sunday'),
        1 => t('Monday'),
        2 => t('Tuesday'),
        3 => t('Wednesday'),
        4 => t('Thursday'),
        5 => t('Friday'),
        6 => t('Saturday'),
      ),
    );
    $form['timezone'] = array(
      '#type' => 'details',
      '#title' => t('Time zones'),
      '#open' => TRUE,
    );
    $form['timezone']['date_default_timezone'] = array(
      '#type' => 'select',
      '#title' => t('Default time zone'),
      '#default_value' => $system_date
        ->get('timezone.default') ?: date_default_timezone_get(),
      '#options' => $zones,
    );
    $configurable_timezones = $system_date
      ->get('timezone.user.configurable');
    $form['timezone']['configurable_timezones'] = array(
      '#type' => 'checkbox',
      '#title' => t('Users may set their own time zone'),
      '#default_value' => $configurable_timezones,
    );
    $form['timezone']['configurable_timezones_wrapper'] = array(
      '#type' => 'container',
      '#states' => array(
        // Hide the user configured timezone settings when users are forced to use
        // the default setting.
        'invisible' => array(
          'input[name="configurable_timezones"]' => array(
            'checked' => FALSE,
          ),
        ),
      ),
    );
    $form['timezone']['configurable_timezones_wrapper']['empty_timezone_message'] = array(
      '#type' => 'checkbox',
      '#title' => t('Remind users at login if their time zone is not set'),
      '#default_value' => $system_date
        ->get('timezone.user.warn'),
      '#description' => t('Only applied if users may set their own time zone.'),
    );
    $form['timezone']['configurable_timezones_wrapper']['user_default_timezone'] = array(
      '#type' => 'radios',
      '#title' => t('Time zone for new users'),
      '#default_value' => $system_date
        ->get('timezone.user.default'),
      '#options' => array(
        DRUPAL_USER_TIMEZONE_DEFAULT => t('Default time zone'),
        DRUPAL_USER_TIMEZONE_EMPTY => t('Empty time zone'),
        DRUPAL_USER_TIMEZONE_SELECT => t('Users may set their own time zone at registration'),
      ),
      '#description' => t('Only applied if users may set their own time zone.'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('system.date')
      ->set('country.default', $form_state
      ->getValue('site_default_country'))
      ->set('first_day', $form_state
      ->getValue('date_first_day'))
      ->set('timezone.default', $form_state
      ->getValue('date_default_timezone'))
      ->set('timezone.user.configurable', $form_state
      ->getValue('configurable_timezones'))
      ->set('timezone.user.warn', $form_state
      ->getValue('empty_timezone_message'))
      ->set('timezone.user.default', $form_state
      ->getValue('user_default_timezone'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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::$loggerFactory	protected	property	The logger factory.
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::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	64
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator	protected	function	Returns the link generator.
LinkGeneratorTrait::l	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator	public	function	Sets the link generator service.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.
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.
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::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RegionalForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
RegionalForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
RegionalForm::__construct	public	function	Constructs a RegionalForm object. Overrides ConfigFormBase::__construct
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	protected	function	Returns the URL generator service.
UrlGeneratorTrait::redirect	protected	function	Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator	public	function	Sets the URL generator service.
UrlGeneratorTrait::url	protected	function	Generates a URL or path for a specific route based on the given parameters.