support querybuilder model resolving parent constructor call of ServiceEntityRepository

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/doctrine/querybuilder/QueryBuilderMethodReferenceParser.java

@@ -6,10 +6,7 @@
 import com.intellij.psi.util.PsiTreeUtil;
 import com.jetbrains.php.PhpIndex;
 import com.jetbrains.php.lang.parser.PhpElementTypes;
-import com.jetbrains.php.lang.psi.elements.ArrayCreationExpression;
-import com.jetbrains.php.lang.psi.elements.ClassConstantReference;
-import com.jetbrains.php.lang.psi.elements.MethodReference;
-import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.jetbrains.php.lang.psi.elements.*;
 import fr.adrienbrault.idea.symfony2plugin.doctrine.EntityHelper;
 import fr.adrienbrault.idea.symfony2plugin.doctrine.dict.DoctrineModelField;
 import fr.adrienbrault.idea.symfony2plugin.doctrine.querybuilder.detector.FormQueryBuilderRepositoryDetector;
@@ -61,15 +58,13 @@ public QueryBuilderScopeContext collect() {
         }
 
         for(MethodReference methodReference: methodReferences) {
-
             String name = methodReference.getName();
             if(name != null) {
                 collectParameter(qb, methodReference, name);
                 collectJoins(qb, methodReference, name);
                 collectSelects(qb, methodReference, name);
                 collectSelectInForm(qb, methodReference, name);
             }
-
         }
 
         // first tableMap entry is root, we add several initial data
@@ -184,25 +179,30 @@ private void collectParameter(QueryBuilderScopeContext qb, MethodReference metho
 
     }
 
-
     /**
+     * Extract model from context
      *
-     * @param methodReferences
-     * @return
+     * ```
+     * getRepository('Foo')->createQueryBuilder('test')
+     * ```
+     *
+     * ```
+     * public function __construct(RegistryInterface $registry)
+     * {
+     *  parent::__construct($registry, Entity::class);
+     * }
+     * ```
      */
     @NotNull
     private Map<String, String> findRootDefinition(@NotNull Collection<MethodReference> methodReferences) {
-
-        Map<String, String> roots = new HashMap<>();
-
         if(methodReferences.size() == 0) {
-            return roots;
+            return Collections.emptyMap();
         }
 
+        Map<String, String> roots = new HashMap<>();
         String rootAlias = null;
         String repository = null;
 
-
         for(MethodReference methodReference: methodReferences) {
             String methodReferenceName = methodReference.getName();
 
@@ -259,11 +259,38 @@ private Map<String, String> findRootDefinition(@NotNull Collection<MethodReferen
             roots.put(repository, rootAlias);
         }
 
+        // public function __construct(RegistryInterface $registry)
+        //   parent::__construct($registry, Entity::class);
+        if(rootAlias != null && repository == null) {
+            MethodReference methodReference = methodReferences.iterator().next();
+            PhpClass phpClass = PsiTreeUtil.getParentOfType(methodReference, PhpClass.class);
+
+            if(phpClass != null && PhpElementsUtil.isInstanceOf(phpClass, "\\Doctrine\\Bundle\\DoctrineBundle\\Repository\\ServiceEntityRepository")) {
+                Method constructor = phpClass.getConstructor();
+                if (constructor != null) {
+                    for (MethodReference reference : PsiTreeUtil.findChildrenOfType(constructor, MethodReference.class)) {
+                        if ("__construct".equals(reference.getName())) {
+                            PsiElement[] parameters = reference.getParameters();
+                            if (parameters.length > 1) {
+                                PsiElement parameter = parameters[1];
+                                String stringValue = PhpElementsUtil.getStringValue(parameter);
+                                if (stringValue != null) {
+                                    roots.put(stringValue, rootAlias);
+                                    return roots;
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+
         // we found a alias but not a repository name, so try a scope search if we are inside repository class
         // class implements \Doctrine\Common\Persistence\ObjectRepository, so search for model name of "repositoryClass"
         if(rootAlias != null && repository == null) {
             MethodReference methodReference = methodReferences.iterator().next();
             PhpClass phpClass = PsiTreeUtil.getParentOfType(methodReference, PhpClass.class);
+
             if(
                 phpClass != null &&
                 (
@@ -280,7 +307,6 @@ private Map<String, String> findRootDefinition(@NotNull Collection<MethodReferen
                     }
                 }
             }
-
         }
 
         // search on PhpTypeProvider

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/doctrine/querybuilder/QueryBuilderCompletionContributorTest.java

@@ -0,0 +1,40 @@
+package fr.adrienbrault.idea.symfony2plugin.tests.doctrine.querybuilder;
+
+import fr.adrienbrault.idea.symfony2plugin.doctrine.querybuilder.QueryBuilderCompletionContributor;
+import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+
+/**
+ * @see QueryBuilderCompletionContributor
+ * @author Daniel Espendiller <daniel@espendiller.net>
+ */
+public class QueryBuilderCompletionContributorTest extends SymfonyLightCodeInsightFixtureTestCase {
+    public void setUp() throws Exception {
+        super.setUp();
+        myFixture.copyFileToProject("doctrine.orm.yml");
+        myFixture.copyFileToProject("QueryBuilderCompletionContributor.php");
+    }
+
+    public String getTestDataPath() {
+        return "src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/doctrine/querybuilder/fixtures";
+    }
+
+    public void testServiceEntityRepositoryConstructorModelContextOnQueryBuilderJoin() {
+        assertCompletionContains("test.php", "<?php\n" +
+            "\n" +
+            "use Doctrine\\Bundle\\DoctrineBundle\\Repository\\ServiceEntityRepository;\n" +
+            "\n" +
+            "class Repository extends ServiceEntityRepository\n" +
+            "{\n" +
+            "    public function __construct(RegistryInterface $registry)\n" +
+            "    {\n" +
+            "        parent::__construct($registry, \\App\\Entity::class);\n" +
+            "    }\n" +
+            "\n" +
+            "    public function foobar()\n" +
+            "    {\n" +
+            "        $qb = $this->createQueryBuilder('s');\n" +
+            "        $qb->andWhere('s.<caret>');\n" +
+            "    }\n" +
+            "}", "s.name", "s.id");
+    }
+}

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/doctrine/querybuilder/fixtures/QueryBuilderCompletionContributor.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Doctrine\ORM
+{
+    class QueryBuilder
+    {
+        public function andWhere() {}
+    }
+
+    class EntityRepository
+    {
+        /**
+         * @return QueryBuilder
+         */
+        public function createQueryBuilder($alias, $indexBy = null)
+        {
+        }
+    }
+}
+
+
+namespace Doctrine\Bundle\DoctrineBundle\Repository
+{
+    use Doctrine\ORM\EntityRepository;
+
+    class ServiceEntityRepository extends EntityRepository
+    {
+    }
+}
+
+namespace App
+{
+    class Entity
+    {
+    }
+}

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/doctrine/querybuilder/fixtures/doctrine.orm.yml

@@ -0,0 +1,12 @@
+App\Entity:
+  type: entity
+  table: foo_table
+  id:
+    id:
+      type: integer
+      generator:
+        strategy: AUTO
+  fields:
+    name:
+      type: string
+      length: 50