mediatekformation

WebDebugToolbarListener
in package
implements EventSubscriberInterface

WebDebugToolbarListener injects the Web Debug Toolbar.

The onKernelResponse method must be connected to the kernel.response event.

The WDT is only injected on well-formed HTML (with a proper tag). This means that the WDT is never included in sub-requests or ESI requests.

Tags
author

Fabien Potencier fabien@symfony.com

final

since Symfony 4.3

Interfaces, Classes, Traits and Enums

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

Table of Contents

DISABLED  = 1
ENABLED  = 2
$excludedAjaxPaths  : mixed
$interceptRedirects  : mixed
$mode  : mixed
$twig  : mixed
$urlGenerator  : mixed
$cspHandler  : mixed
__construct()  : mixed
getSubscribedEvents()  : array<string, mixed>
Returns an array of event names this subscriber wants to listen to.
isEnabled()  : mixed
onKernelResponse()  : mixed
injectToolbar()  : mixed
Injects the web debug toolbar into the given Response.

Constants

Properties

Methods

__construct()

public __construct(Environment $twig[, bool $interceptRedirects = false ][, int $mode = self::ENABLED ][, UrlGeneratorInterface $urlGenerator = null ][, string $excludedAjaxPaths = '^/bundles|^/_wdt' ][, ContentSecurityPolicyHandler $cspHandler = null ]) : mixed
Parameters
$twig : Environment
$interceptRedirects : bool = false
$mode : int = self::ENABLED
$urlGenerator : UrlGeneratorInterface = null
$excludedAjaxPaths : string = '^/bundles|^/_wdt'
$cspHandler : ContentSecurityPolicyHandler = null
Return values
mixed —

getSubscribedEvents()

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

public static getSubscribedEvents() : array<string, 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, mixed> —

The event names to listen to

injectToolbar()

Injects the web debug toolbar into the given Response.

protected injectToolbar(Response $response, Request $request, array<string|int, mixed> $nonces) : mixed
Parameters
$response : Response
$request : Request
$nonces : array<string|int, mixed>
Return values
mixed —

Search results