Documentation

RouterListener
in package
implements EventSubscriberInterface

Initializes the context from the request and sets request attributes based on a matching route.

Tags
author

Fabien Potencier fabien@symfony.com

author

Yonel Ceruto yonelceruto@gmail.com

final

Interfaces, Classes and Traits

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

Table of Contents

$context  : mixed
$debug  : mixed
$logger  : mixed
$matcher  : mixed
$projectDir  : mixed
$requestStack  : 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.
onKernelException()  : mixed
onKernelFinishRequest()  : mixed
After a sub-request is done, we need to reset the routing context to the parent request so that the URL generator operates on the correct context again.
onKernelRequest()  : mixed
createWelcomeResponse()  : Response
setCurrentRequest()  : mixed

Properties

Methods

__construct()

public __construct(UrlMatcherInterface|RequestMatcherInterface $matcher, RequestStack $requestStack[, RequestContext|null $context = null ][, LoggerInterface|null $logger = null ][, string|null $projectDir = null ][, bool $debug = true ]) : mixed
Parameters
$matcher : UrlMatcherInterface|RequestMatcherInterface

The Url or Request matcher

$requestStack : RequestStack
$context : RequestContext|null = null

The RequestContext (can be null when $matcher implements RequestContextAwareInterface)

$logger : LoggerInterface|null = null
$projectDir : string|null = null
$debug : bool = true
Tags
throws
InvalidArgumentException
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> —

onKernelFinishRequest()

After a sub-request is done, we need to reset the routing context to the parent request so that the URL generator operates on the correct context again.

public onKernelFinishRequest(FinishRequestEvent $event) : mixed
Parameters
$event : FinishRequestEvent
Return values
mixed —

setCurrentRequest()

private setCurrentRequest([Request|null $request = null ]) : mixed
Parameters
$request : Request|null = null
Return values
mixed —

Search results