class MaintenanceModeSubscriber

Same name in this branch
  1. main core/lib/Drupal/Core/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\Core\EventSubscriber\MaintenanceModeSubscriber
Same name and namespace in other branches
  1. 11.x core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\user\EventSubscriber\MaintenanceModeSubscriber
  2. 11.x core/lib/Drupal/Core/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\Core\EventSubscriber\MaintenanceModeSubscriber
  3. 10 core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\user\EventSubscriber\MaintenanceModeSubscriber
  4. 10 core/lib/Drupal/Core/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\Core\EventSubscriber\MaintenanceModeSubscriber
  5. 9 core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\user\EventSubscriber\MaintenanceModeSubscriber
  6. 9 core/lib/Drupal/Core/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\Core\EventSubscriber\MaintenanceModeSubscriber
  7. 8.9.x core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\user\EventSubscriber\MaintenanceModeSubscriber
  8. 8.9.x core/lib/Drupal/Core/EventSubscriber/MaintenanceModeSubscriber.php \Drupal\Core\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;
  
  /**
   * The logout finalizer closure.
   */
  protected \Closure $logoutFinalizer;
  public function __construct(MaintenanceModeInterface $maintenance_mode, AccountInterface $account, #[AutowireServiceClosure(LogoutFinalizer::class)] ?\Closure $logoutFinalizer = NULL) {
    $this->maintenanceMode = $maintenance_mode;
    $this->account = $account;
    if ($logoutFinalizer === NULL) {
      @trigger_error('Calling ' . __METHOD__ . '() without the $logoutFinalizer argument is deprecated in drupal:11.5.0 and is removed from drupal:12.0.0. See https://www.drupal.org/node/3379194', E_USER_DEPRECATED);
      $logoutFinalizer = fn() => \Drupal::service(LogoutFinalizer::class);
    }
    $this->logoutFinalizer = $logoutFinalizer;
  }
  
  /**
   * 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()) {
      ($this->logoutFinalizer)()
        ->finalizeLogout();
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() : array {
    $events[MaintenanceModeEvents::MAINTENANCE_MODE_REQUEST][] = [
      'onMaintenanceModeRequest',
      -900,
    ];
    return $events;
  }

}

Members

Title Sort descending Modifiers Object type Summary
MaintenanceModeSubscriber::$account protected property The current account.
MaintenanceModeSubscriber::$logoutFinalizer protected property The logout finalizer closure.
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.