Documentation

LocaleListener
in package
implements EventSubscriberInterface

Initializes the locale based on the current request.

Tags
author

Fabien Potencier fabien@symfony.com

final

Interfaces, Classes and Traits

EventSubscriberInterface
An EventSubscriber knows itself what events it is interested in.

Table of Contents

$defaultLocale  : mixed
$enabledLocales  : mixed
$requestStack  : mixed
$router  : mixed
$useAcceptLanguageHeader  : mixed
__construct()  : mixed
getSubscribedEvents()  : array<string, string|array{0: string, 1: int}|list>
Returns an array of event names this subscriber wants to listen to.
onKernelFinishRequest()  : mixed
onKernelRequest()  : mixed
setDefaultLocale()  : mixed
setLocale()  : mixed
setRouterContext()  : mixed

Properties

Methods

__construct()

public __construct(RequestStack $requestStack[, string $defaultLocale = 'en' ][, RequestContextAwareInterface|null $router = null ][, bool $useAcceptLanguageHeader = false ][, array<string|int, mixed> $enabledLocales = [] ]) : mixed
Parameters
$requestStack : RequestStack
$defaultLocale : string = 'en'
$router : RequestContextAwareInterface|null = null
$useAcceptLanguageHeader : bool = false
$enabledLocales : array<string|int, mixed> = []
Return values
mixed —

getSubscribedEvents()

Returns an array of event names this subscriber wants to listen to.

public static getSubscribedEvents() : array<string, string|array{0: string, 1: int}|list>

The array keys are event names and the value can be:

  • The method name to call (priority defaults to 0)
  • An array composed of the method name to call and the priority
  • An array of arrays composed of the method names to call and respective priorities, or 0 if unset

For instance:

  • ['eventName' => 'methodName']
  • ['eventName' => ['methodName', $priority]]
  • ['eventName' => [['methodName1', $priority], ['methodName2']]]

The code must not depend on runtime state as it will only be called at compile time. All logic depending on runtime state must be put into the individual methods handling the events.

Return values
array<string, string|array{0: string, 1: int}|list> —

Search results