class SiteInformationForm

Same name in other branches
  1. 9 core/modules/system/src/Form/SiteInformationForm.php \Drupal\system\Form\SiteInformationForm
  2. 8.9.x core/modules/system/src/Form/SiteInformationForm.php \Drupal\system\Form\SiteInformationForm
  3. 11.x core/modules/system/src/Form/SiteInformationForm.php \Drupal\system\Form\SiteInformationForm

Configure site information settings for this site.

@internal

Hierarchy

Expanded class hierarchy of SiteInformationForm

1 file declares its use of SiteInformationForm
WorkspaceIntegrationTest.php in core/modules/workspaces/tests/src/Kernel/WorkspaceIntegrationTest.php
1 string reference to 'SiteInformationForm'
system.routing.yml in core/modules/system/system.routing.yml
core/modules/system/system.routing.yml

File

core/modules/system/src/Form/SiteInformationForm.php, line 19

Namespace

Drupal\system\Form
View source
class SiteInformationForm extends ConfigFormBase {
    
    /**
     * The path alias manager.
     *
     * @var \Drupal\path_alias\AliasManagerInterface
     */
    protected $aliasManager;
    
    /**
     * The path validator.
     *
     * @var \Drupal\Core\Path\PathValidatorInterface
     */
    protected $pathValidator;
    
    /**
     * The request context.
     *
     * @var \Drupal\Core\Routing\RequestContext
     */
    protected $requestContext;
    
    /**
     * Constructs a SiteInformationForm 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\path_alias\AliasManagerInterface $alias_manager
     *   The path alias manager.
     * @param \Drupal\Core\Path\PathValidatorInterface $path_validator
     *   The path validator.
     * @param \Drupal\Core\Routing\RequestContext $request_context
     *   The request context.
     */
    public function __construct(ConfigFactoryInterface $config_factory, TypedConfigManagerInterface $typedConfigManager, AliasManagerInterface $alias_manager, PathValidatorInterface $path_validator, RequestContext $request_context) {
        parent::__construct($config_factory, $typedConfigManager);
        $this->aliasManager = $alias_manager;
        $this->pathValidator = $path_validator;
        $this->requestContext = $request_context;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('config.factory'), $container->get('config.typed'), $container->get('path_alias.manager'), $container->get('path.validator'), $container->get('router.request_context'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'system_site_information_settings';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'system.site',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $site_config = $this->config('system.site');
        $site_mail = $site_config->get('mail');
        if (empty($site_mail)) {
            $site_mail = ini_get('sendmail_from');
        }
        $form['site_information'] = [
            '#type' => 'details',
            '#title' => $this->t('Site details'),
            '#open' => TRUE,
        ];
        $form['site_information']['site_name'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Site name'),
            '#default_value' => $site_config->get('name'),
            '#required' => TRUE,
        ];
        $form['site_information']['site_slogan'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Slogan'),
            '#default_value' => $site_config->get('slogan'),
            '#description' => $this->t("How this is used depends on your site's theme."),
            '#maxlength' => 255,
        ];
        $form['site_information']['site_mail'] = [
            '#type' => 'email',
            '#title' => $this->t('Email address'),
            '#default_value' => $site_mail,
            '#description' => $this->t("The <em>From</em> address in automated emails sent during registration and new password requests, and other notifications. (Use an address ending in your site's domain to help prevent this email being flagged as spam.)"),
            '#required' => TRUE,
        ];
        $form['front_page'] = [
            '#type' => 'details',
            '#title' => $this->t('Front page'),
            '#open' => TRUE,
        ];
        $form['front_page']['site_frontpage'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Default front page'),
            '#default_value' => $this->aliasManager
                ->getAliasByPath($site_config->get('page.front')),
            '#required' => TRUE,
            '#size' => 40,
            '#description' => $this->t('Specify a relative URL to display as the front page.'),
            '#field_prefix' => $this->requestContext
                ->getCompleteBaseUrl(),
        ];
        $form['error_page'] = [
            '#type' => 'details',
            '#title' => $this->t('Error pages'),
            '#open' => TRUE,
        ];
        $form['error_page']['site_403'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Default 403 (access denied) page'),
            '#default_value' => $site_config->get('page.403'),
            '#size' => 40,
            '#description' => $this->t('This page is displayed when the requested document is denied to the current user. Leave blank to display a generic "access denied" page.'),
        ];
        $form['error_page']['site_404'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Default 404 (not found) page'),
            '#default_value' => $site_config->get('page.404'),
            '#size' => 40,
            '#description' => $this->t('This page is displayed when no other content matches the requested document. Leave blank to display a generic "page not found" page.'),
        ];
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        // Get the normal path of the front page.
        $form_state->setValueForElement($form['front_page']['site_frontpage'], $this->aliasManager
            ->getPathByAlias($form_state->getValue('site_frontpage')));
        // Validate front page path.
        if (($value = $form_state->getValue('site_frontpage')) && $value[0] !== '/') {
            $form_state->setErrorByName('site_frontpage', $this->t("The path '%path' has to start with a slash.", [
                '%path' => $form_state->getValue('site_frontpage'),
            ]));
        }
        if (!$this->pathValidator
            ->isValid($form_state->getValue('site_frontpage'))) {
            $form_state->setErrorByName('site_frontpage', $this->t("Either the path '%path' is invalid or you do not have access to it.", [
                '%path' => $form_state->getValue('site_frontpage'),
            ]));
        }
        // Get the normal paths of both error pages.
        if (!$form_state->isValueEmpty('site_403')) {
            $form_state->setValueForElement($form['error_page']['site_403'], $this->aliasManager
                ->getPathByAlias($form_state->getValue('site_403')));
        }
        if (!$form_state->isValueEmpty('site_404')) {
            $form_state->setValueForElement($form['error_page']['site_404'], $this->aliasManager
                ->getPathByAlias($form_state->getValue('site_404')));
        }
        if (($value = $form_state->getValue('site_403')) && $value[0] !== '/') {
            $form_state->setErrorByName('site_403', $this->t("The path '%path' has to start with a slash.", [
                '%path' => $form_state->getValue('site_403'),
            ]));
        }
        if (($value = $form_state->getValue('site_404')) && $value[0] !== '/') {
            $form_state->setErrorByName('site_404', $this->t("The path '%path' has to start with a slash.", [
                '%path' => $form_state->getValue('site_404'),
            ]));
        }
        // Validate 403 error path.
        if (!$form_state->isValueEmpty('site_403') && !$this->pathValidator
            ->isValid($form_state->getValue('site_403'))) {
            $form_state->setErrorByName('site_403', $this->t("Either the path '%path' is invalid or you do not have access to it.", [
                '%path' => $form_state->getValue('site_403'),
            ]));
        }
        // Validate 404 error path.
        if (!$form_state->isValueEmpty('site_404') && !$this->pathValidator
            ->isValid($form_state->getValue('site_404'))) {
            $form_state->setErrorByName('site_404', $this->t("Either the path '%path' is invalid or you do not have access to it.", [
                '%path' => $form_state->getValue('site_404'),
            ]));
        }
        parent::validateForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->config('system.site')
            ->set('name', $form_state->getValue('site_name'))
            ->set('mail', $form_state->getValue('site_mail'))
            ->set('slogan', $form_state->getValue('site_slogan'))
            ->set('page.front', $form_state->getValue('site_frontpage'))
            ->set('page.403', $form_state->getValue('site_403'))
            ->set('page.404', $form_state->getValue('site_404'))
            ->save();
        parent::submitForm($form, $form_state);
    }

}

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::typedConfigManager protected function Returns the typed config manager service.
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. 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. 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 &#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.
SiteInformationForm::$aliasManager protected property The path alias manager.
SiteInformationForm::$pathValidator protected property The path validator.
SiteInformationForm::$requestContext protected property The request context.
SiteInformationForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SiteInformationForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SiteInformationForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SiteInformationForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SiteInformationForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SiteInformationForm::validateForm public function Form validation handler. Overrides ConfigFormBase::validateForm
SiteInformationForm::__construct public function Constructs a SiteInformationForm 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.