class SiteMaintenanceModeForm

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

Configure maintenance settings for this site.

@internal

Hierarchy

Expanded class hierarchy of SiteMaintenanceModeForm

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

File

core/modules/system/src/Form/SiteMaintenanceModeForm.php, line 18

Namespace

Drupal\system\Form
View source
class SiteMaintenanceModeForm extends ConfigFormBase {
    
    /**
     * The state keyvalue collection.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected $state;
    
    /**
     * The permission handler.
     *
     * @var \Drupal\user\PermissionHandlerInterface
     */
    protected $permissionHandler;
    
    /**
     * Constructs a new SiteMaintenanceModeForm.
     *
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The factory for configuration objects.
     * @param \Drupal\Core\State\StateInterface $state
     *   The state keyvalue collection to use.
     * @param \Drupal\user\PermissionHandlerInterface $permission_handler
     *   The permission handler.
     */
    public function __construct(ConfigFactoryInterface $config_factory, StateInterface $state, PermissionHandlerInterface $permission_handler) {
        parent::__construct($config_factory);
        $this->state = $state;
        $this->permissionHandler = $permission_handler;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('config.factory'), $container->get('state'), $container->get('user.permissions'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'system_site_maintenance_mode';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'system.maintenance',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $config = $this->config('system.maintenance');
        $permissions = $this->permissionHandler
            ->getPermissions();
        $permission_label = $permissions['access site in maintenance mode']['title'];
        $form['maintenance_mode'] = [
            '#type' => 'checkbox',
            '#title' => t('Put site into maintenance mode'),
            '#default_value' => $this->state
                ->get('system.maintenance_mode'),
            '#description' => t('Visitors will only see the maintenance mode message. Only users with the "@permission-label" <a href=":permissions-url">permission</a> will be able to access the site. Authorized users can log in directly via the <a href=":user-login">user login</a> page.', [
                '@permission-label' => $permission_label,
                ':permissions-url' => Url::fromRoute('user.admin_permissions')->toString(),
                ':user-login' => Url::fromRoute('user.login')->toString(),
            ]),
        ];
        $form['maintenance_mode_message'] = [
            '#type' => 'textarea',
            '#title' => t('Message to display when in maintenance mode'),
            '#default_value' => $config->get('message'),
        ];
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->config('system.maintenance')
            ->set('message', $form_state->getValue('maintenance_mode_message'))
            ->save();
        $this->state
            ->set('system.maintenance_mode', $form_state->getValue('maintenance_mode'));
        parent::submitForm($form, $form_state);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 73
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.
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.
SiteMaintenanceModeForm::$permissionHandler protected property The permission handler.
SiteMaintenanceModeForm::$state protected property The state keyvalue collection.
SiteMaintenanceModeForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SiteMaintenanceModeForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SiteMaintenanceModeForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SiteMaintenanceModeForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SiteMaintenanceModeForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SiteMaintenanceModeForm::__construct public function Constructs a new SiteMaintenanceModeForm. 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 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.