W3cubDocs

/Symfony 4.1

AbstractSessionListener

abstract class AbstractSessionListener implements EventSubscriberInterface

Sets the session onto the request on the "kernel.request" event and saves it on the "kernel.response" event.

In addition, if the session has been started it overrides the Cache-Control header in such a way that all caching is disabled in that case. If you have a scenario where caching responses with session information in them makes sense, you can disable this behaviour by setting the header AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER on the response.

Constants

NO_AUTO_CACHE_CONTROL_HEADER

Properties

protected $container

Methods

__construct(ContainerInterface $container = null)
onKernelRequest(GetResponseEvent $event)
onKernelResponse(FilterResponseEvent $event)
onFinishRequest(FinishRequestEvent $event)
static array getSubscribedEvents()

Returns an array of event names this subscriber wants to listen to.
SessionInterface|null getSession()

Gets the session object.

Details

__construct(ContainerInterface $container = null)

Parameters

ContainerInterface $container

onKernelRequest(GetResponseEvent $event)

Parameters

GetResponseEvent $event

onKernelResponse(FilterResponseEvent $event)

Parameters

FilterResponseEvent $event

onFinishRequest(FinishRequestEvent $event)

Parameters

FinishRequestEvent $event

static array getSubscribedEvents()

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

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:

  • array('eventName' => 'methodName')
  • array('eventName' => array('methodName', $priority))
  • array('eventName' => array(array('methodName1', $priority), array('methodName2')))

Return Value

array The event names to listen to

abstract protected SessionInterface|null getSession()

Gets the session object.

Return Value

SessionInterface|null A SessionInterface instance or null if no session is available

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/EventListener/AbstractSessionListener.html