RouterListener
in package
implements
EventSubscriberInterface
Initializes the context from the request and sets request attributes based on a matching route.
Tags
Interfaces, Classes, Traits and Enums
- 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|int, mixed>
- 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
$context
private
mixed
$context
$debug
private
mixed
$debug
$logger
private
mixed
$logger
$matcher
private
mixed
$matcher
$projectDir
private
mixed
$projectDir
$requestStack
private
mixed
$requestStack
Methods
__construct()
public
__construct(UrlMatcherInterface|RequestMatcherInterface $matcher, RequestStack $requestStack[, RequestContext|null $context = null ][, LoggerInterface $logger = null ][, string $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
- $projectDir : string = null
- $debug : bool = true
Tags
Return values
mixed —getSubscribedEvents()
Returns an array of event names this subscriber wants to listen to.
public
static getSubscribedEvents() : array<string|int, mixed>
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']]]
Return values
array<string|int, mixed> —The event names to listen to
onKernelException()
public
onKernelException(GetResponseForExceptionEvent $event) : mixed
Parameters
- $event : GetResponseForExceptionEvent
Return values
mixed —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 —onKernelRequest()
public
onKernelRequest(GetResponseEvent $event) : mixed
Parameters
- $event : GetResponseEvent
Return values
mixed —createWelcomeResponse()
private
createWelcomeResponse() : Response
Return values
Response —setCurrentRequest()
private
setCurrentRequest([Request $request = null ]) : mixed
Parameters
- $request : Request = null