1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. EventSubscriber
  7. \
  8. MaintenanceModeSubscriber

MaintenanceModeSubscriber

class MaintenanceModeSubscriber implements EventSubscriberInterface (View source)

Maintenance mode subscriber for controller requests.

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected MaintenanceModeInterface $maintenanceMode

The maintenance mode.
protected AccountInterface $account

The current account.
protected ConfigFactoryInterface $config

The config factory.
protected UrlGeneratorInterface $urlGenerator

The url generator.
protected BareHtmlPageRendererInterface $bareHtmlPageRenderer

The bare HTML page renderer.
protected MessengerInterface $messenger

The messenger.
protected EventDispatcherInterface $eventDispatcher

An event dispatcher instance to use for configuration events.

Methods

TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__construct(MaintenanceModeInterface $maintenance_mode, ConfigFactoryInterface $config_factory, TranslationInterface $translation, UrlGeneratorInterface $url_generator, AccountInterface $account, BareHtmlPageRendererInterface $bare_html_page_renderer, MessengerInterface $messenger, EventDispatcherInterface $event_dispatcher = NULL)

Constructs a new MaintenanceModeSubscriber.

onKernelRequestMaintenance(RequestEvent $event)

Returns the site maintenance page if the site is offline.

onMaintenanceModeRequest(RequestEvent $event)

Returns response when site is in maintenance mode and user is not exempt.

static 
getSubscribedEvents()

{@inheritdoc}

Details

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 97
__construct(MaintenanceModeInterface $maintenance_mode, ConfigFactoryInterface $config_factory, TranslationInterface $translation, UrlGeneratorInterface $url_generator, AccountInterface $account, BareHtmlPageRendererInterface $bare_html_page_renderer, MessengerInterface $messenger, EventDispatcherInterface $event_dispatcher = NULL)

Constructs a new MaintenanceModeSubscriber.

Parameters

MaintenanceModeInterface $maintenance_mode

The maintenance mode.
ConfigFactoryInterface $config_factory

The config factory.
TranslationInterface $translation

The string translation.
UrlGeneratorInterface $url_generator

The url generator.
AccountInterface $account

The current user.
BareHtmlPageRendererInterface $bare_html_page_renderer

The bare HTML page renderer.
MessengerInterface $messenger

The messenger.
EventDispatcherInterface $event_dispatcher

The event dispatcher.

at line 118
onKernelRequestMaintenance(RequestEvent $event)

Returns the site maintenance page if the site is offline.

Parameters

RequestEvent $event

The event to process.

at line 151
onMaintenanceModeRequest(RequestEvent $event)

Returns response when site is in maintenance mode and user is not exempt.

Parameters

RequestEvent $event

The event to process.

at line 169
static getSubscribedEvents()

{@inheritdoc}