annotate core/lib/Drupal/Core/Site/MaintenanceModeInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Site;
Chris@0 4
Chris@0 5 use Drupal\Core\Routing\RouteMatchInterface;
Chris@0 6 use Drupal\Core\Session\AccountInterface;
Chris@0 7
Chris@0 8 /**
Chris@0 9 * Defines the interface for the maintenance mode service.
Chris@0 10 */
Chris@0 11 interface MaintenanceModeInterface {
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Returns whether the site is in maintenance mode.
Chris@0 15 *
Chris@0 16 * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
Chris@0 17 * The current route match.
Chris@0 18 *
Chris@0 19 * @return bool
Chris@0 20 * TRUE if the site is in maintenance mode.
Chris@0 21 */
Chris@0 22 public function applies(RouteMatchInterface $route_match);
Chris@0 23
Chris@0 24 /**
Chris@0 25 * Determines whether a user has access to the site in maintenance mode.
Chris@0 26 *
Chris@0 27 * @param \Drupal\Core\Session\AccountInterface $account
Chris@0 28 * The logged in user.
Chris@0 29 *
Chris@0 30 * @return bool
Chris@0 31 * TRUE if the user should be exempted from maintenance mode.
Chris@0 32 */
Chris@0 33 public function exempt(AccountInterface $account);
Chris@0 34
Chris@0 35 }