class LocaleSettingsForm

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

Configure locale settings for this site.

@internal

Hierarchy

Expanded class hierarchy of LocaleSettingsForm

1 string reference to 'LocaleSettingsForm'
locale.routing.yml in core/modules/locale/locale.routing.yml
core/modules/locale/locale.routing.yml

File

core/modules/locale/src/Form/LocaleSettingsForm.php, line 14

Namespace

Drupal\locale\Form
View source
class LocaleSettingsForm extends ConfigFormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'locale_translate_settings';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'locale.settings',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $config = $this->config('locale.settings');
        $form['update_interval_days'] = [
            '#type' => 'radios',
            '#title' => $this->t('Check for updates'),
            '#default_value' => $config->get('translation.update_interval_days'),
            '#options' => [
                '0' => $this->t('Never (manually)'),
                '7' => $this->t('Weekly'),
                '30' => $this->t('Monthly'),
            ],
            '#description' => $this->t('Select how frequently you want to check for new interface translations for your currently installed modules and themes. <a href=":url">Check updates now</a>.', [
                ':url' => Url::fromRoute('locale.check_translation')->toString(),
            ]),
        ];
        if ($directory = $config->get('translation.path')) {
            $description = $this->t('Translation files are stored locally in the  %path directory. You can change this directory on the <a href=":url">File system</a> configuration page.', [
                '%path' => $directory,
                ':url' => Url::fromRoute('system.file_system_settings')->toString(),
            ]);
        }
        else {
            $description = $this->t('Translation files will not be stored locally. Change the Interface translation directory on the <a href=":url">File system configuration</a> page.', [
                ':url' => Url::fromRoute('system.file_system_settings')->toString(),
            ]);
        }
        $form['#translation_directory'] = $directory;
        $form['use_source'] = [
            '#type' => 'radios',
            '#title' => $this->t('Translation source'),
            '#default_value' => $config->get('translation.use_source'),
            '#options' => [
                LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL => $this->t('Drupal translation server and local files'),
                LOCALE_TRANSLATION_USE_SOURCE_LOCAL => $this->t('Local files only'),
            ],
            '#description' => $this->t('The source of translation files for automatic interface translation.') . ' ' . $description,
        ];
        if ($config->get('translation.overwrite_not_customized') == FALSE) {
            $default = LOCALE_TRANSLATION_OVERWRITE_NONE;
        }
        elseif ($config->get('translation.overwrite_customized') == TRUE) {
            $default = LOCALE_TRANSLATION_OVERWRITE_ALL;
        }
        else {
            $default = LOCALE_TRANSLATION_OVERWRITE_NON_CUSTOMIZED;
        }
        $form['overwrite'] = [
            '#type' => 'radios',
            '#title' => $this->t('Import behavior'),
            '#default_value' => $default,
            '#options' => [
                LOCALE_TRANSLATION_OVERWRITE_NONE => $this->t("Don't overwrite existing translations."),
                LOCALE_TRANSLATION_OVERWRITE_NON_CUSTOMIZED => $this->t('Only overwrite imported translations, customized translations are kept.'),
                LOCALE_TRANSLATION_OVERWRITE_ALL => $this->t('Overwrite existing translations.'),
            ],
            '#description' => $this->t('How to treat existing translations when automatically updating the interface translations.'),
        ];
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        parent::validateForm($form, $form_state);
        if (empty($form['#translation_directory']) && $form_state->getValue('use_source') == LOCALE_TRANSLATION_USE_SOURCE_LOCAL) {
            $form_state->setErrorByName('use_source', $this->t('You have selected local translation source, but no <a href=":url">Interface translation directory</a> was configured.', [
                ':url' => Url::fromRoute('system.file_system_settings')->toString(),
            ]));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $values = $form_state->getValues();
        $config = $this->config('locale.settings');
        $config->set('translation.update_interval_days', $values['update_interval_days'])
            ->save();
        $config->set('translation.use_source', $values['use_source'])
            ->save();
        switch ($values['overwrite']) {
            case LOCALE_TRANSLATION_OVERWRITE_ALL:
                $config->set('translation.overwrite_customized', TRUE)
                    ->set('translation.overwrite_not_customized', TRUE)
                    ->save();
                break;
            case LOCALE_TRANSLATION_OVERWRITE_NON_CUSTOMIZED:
                $config->set('translation.overwrite_customized', FALSE)
                    ->set('translation.overwrite_not_customized', TRUE)
                    ->save();
                break;
            case LOCALE_TRANSLATION_OVERWRITE_NONE:
                $config->set('translation.overwrite_customized', FALSE)
                    ->set('translation.overwrite_not_customized', FALSE)
                    ->save();
                break;
        }
        // Invalidate the cached translation status when the configuration setting
        // of 'use_source' changes.
        if ($form['use_source']['#default_value'] != $form_state->getValue('use_source')) {
            locale_translation_clear_status();
        }
        parent::submitForm($form, $form_state);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 18
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 16
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
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.
LocaleSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
LocaleSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LocaleSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LocaleSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
LocaleSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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 &#039;destination&#039; 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.