1. class
  2. Symfony
  3. Component
  4. HttpKernel
  5. Event
  6. KernelEvent

KernelEvent

class KernelEvent extends Event

Base class for events thrown in the HttpKernel component.

Methods

bool
isPropagationStopped()

Returns whether further event listeners should be triggered.

from Event
stopPropagation()

Stops the propagation of the event to further event listeners.

from Event
setDispatcher(EventDispatcherInterface $dispatcher) deprecated

Stores the EventDispatcher that dispatches this Event.

from Event
EventDispatcherInterface
getDispatcher() deprecated

Returns the EventDispatcher that dispatches this Event.

from Event
string
getName() deprecated

Gets the event's name.

from Event
setName(string $name) deprecated

Sets the event's name property.

from Event
__construct(HttpKernelInterface $kernel, Request $request, $requestType)

No description

HttpKernelInterface
getKernel()

Returns the kernel in which this event was thrown.

Request
getRequest()

Returns the request the kernel is currently processing.

int
getRequestType()

Returns the request type the kernel is currently processing.

bool
isMasterRequest()

Checks if this is a master request.

Details

in Event at line line 52
bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool Whether propagation was already stopped for this event.

See also

Event::stopPropagation()

in Event at line line 64
stopPropagation()

Stops the propagation of the event to further event listeners.

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().

in Event at line line 76
setDispatcher(EventDispatcherInterface $dispatcher) deprecated

deprecated since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

in Event at line line 88
EventDispatcherInterface getDispatcher() deprecated

deprecated since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Returns the EventDispatcher that dispatches this Event.

Return Value

EventDispatcherInterface

in Event at line line 102
string getName() deprecated

deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.

Gets the event's name.

Return Value

string

in Event at line line 116
setName(string $name) deprecated

deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.

Sets the event's name property.

Parameters

string $name The event name.

at line line 47
__construct(HttpKernelInterface $kernel, Request $request, $requestType)

Parameters

HttpKernelInterface $kernel
Request $request
$requestType

at line line 59
HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

at line line 69
Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

at line line 80
int getRequestType()

Returns the request type the kernel is currently processing.

Return Value

int One of HttpKernelInterface::MASTERREQUEST and HttpKernelInterface::SUBREQUEST

at line line 90
bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request