MaintenanceMode.php
Same filename in other branches
Namespace
Drupal\Core\SiteFile
-
core/
lib/ Drupal/ Core/ Site/ MaintenanceMode.php
View source
<?php
namespace Drupal\Core\Site;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\State\StateInterface;
/**
* Provides the default implementation of the maintenance mode service.
*/
class MaintenanceMode implements MaintenanceModeInterface {
/**
* The state.
*
* @var \Drupal\Core\State\StateInterface
*/
protected $state;
/**
* The configuration factory.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $config;
/**
* Constructs a new maintenance mode service.
*
* @param \Drupal\Core\State\StateInterface $state
* The state.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory.
*/
public function __construct(StateInterface $state, ConfigFactoryInterface $config_factory = NULL) {
$this->state = $state;
if (!$config_factory) {
@trigger_error('Calling MaintenanceMode::__construct() without the $config_factory argument is deprecated in drupal:9.4.0 and the $config_factory argument will be required in drupal:10.0.0. See https://www.drupal.org/node/3255815', E_USER_DEPRECATED);
$config_factory = \Drupal::service('config.factory');
}
$this->config = $config_factory;
}
/**
* {@inheritdoc}
*/
public function applies(RouteMatchInterface $route_match) {
if (!$this->state
->get('system.maintenance_mode')) {
return FALSE;
}
if ($route = $route_match->getRouteObject()) {
if ($route->getOption('_maintenance_access')) {
return FALSE;
}
}
return TRUE;
}
/**
* {@inheritdoc}
*/
public function exempt(AccountInterface $account) {
return $account->hasPermission('access site in maintenance mode');
}
/**
* {@inheritdoc}
*/
public function getSiteMaintenanceMessage() {
return new FormattableMarkup($this->config
->get('system.maintenance')
->get('message'), [
'@site' => $this->config
->get('system.site')
->get('name'),
]);
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
MaintenanceMode | Provides the default implementation of the maintenance mode service. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.