From 1e4bd68bb63a2cd828d57882fb3ba9f642e4b040 Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Mon, 26 Jul 2021 09:27:07 +0100
Subject: [PATCH] Issue #3018091 by guilhermevp, vacho, shubhangi1995, joachim,
longwave, wolffereast: TaggedHandlersPass::process() doesn't document some of
its features
---
.../Compiler/TaggedHandlersPass.php | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)
diff --git a/core/lib/Drupal/Core/DependencyInjection/Compiler/TaggedHandlersPass.php b/core/lib/Drupal/Core/DependencyInjection/Compiler/TaggedHandlersPass.php
index e00193eacc64..8a79378919ee 100644
--- a/core/lib/Drupal/Core/DependencyInjection/Compiler/TaggedHandlersPass.php
+++ b/core/lib/Drupal/Core/DependencyInjection/Compiler/TaggedHandlersPass.php
@@ -65,11 +65,18 @@ class TaggedHandlersPass implements CompilerPassInterface {
*
* Additional tag attributes supported by 'service_collector' only:
* - call: The method name to call on the consumer service. Defaults to
- * 'addHandler'. The called method receives two arguments:
- * - The handler instance as first argument.
- * - Optionally the handler's priority as second argument, if the method
- * accepts a second parameter and its name is "priority". In any case,
- * all handlers registered at compile time are sorted already.
+ * 'addHandler'. The called method receives at least one argument,
+ * optionally more:
+ * - The handler instance must be the first method parameter, and it must
+ * have a type declaration.
+ * - If the method has a parameter named $id, in any position, it will
+ * receive the value of service ID when called.
+ * - If the method has a parameter named $priority, in any position, it
+ * will receive the value of the tag's 'priority' attribute.
+ * - Any other method parameters whose names match the name of an
+ * attribute of the tag will receive the value of that tag attribute.The
+ * order of the method parameters and the order of the service tag
+ * attributes do not need to match.
*
* Example (YAML):
* @code
--
GitLab