Documentation

RouteProcessor
in package
implements EventSubscriberInterface, ResetInterface

Adds the current route information to the log entry.

Tags
author

Piotr Stankowski git@trakos.pl

final

Interfaces, Classes and Traits

EventSubscriberInterface
An EventSubscriber knows itself what events it is interested in.
ResetInterface
Provides a way to reset an object to its initial state.

Table of Contents

$includeParams  : mixed
$routeData  : mixed
__construct()  : mixed
__invoke()  : array<string|int, mixed>
addRouteData()  : mixed
getSubscribedEvents()  : array<string, string|array{0: string, 1: int}|list>
Returns an array of event names this subscriber wants to listen to.
removeRouteData()  : mixed
reset()  : mixed

Properties

Methods

__construct()

public __construct([bool $includeParams = true ]) : mixed
Parameters
$includeParams : bool = true
Return values
mixed —

__invoke()

public __invoke(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
$records : array<string|int, mixed>
Return values
array<string|int, mixed> —

getSubscribedEvents()

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

public static getSubscribedEvents() : array<string, string|array{0: string, 1: int}|list>

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, string|array{0: string, 1: int}|list> —

Search results