[EventDispatcher] Add events attribute of the kernel.event_listener tag
#61222
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -66,32 +66,52 @@ public function process(ContainerBuilder $container): void | |
| $noPreload = 0; | ||
|
|
||
| foreach ($events as $event) { | ||
| if (isset($event['event'])) { | ||
| trigger_deprecation('symfony/event-dispatcher', '7.4', 'The "event" attribute of the `kernel.event_listener` tag is deprecated and will be removed in Symfony 8.0. Use "events" attribute instead.'); | ||
| if (isset($event['events'])) { | ||
| throw new InvalidArgumentException('Cannot use both "event" and "events" attributes of the `kernel.event_listener` tag.'); | ||
| } | ||
| $event['events'] = $event['event']; | ||
| } | ||
| $priority = $event['priority'] ?? 0; | ||
|
|
||
| if (!isset($event['events'])) { | ||
| if ($container->getDefinition($id)->hasTag('kernel.event_subscriber')) { | ||
| continue; | ||
| } | ||
|
|
||
| $event['method'] ??= '__invoke'; | ||
| $event['events'] = $this->getEventFromTypeDeclaration($container, $id, $event['method']); | ||
| } | ||
| $event['events'] = array_map(fn (string $event) => $aliases[$event] ?? $event, (array) $event['events']); | ||
|
|
||
| if (!isset($event['method'])) { | ||
| $class = $container->getDefinition($id)->getClass(); | ||
| $reflectionClass = null !== $class ? $container->getReflectionClass($class, false) : null; | ||
| foreach ($event['events'] as $eventName) { | ||
| $methodName = 'on'.preg_replace_callback([ | ||
| '/(?<=\b|_)[a-z]/i', | ||
| '/[^a-z0-9]/i', | ||
| ], fn ($matches) => strtoupper($matches[0]), $eventName); | ||
| $methodName = preg_replace('/[^a-z0-9]/i', '', $methodName); | ||
|
|
||
| if ($reflectionClass) { | ||
| if ($reflectionClass->hasMethod($methodName)) { | ||
| $event['method'] = $methodName; | ||
| break; | ||
| } | ||
| if ($reflectionClass->hasMethod('__invoke')) { | ||
| $event['method'] = '__invoke'; | ||
| break; | ||
| } | ||
| } else { | ||
| $event['method'] = $methodName; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if (!isset($event['method'])) { | ||
| throw new InvalidArgumentException(\sprintf('None of the "%s" or "__invoke" methods exist for the service "%s". Please define the "method" attribute on "kernel.event_listener" tags.', $methodName, $id)); | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -100,12 +120,13 @@ public function process(ContainerBuilder $container): void | |
| $dispatcherDefinition = $container->findDefinition($event['dispatcher']); | ||
| } | ||
|
|
||
| foreach ($event['events'] as $eventName) { | ||
| $dispatcherDefinition->addMethodCall('addListener', [$eventName, [new ServiceClosureArgument(new Reference($id)), $event['method']], $priority]); | ||
| if (isset($this->hotPathEvents[$eventName])) { | ||
| $container->getDefinition($id)->addTag('container.hot_path'); | ||
| } elseif (isset($this->noPreloadEvents[$eventName])) { | ||
| ++$noPreload; | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -167,21 +188,43 @@ public function process(ContainerBuilder $container): void | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return string[] | ||
| */ | ||
| private function getEventFromTypeDeclaration(ContainerBuilder $container, string $id, string $method): array | ||
| { | ||
| if ( | ||
| null === ($class = $container->getDefinition($id)->getClass()) | ||
| || !($r = $container->getReflectionClass($class, false)) | ||
| || !$r->hasMethod($method) | ||
| || 1 > ($m = $r->getMethod($method))->getNumberOfParameters() | ||
| ) { | ||
| throw new InvalidArgumentException(\sprintf('Service "%s" must define the "events" attribute on "kernel.event_listener" tags.', $id)); | ||
| } | ||
|
|
||
| $type = $m->getParameters()[0]->getType(); | ||
| if ($type instanceof \ReflectionNamedType) { | ||
| if ($type->isBuiltin() || Event::class === ($name = $type->getName())) { | ||
| throw new InvalidArgumentException(\sprintf('Service "%s" must define the "events" attribute on "kernel.event_listener" tags.', $id)); | ||
| } | ||
|
|
||
| return [$name]; | ||
| } | ||
|
|
||
| if ($type instanceof \ReflectionUnionType) { | ||
| $types = []; | ||
| foreach ($type->getTypes() as $type) { | ||
| if (!$type->isBuiltin()) { | ||
| $types[] = $type->getName(); | ||
| } | ||
| } | ||
|
|
||
| if ($types) { | ||
| return $types; | ||
| } | ||
| } | ||
|
|
||
| throw new InvalidArgumentException(\sprintf('Service "%s" must define the "events" attribute on "kernel.event_listener" tags.', $id)); | ||
| } | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are also two spaces between "tag" and "in".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This deprecation must be reverted.