fix #2669 ContainerBag get method autocomplete and warning

Haehnchen · Haehnchen · commit df9848af5d3b · 2026-06-18T19:13:27.000+02:00
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/codeInspection/service/ServiceDeprecatedClassesInspection.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/codeInspection/service/ServiceDeprecatedClassesInspection.java
@@ -189,7 +189,7 @@ private void visitPhpElement(@NotNull StringLiteralExpression psiElement, @NotNu
                 }
 
                 MethodReference methodReference = PsiElementUtils.getMethodReferenceWithFirstStringParameter(psiElement);
-                if (methodReference == null || !PhpElementsUtil.isMethodReferenceInstanceOf(methodReference, ServiceContainerUtil.SERVICE_GET_SIGNATURES)) {
+                if (methodReference == null || !ServiceContainerUtil.isServiceGetMethod(methodReference)) {
                     return;
                 }
 
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/SymfonyPhpReferenceContributor.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/SymfonyPhpReferenceContributor.java
@@ -7,6 +7,7 @@
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
 import fr.adrienbrault.idea.symfony2plugin.dic.ConstraintPropertyReference;
 import fr.adrienbrault.idea.symfony2plugin.dic.ServiceReference;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
 import fr.adrienbrault.idea.symfony2plugin.doctrine.EntityHelper;
 import fr.adrienbrault.idea.symfony2plugin.doctrine.EntityReference;
 import fr.adrienbrault.idea.symfony2plugin.doctrine.dict.DoctrineTypes;
@@ -39,9 +40,6 @@ public class SymfonyPhpReferenceContributor extends PsiReferenceContributor {
         new MethodMatcher.CallToSignature("\\Symfony\\Component\\DependencyInjection\\ContainerInterface", "has"),
         new MethodMatcher.CallToSignature("\\Psr\\Container\\ContainerInterface", "get"),
         new MethodMatcher.CallToSignature("\\Psr\\Container\\ContainerInterface", "has"),
-
-        new MethodMatcher.CallToSignature("Symfony\\Component\\DependencyInjection\\ParameterBag\\ContainerBagInterface", "get"),
-        new MethodMatcher.CallToSignature("Symfony\\Component\\DependencyInjection\\ParameterBag\\ContainerBagInterface", "has"),
     };
 
     public static final MethodMatcher.CallToSignature[] REPOSITORY_SIGNATURES = new MethodMatcher.CallToSignature[] {
@@ -117,7 +115,8 @@ public void registerReferenceProviders(PsiReferenceRegistrar psiReferenceRegistr
                 @Override
                 public PsiReference @NotNull [] getReferencesByElement(@NotNull PsiElement psiElement, @NotNull ProcessingContext processingContext) {
 
-                    if (MethodMatcher.getMatchedSignatureWithDepth(psiElement, CONTAINER_SIGNATURES) == null) {
+                    MethodMatcher.MethodMatchParameter methodMatchParameter = MethodMatcher.getMatchedSignatureWithDepth(psiElement, CONTAINER_SIGNATURES);
+                    if (methodMatchParameter == null || ServiceContainerUtil.isContainerBagParameterAccess(methodMatchParameter.getMethodReference())) {
                         return new PsiReference[0];
                     }
 
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/php/PhpConfigReferenceContributor.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/php/PhpConfigReferenceContributor.java
@@ -14,7 +14,9 @@
 import fr.adrienbrault.idea.symfony2plugin.dic.AbstractServiceReference;
 import fr.adrienbrault.idea.symfony2plugin.dic.ServiceReference;
 import fr.adrienbrault.idea.symfony2plugin.dic.TagReference;
+import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
 import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
+import fr.adrienbrault.idea.symfony2plugin.util.MethodMatcher;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpStringLiteralExpressionReference;
 import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
@@ -29,22 +31,45 @@
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
 public class PhpConfigReferenceContributor extends PsiReferenceContributor {
+    private static final MethodMatcher.CallToSignature[] SERVICE_HAS_SIGNATURES = new MethodMatcher.CallToSignature[] {
+        new MethodMatcher.CallToSignature("\\Symfony\\Component\\DependencyInjection\\ContainerInterface", "has"),
+        new MethodMatcher.CallToSignature("\\Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller", "has"),
+        new MethodMatcher.CallToSignature("\\Psr\\Container\\ContainerInterface", "has"),
+
+        // Symfony 3.3 / 3.4
+        new MethodMatcher.CallToSignature("\\Symfony\\Bundle\\FrameworkBundle\\Controller\\ControllerTrait", "has"),
+
+        // Symfony 4
+        new MethodMatcher.CallToSignature("\\Symfony\\Bundle\\FrameworkBundle\\Controller\\AbstractController", "has"),
+    };
 
     @Override
     public void registerReferenceProviders(@NotNull PsiReferenceRegistrar psiReferenceRegistrar) {
-        psiReferenceRegistrar.registerReferenceProvider(PhpElementsUtil.getMethodWithFirstStringOrNamedArgumentPattern(), new PhpStringLiteralExpressionReference(ServiceReference.class)
-            .addCall("\\Symfony\\Component\\DependencyInjection\\ContainerInterface", "has")
-            .addCall("\\Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller", "has")
-            .addCall("\\Psr\\Container\\ContainerInterface", "has")
+        psiReferenceRegistrar.registerReferenceProvider(PhpElementsUtil.getMethodWithFirstStringOrNamedArgumentPattern(), new PsiReferenceProvider() {
+            @NotNull
+            @Override
+            public PsiReference @NotNull [] getReferencesByElement(@NotNull PsiElement psiElement, @NotNull ProcessingContext processingContext) {
+                if (!Symfony2ProjectComponent.isEnabled(psiElement) || !(psiElement instanceof StringLiteralExpression stringLiteralExpression) || !(psiElement.getContext() instanceof ParameterList parameterList)) {
+                    return new PsiReference[0];
+                }
 
-            // Symfony 3.3 / 3.4
-            .addCall("\\Symfony\\Bundle\\FrameworkBundle\\Controller\\ControllerTrait", "has")
+                PsiElement method = parameterList.getContext();
+                if (!(method instanceof MethodReference methodReference) || PsiElementUtils.getParameterIndexValue(psiElement) != 0) {
+                    return new PsiReference[0];
+                }
 
-            // Symfony 4
-            .addCall("\\Symfony\\Bundle\\FrameworkBundle\\Controller\\AbstractController", "has")
+                if (ServiceContainerUtil.isContainerBagParameterAccess(methodReference) || !PhpElementsUtil.isMethodReferenceInstanceOf(methodReference, SERVICE_HAS_SIGNATURES)) {
+                    return new PsiReference[0];
+                }
 
-            .addCall("\\Symfony\\Component\\DependencyInjection\\ParameterBag\\ContainerBagInterface", "has")
-        );
+                return new PsiReference[]{ new ServiceReference(stringLiteralExpression) };
+            }
+
+            @Override
+            public boolean acceptsTarget(@NotNull PsiElement target) {
+                return Symfony2ProjectComponent.isEnabled(target);
+            }
+        });
 
         psiReferenceRegistrar.registerReferenceProvider(PhpElementsUtil.getMethodWithFirstStringOrNamedArgumentPattern(), new PhpStringLiteralExpressionReference(ServiceIndexedReference.class)
             .addCall("\\Symfony\\Component\\DependencyInjection\\ContainerBuilder", "hasDefinition")
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/SymfonyContainerTypeProvider.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/SymfonyContainerTypeProvider.java
@@ -50,6 +50,10 @@ public PhpType getType(PsiElement e) {
             return null;
         }
 
+        if (!ServiceContainerUtil.isServiceGetMethod(methodReference)) {
+            return null;
+        }
+
         String signature = PhpTypeProviderUtil.getReferenceSignatureByFirstParameter(methodReference, TRIM_KEY);
         return signature == null ? null : new PhpType().add("#" + this.getKey() + signature);
     }
@@ -78,7 +82,7 @@ public Collection<? extends PhpNamedElement> getBySignature(String expression, S
         }
 
         // finally search the classes
-        if (PhpElementsUtil.isMethodInstanceOf((Method) phpNamedElement, ServiceContainerUtil.SERVICE_GET_SIGNATURES)) {
+        if (ServiceContainerUtil.isServiceGetMethod((Method) phpNamedElement)) {
             ContainerService containerService = ContainerCollectionResolver.getService(project, parameter);
 
             if (containerService != null) {
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/util/ServiceContainerUtil.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/util/ServiceContainerUtil.java
@@ -61,6 +61,7 @@
  */
 public class ServiceContainerUtil {
     private static final Key<CachedValue<Map<String, Collection<PhpClassResourceCandidate>>>> PHP_CLASS_FQN_RESOURCE_CACHE = new Key<>("SYMFONY_PHP_CLASS_FQN_RESOURCE_CACHE");
+    public static final String CONTAINER_BAG_INTERFACE = "\\Symfony\\Component\\DependencyInjection\\ParameterBag\\ContainerBagInterface";
     public static final MethodMatcher.CallToSignature[] SERVICE_GET_SIGNATURES = new MethodMatcher.CallToSignature[] {
         new MethodMatcher.CallToSignature("\\Symfony\\Component\\DependencyInjection\\ContainerInterface", "get"),
         new MethodMatcher.CallToSignature("\\Psr\\Container\\ContainerInterface", "get"),
@@ -71,8 +72,6 @@ public class ServiceContainerUtil {
 
         // Symfony 4
         new MethodMatcher.CallToSignature("\\Symfony\\Bundle\\FrameworkBundle\\Controller\\AbstractController", "get"),
-
-        new MethodMatcher.CallToSignature("\\Symfony\\Component\\DependencyInjection\\ParameterBag\\ContainerBagInterface", "get"),
     };
 
     private static final Key<CachedValue<Collection<String>>> SYMFONY_CONTAINER_FILES = new Key<>("SYMFONY_CONTAINER_FILES");
@@ -94,6 +93,29 @@ public class ServiceContainerUtil {
     public static final String CONTAINER_CONFIGURATOR = "\\Symfony\\Component\\DependencyInjection\\Loader\\Configurator\\ContainerConfigurator";
     public static final String CONTAINER_CONFIG_APP = "\\Symfony\\Component\\DependencyInjection\\Loader\\Configurator\\App";
 
+    public static boolean isServiceGetMethod(@NotNull MethodReference methodReference) {
+        if (isContainerBagParameterAccess(methodReference)) {
+            return false;
+        }
+
+        return PhpElementsUtil.isMethodReferenceInstanceOf(methodReference, SERVICE_GET_SIGNATURES);
+    }
+
+    public static boolean isServiceGetMethod(@NotNull Method method) {
+        return PhpElementsUtil.isMethodInstanceOf(method, SERVICE_GET_SIGNATURES);
+    }
+
+    public static boolean isContainerBagParameterAccess(@NotNull MethodReference methodReference) {
+        String methodName = methodReference.getName();
+        if (!"get".equals(methodName) && !"has".equals(methodName)) {
+            return false;
+        }
+
+        PhpExpression receiver = methodReference.getClassReference();
+        return receiver != null && receiver.getType().getTypes().stream()
+            .anyMatch(fqn -> PhpElementsUtil.isInstanceOf(methodReference.getProject(), fqn, CONTAINER_BAG_INTERFACE));
+    }
+
     @NotNull
     public static Collection<ServiceSerializable> getServicesInFile(@NotNull PsiFile psiFile) {
         final Collection<ServiceSerializable> services = new ArrayList<>();
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/inspection/MissingServiceInspection.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/inspection/MissingServiceInspection.java
@@ -51,7 +51,7 @@ public void visitElement(@NotNull PsiElement element) {
                 if(element.getLanguage() == PhpLanguage.INSTANCE && element instanceof StringLiteralExpression) {
                     // PHP
                     MethodReference methodReference = PsiElementUtils.getMethodReferenceWithFirstStringParameter((StringLiteralExpression) element);
-                    if (methodReference != null && PhpElementsUtil.isMethodReferenceInstanceOf(methodReference, ServiceContainerUtil.SERVICE_GET_SIGNATURES)) {
+                    if (methodReference != null && ServiceContainerUtil.isServiceGetMethod(methodReference)) {
                         String serviceName = PhpElementsUtil.getFirstArgumentStringValue(methodReference);
                         if (StringUtils.isNotBlank(serviceName) && !hasService(serviceName)) {
                             holder.registerProblem(element, INSPECTION_MESSAGE, ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/registrar/DicGotoCompletionRegistrar.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/registrar/DicGotoCompletionRegistrar.java
@@ -20,6 +20,7 @@
 import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
 import fr.adrienbrault.idea.symfony2plugin.util.MethodMatcher;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import fr.adrienbrault.idea.symfony2plugin.util.completion.TagNameCompletionProvider;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
 import org.apache.commons.lang3.StringUtils;
@@ -56,6 +57,13 @@ public void register(@NotNull GotoCompletionRegistrarParameter registrar) {
                     .match();
 
                 if(methodMatchParameter == null) {
+                    MethodReference methodReference = PsiElementUtils.getMethodReferenceWithFirstStringParameter((StringLiteralExpression) context);
+                    if (methodReference == null || !ServiceContainerUtil.isContainerBagParameterAccess(methodReference)) {
+                        return null;
+                    }
+                }
+
+                if(methodMatchParameter == null && PsiElementUtils.getParameterIndexValue(context) != 0) {
                     return null;
                 }
 
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/inspection/MissingServiceInspectionTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/inspection/MissingServiceInspectionTest.java
@@ -32,6 +32,23 @@ public void testThatPhpServiceInterfaceForGetMethodIsInspected() {
         );
     }
 
+    public void testThatContainerBagGetMethodIsNotInspectedAsService() {
+        assertLocalInspectionNotContains("test.php", "<?php\n" +
+                "use Symfony\\Component\\DependencyInjection\\ParameterBag\\ContainerBagInterface;\n" +
+                "\n" +
+                "class TestService\n" +
+                "{\n" +
+                "    public function __construct(private ContainerBagInterface $containerBag) {}\n" +
+                "\n" +
+                "    public function testFoo()\n" +
+                "    {\n" +
+                "        $this->containerBag->get('app.to<caret>ken');\n" +
+                "    }\n" +
+                "}",
+            MissingServiceInspection.INSPECTION_MESSAGE
+        );
+    }
+
     public void testThatPhpAttributesForServiceAutowireIsInspected() {
         assertLocalInspectionContains("test.php", "<?php\n" +
                 "use Symfony\\Component\\DependencyInjection\\Attribute\\Autowire;\n" +
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/inspection/fixtures/classes.php b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/inspection/fixtures/classes.php
@@ -8,6 +8,23 @@ public function get();
     };
 }
 
+namespace Psr\Container
+{
+    interface ContainerInterface
+    {
+        public function get(string $id);
+        public function has(string $id);
+    }
+}
+
+namespace Symfony\Component\DependencyInjection\ParameterBag
+{
+    interface ContainerBagInterface extends \Psr\Container\ContainerInterface
+    {
+        public function all();
+    }
+}
+
 namespace Foobar
 {
     class Car
@@ -27,4 +44,4 @@ public function __construct($foobar)
 {
     class Autowire {}
     class AsDecorator {}
-}
+}
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/registrar/DicGotoCompletionRegistrarTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/registrar/DicGotoCompletionRegistrarTest.java
@@ -36,6 +36,30 @@ public void testParameterContributor() {
         }
     }
 
+    public void testParameterContributorForParameterBagInterfaces() {
+        for (String className : new String[]{"ParameterBagInterface", "ContainerBagInterface"}) {
+            for (String methodName : new String[]{"get", "has"}) {
+                String php = "<?php\n" +
+                    "use Symfony\\Component\\DependencyInjection\\ParameterBag\\" + className + ";\n" +
+                    "\n" +
+                    "class TestService\n" +
+                    "{\n" +
+                    "    public function __construct(private " + className + " $bag) {}\n" +
+                    "\n" +
+                    "    public function testFoo()\n" +
+                    "    {\n" +
+                    "        $this->bag->" + methodName + "('<caret>');\n" +
+                    "    }\n" +
+                    "}\n";
+
+                assertCompletionContains(PhpFileType.INSTANCE, php, "app.token");
+                assertCompletionNotContains(PhpFileType.INSTANCE, php, "foo_bar_service");
+
+                assertNavigationMatch(PhpFileType.INSTANCE, php.replace("<caret>", "app.to<caret>ken"), PlatformPatterns.psiElement());
+            }
+        }
+    }
+
     public void testParameterContributorProxied() {
         for (String s : new String[]{"foo", "bar"}) {
             assertCompletionContains(PhpFileType.INSTANCE, "<?php\n" +
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/registrar/fixtures/classes.php b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/registrar/fixtures/classes.php
@@ -9,6 +9,30 @@ function hasParameter($parameter);
     }
 }
 
+namespace Psr\Container
+{
+    interface ContainerInterface
+    {
+        public function get(string $id);
+        public function has(string $id);
+    }
+}
+
+namespace Symfony\Component\DependencyInjection\ParameterBag
+{
+    interface ParameterBagInterface
+    {
+        public function get(string $name);
+        public function set(string $name, $value);
+        public function has(string $name);
+    }
+
+    interface ContainerBagInterface extends \Psr\Container\ContainerInterface
+    {
+        public function all();
+    }
+}
+
 namespace Symfony\Component\DependencyInjection\Attribute
 {
     class Autowire
@@ -145,4 +169,3 @@ public static function staticMethod() {
         }
     }
 }
-
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/registrar/fixtures/services.yml b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/registrar/fixtures/services.yml
@@ -1,5 +1,6 @@
 parameters:
   foo: foo
+  app.token: '%env(APP_TOKEN)%'
 
 services:
   Foo\Bar:

Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ private void visitPhpElement(@NotNull StringLiteralExpression psiElement, @NotNu`
`189`	`189`	`}`
`190`	`190`
`191`	`191`	`MethodReference methodReference = PsiElementUtils.getMethodReferenceWithFirstStringParameter(psiElement);`
`192`		`- if (methodReference == null \|\| !PhpElementsUtil.isMethodReferenceInstanceOf(methodReference, ServiceContainerUtil.SERVICE_GET_SIGNATURES)) {`
	`192`	`+ if (methodReference == null \|\| !ServiceContainerUtil.isServiceGetMethod(methodReference)) {`
`193`	`193`	`return;`
`194`	`194`	`}`
`195`	`195`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ public PhpType getType(PsiElement e) {`
`50`	`50`	`return null;`
`51`	`51`	`}`
`52`	`52`
	`53`	`+ if (!ServiceContainerUtil.isServiceGetMethod(methodReference)) {`
	`54`	`+ return null;`
	`55`	`+ }`
	`56`	`+`
`53`	`57`	`String signature = PhpTypeProviderUtil.getReferenceSignatureByFirstParameter(methodReference, TRIM_KEY);`
`54`	`58`	`return signature == null ? null : new PhpType().add("#" + this.getKey() + signature);`
`55`	`59`	`}`
`@@ -78,7 +82,7 @@ public Collection<? extends PhpNamedElement> getBySignature(String expression, S`
`78`	`82`	`}`
`79`	`83`
`80`	`84`	`// finally search the classes`
`81`		`- if (PhpElementsUtil.isMethodInstanceOf((Method) phpNamedElement, ServiceContainerUtil.SERVICE_GET_SIGNATURES)) {`
	`85`	`+ if (ServiceContainerUtil.isServiceGetMethod((Method) phpNamedElement)) {`
`82`	`86`	`ContainerService containerService = ContainerCollectionResolver.getService(project, parameter);`
`83`	`87`
`84`	`88`	`if (containerService != null) {`