SessionListener
extends AbstractSessionListener
in package
Sets the session in the request.
Tags
Table of Contents
- $container : mixed
- $sessionUsageStack : mixed
- __construct() : mixed
- getSubscribedEvents() : array<string|int, mixed>
- Returns an array of event names this subscriber wants to listen to.
- onKernelRequest() : mixed
- onKernelResponse() : mixed
- getSession() : SessionInterface|null
- Gets the session object.
Properties
$container
private
mixed
$container
$sessionUsageStack
private
mixed
$sessionUsageStack
= []
Methods
__construct()
public
__construct(ContainerInterface $container) : mixed
Parameters
- $container : ContainerInterface
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']]]
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|int, mixed> —The event names to listen to
onKernelRequest()
public
onKernelRequest(GetResponseEvent $event) : mixed
Parameters
- $event : GetResponseEvent
Return values
mixed —onKernelResponse()
public
onKernelResponse(FilterResponseEvent $event) : mixed
Parameters
- $event : FilterResponseEvent
Return values
mixed —getSession()
Gets the session object.
protected
getSession() : SessionInterface|null
Return values
SessionInterface|null —A SessionInterface instance or null if no session is available