Documentation

EventSubscriberInterface

An EventSubscriber knows itself what events it is interested in.

If an EventSubscriber is added to an EventDispatcherInterface, the manager invokes and registers the subscriber as a listener for all returned events.

Tags
author

Guilherme Blanco guilhermeblanco@hotmail.com

author

Jonathan Wage jonwage@gmail.com

author

Roman Borschel roman@code-factory.org

author

Bernhard Schussek bschussek@gmail.com

Table of Contents

Methods

getSubscribedEvents()  : array<string, mixed>
Returns an array of event names this subscriber wants to listen to.

Methods

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


        
On this page

Search results