W3cubDocs

/Symfony 4.1

FragmentListener

class FragmentListener implements EventSubscriberInterface

Handles content fragments represented by special URIs.

All URL paths starting with /_fragment are handled as content fragments by this listener.

If throws an AccessDeniedHttpException exception if the request is not signed or if it is not an internal sub-request.

Methods

__construct(UriSigner $signer, string $fragmentPath = '/_fragment')
onKernelRequest(GetResponseEvent $event)

Fixes request attributes when the path is '/_fragment'.

validateRequest(Request $request)
static array getSubscribedEvents()

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

Details

__construct(UriSigner $signer, string $fragmentPath = '/_fragment')

Parameters

UriSigner $signer A UriSigner instance
string $fragmentPath The path that triggers this listener

onKernelRequest(GetResponseEvent $event)

Fixes request attributes when the path is '/_fragment'.

Parameters

GetResponseEvent $event

Exceptions

AccessDeniedHttpException if the request does not come from a trusted IP

protected validateRequest(Request $request)

Parameters

Request $request

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

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