Detect ObjectStorage contents and add it to the field types on typed getters

Closes: #158

Author: cedricziel

src/main/java/com/cedricziel/idea/typo3/extbase/persistence/ExtbaseModelCollectionReturnTypeProvider.java

@@ -7,9 +7,7 @@
 import com.jetbrains.php.PhpIndex;
 import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment;
 import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocParamTag;
-import com.jetbrains.php.lang.psi.elements.Field;
-import com.jetbrains.php.lang.psi.elements.PhpClass;
-import com.jetbrains.php.lang.psi.elements.PhpNamedElement;
+import com.jetbrains.php.lang.psi.elements.*;
 import com.jetbrains.php.lang.psi.resolve.types.PhpType;
 import com.jetbrains.php.lang.psi.resolve.types.PhpTypeProvider3;
 import org.jetbrains.annotations.Nullable;
@@ -35,27 +33,32 @@ public PhpType getType(PsiElement psiElement) {
             return null;
         }
 
-        if (!(psiElement instanceof Field)) {
+        if (!(psiElement instanceof Field) && !isGetter(psiElement)) {
             return null;
         }
 
-        PhpClass containingClass = ((Field) psiElement).getContainingClass();
-        if (containingClass == null) {
+        if (!isEntityClass(psiElement)) {
             return null;
         }
 
-        Collection<PhpClass> classesByFQN = PhpIndex.getInstance(psiElement.getProject()).getClassesByFQN(TYPO3_CMS_EXTBASE_DOMAIN_OBJECT_ABSTRACT_ENTITY);
-        if (classesByFQN.isEmpty()) {
-            return null;
-        }
+        return extractReturnType(psiElement);
+    }
 
-        PhpClass abstractEntityClass = classesByFQN.iterator().next();
+    private PhpType extractReturnType(PsiElement psiElement) {
+        Field field;
+        if (psiElement instanceof MethodReference) {
+            field = extractFieldFromGetter((MethodReference) psiElement);
+        } else if (psiElement instanceof Method) {
+            field = extractFieldFromGetter((Method) psiElement);
+        } else {
+            field = ((Field) psiElement);
+        }
 
-        if (!PhpClassHierarchyUtils.isSuperClass(abstractEntityClass, containingClass, true)) {
+        if (field == null) {
             return null;
         }
 
-        PhpDocComment docComment = ((Field) psiElement).getDocComment();
+        PhpDocComment docComment = field.getDocComment();
         if (docComment == null) {
             return null;
         }
@@ -82,6 +85,62 @@ public PhpType getType(PsiElement psiElement) {
         return phpType;
     }
 
+    private Field extractFieldFromGetter(MethodReference methodReference) {
+        String substring = methodReference.getName().substring(2);
+        char[] cArr = substring.toCharArray();
+        cArr[0] = Character.toLowerCase(cArr[0]);
+
+        String propertyName = new String(cArr);
+
+        PsiElement method = methodReference.resolve();
+        if (!(method instanceof Method)) {
+            return null;
+        }
+
+        PhpClass containingClass = ((Method) method).getContainingClass();
+
+        if (containingClass == null) {
+            return null;
+        }
+
+        return containingClass.findFieldByName(propertyName, true);
+    }
+
+    private Field extractFieldFromGetter(Method method) {
+        String substring = method.getName().substring(3);
+        char[] cArr = substring.toCharArray();
+        cArr[0] = Character.toLowerCase(cArr[0]);
+
+        String propertyName = new String(cArr);
+
+        PhpClass containingClass = method.getContainingClass();
+
+        if (containingClass == null) {
+            return null;
+        }
+
+        return containingClass.findFieldByName(propertyName, false);
+    }
+
+    private boolean isEntityClass(PsiElement psiElement) {
+        PhpClass containingClass = ((PhpClassMember) psiElement).getContainingClass();
+        if (containingClass == null) {
+            return false;
+        }
+
+        Collection<PhpClass> classesByFQN = PhpIndex.getInstance(psiElement.getProject()).getClassesByFQN(TYPO3_CMS_EXTBASE_DOMAIN_OBJECT_ABSTRACT_ENTITY);
+        if (classesByFQN.isEmpty()) {
+            return false;
+        }
+
+        PhpClass abstractEntityClass = classesByFQN.iterator().next();
+        return PhpClassHierarchyUtils.isSuperClass(abstractEntityClass, containingClass, true);
+    }
+
+    private boolean isGetter(PsiElement psiElement) {
+        return (psiElement instanceof Method) && ((Method) psiElement).getName().startsWith("get");
+    }
+
     @Override
     public Collection<? extends PhpNamedElement> getBySignature(String expression, Set<String> visited, int depth, Project project) {
         return PhpIndex.getInstance(project).getBySignature(expression);

src/test/java/com/cedricziel/idea/typo3/extbase/persistence/ExtbaseModelCollectionReturnTypeProviderTest.java

@@ -3,6 +3,7 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
 import com.jetbrains.php.lang.psi.elements.Field;
+import com.jetbrains.php.lang.psi.elements.Method;
 
 import java.util.Set;
 
@@ -23,4 +24,28 @@ public void testResolvesObjectStoragePropertiesToObjectTypes() {
         Set<String> types = ((Field) elementAtCaret).getInferredType().getTypes();
         assertTrue(types.contains("\\My\\Extension\\Domain\\Model\\Book[]"));
     }
+
+    public void testResolvesObjectStoragePropertiesToObjectTypesOnGetters() {
+        myFixture.copyFileToProject("PersistenceMocks.php");
+        myFixture.configureByFile("MethodTypeProvider.php");
+
+        PsiElement elementAtCaret = myFixture.getElementAtCaret();
+
+        assertInstanceOf(elementAtCaret, Method.class);
+
+        Set<String> types = ((Method) elementAtCaret).getInferredType().getTypes();
+        assertTrue(types.contains("\\My\\Extension\\Domain\\Model\\Book[]"));
+    }
+
+    public void testResolvesObjectStoragePropertiesToObjectTypesOnOutsideCalls() {
+        myFixture.copyFileToProject("PersistenceMocks.php");
+        myFixture.configureByFile("MethodReferenceTypeProvider.php");
+
+        PsiElement elementAtCaret = myFixture.getElementAtCaret();
+
+        assertInstanceOf(elementAtCaret, Method.class);
+
+        Set<String> types = ((Method) elementAtCaret).getType().getTypes();
+        assertTrue(types.contains("\\My\\Extension\\Domain\\Model\\Book[]"));
+    }
 }

testData/com/cedricziel/idea/typo3/extbase/persistence/MethodReferenceTypeProvider.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace MyExt {
+
+    use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
+
+    class MethodReferenceTypeProvider extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
+    {
+        /**
+         * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\My\Extension\Domain\Model\Book>
+         */
+        protected $book;
+
+        public function getBook() : ObjectStorage
+        {
+            return $this->book;
+        }
+    }
+}
+
+namespace Bar {
+
+    use MyExt\MethodReferenceTypeProvider;
+
+    class Foo {
+        public function getFoo()
+        {
+            $methodTypeProvider = new MethodReferenceTypeProvider();
+            $methodTypeProvider->get<caret>Book();
+        }
+    }
+}

testData/com/cedricziel/idea/typo3/extbase/persistence/MethodTypeProvider.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace MyExt {
+
+    use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
+
+    class MethodTypeProvider extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
+    {
+        /**
+         * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\My\Extension\Domain\Model\Book>
+         */
+        protected $book;
+
+        public function getBook() : ObjectStorage
+        {
+            return $this->book;
+        }
+
+        public function foo()
+        {
+            return $this-><caret>getBook();
+        }
+    }
+
+}