Same name in this branch
  1. 10 core/lib/Drupal/Core/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\Core\EventSubscriber\MaintenanceModeSubscriber
  2. 10 core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\user\EventSubscriber\MaintenanceModeSubscriber
Same name and namespace in other branches
  1. 8.9.x core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\user\EventSubscriber\MaintenanceModeSubscriber
  2. 9 core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\user\EventSubscriber\MaintenanceModeSubscriber

Maintenance mode subscriber to log out users.

Hierarchy

  • class \Drupal\user\EventSubscriber\MaintenanceModeSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

Expanded class hierarchy of MaintenanceModeSubscriber

1 string reference to 'MaintenanceModeSubscriber'
user.services.yml in core/modules/user/user.services.yml
core/modules/user/user.services.yml
1 service uses MaintenanceModeSubscriber
user_maintenance_mode_subscriber in core/modules/user/user.services.yml
Drupal\user\EventSubscriber\MaintenanceModeSubscriber

File

core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php, line 16

Namespace

Drupal\user\EventSubscriber
View source 
class MaintenanceModeSubscriber implements EventSubscriberInterface {

  /**
   * The maintenance mode.
   *
   * @var \Drupal\Core\Site\MaintenanceMode
   */
  protected $maintenanceMode;

  /**
   * The current account.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $account;

  /**
   * Constructs a new MaintenanceModeSubscriber.
   *
   * @param \Drupal\Core\Site\MaintenanceModeInterface $maintenance_mode
   *   The maintenance mode.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The current user.
   */
  public function __construct(MaintenanceModeInterface $maintenance_mode, AccountInterface $account) {
    $this->maintenanceMode = $maintenance_mode;
    $this->account = $account;
  }

  /**
   * Logout users if site is in maintenance mode and user is not exempt.
   *
   * @param \Symfony\Component\HttpKernel\Event\RequestEvent $event
   *   The event to process.
   */
  public function onMaintenanceModeRequest(RequestEvent $event) {

    // If the site is offline, log out unprivileged users.
    if ($this->account
      ->isAuthenticated()) {
      user_logout();

      // Redirect to homepage.
      $event
        ->setResponse(new RedirectResponse(Url::fromRoute('<front>')
        ->toString()));
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() : array {
    $events[MaintenanceModeEvents::MAINTENANCE_MODE_REQUEST][] = [
      'onMaintenanceModeRequest',
      -900,
    ];
    return $events;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
MaintenanceModeSubscriber::$account protected property The current account.
MaintenanceModeSubscriber::$maintenanceMode protected property The maintenance mode.
MaintenanceModeSubscriber::getSubscribedEvents public static function
MaintenanceModeSubscriber::onMaintenanceModeRequest public function Logout users if site is in maintenance mode and user is not exempt.
MaintenanceModeSubscriber::__construct public function Constructs a new MaintenanceModeSubscriber.