Detect ObjectStorage contents and add it to the field types

Ref: #158

Author: cedricziel

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

@@ -0,0 +1,89 @@
+package com.cedricziel.idea.typo3.extbase.persistence;
+
+import com.intellij.openapi.project.DumbService;
+import com.intellij.openapi.project.Project;
+import com.intellij.psi.PsiElement;
+import com.jetbrains.php.PhpClassHierarchyUtils;
+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.resolve.types.PhpType;
+import com.jetbrains.php.lang.psi.resolve.types.PhpTypeProvider3;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Collection;
+import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class ExtbaseModelCollectionReturnTypeProvider implements PhpTypeProvider3 {
+
+    public static final String TYPO3_CMS_EXTBASE_DOMAIN_OBJECT_ABSTRACT_ENTITY = "TYPO3\\CMS\\Extbase\\DomainObject\\AbstractEntity";
+
+    @Override
+    public char getKey() {
+        return '\u0278';
+    }
+
+    @Nullable
+    @Override
+    public PhpType getType(PsiElement psiElement) {
+        if (DumbService.getInstance(psiElement.getProject()).isDumb()) {
+            return null;
+        }
+
+        if (!(psiElement instanceof Field)) {
+            return null;
+        }
+
+        PhpClass containingClass = ((Field) psiElement).getContainingClass();
+        if (containingClass == null) {
+            return null;
+        }
+
+        Collection<PhpClass> classesByFQN = PhpIndex.getInstance(psiElement.getProject()).getClassesByFQN(TYPO3_CMS_EXTBASE_DOMAIN_OBJECT_ABSTRACT_ENTITY);
+        if (classesByFQN.isEmpty()) {
+            return null;
+        }
+
+        PhpClass abstractEntityClass = classesByFQN.iterator().next();
+
+        if (!PhpClassHierarchyUtils.isSuperClass(abstractEntityClass, containingClass, true)) {
+            return null;
+        }
+
+        PhpDocComment docComment = ((Field) psiElement).getDocComment();
+        if (docComment == null) {
+            return null;
+        }
+
+        PhpDocParamTag varTag = docComment.getVarTag();
+        if (varTag == null) {
+            return null;
+        }
+
+        String text = varTag.getText();
+        if (!text.contains("ObjectStorage<")) {
+            return null;
+        }
+
+        PhpType phpType = new PhpType();
+
+        String pattern = "<(.*?)>";
+        Pattern compiled = Pattern.compile(pattern);
+        Matcher matcher = compiled.matcher(text);
+        while (matcher.find()) {
+            phpType.add(matcher.group(1) + "[]");
+        }
+
+        return phpType;
+    }
+
+    @Override
+    public Collection<? extends PhpNamedElement> getBySignature(String expression, Set<String> visited, int depth, Project project) {
+        return PhpIndex.getInstance(project).getBySignature(expression);
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -143,6 +143,8 @@ It is a great inspiration for possible solutions and parts of the code.</p>
 
         <!-- extbase persistence -->
         <referenceResolver implementation="com.cedricziel.idea.typo3.extbase.persistence.ExtbasePersistenceReferenceResolver"/>
+
+        <typeProvider3 implementation="com.cedricziel.idea.typo3.extbase.persistence.ExtbaseModelCollectionReturnTypeProvider"/>
     </extensions>
 
     <extensions defaultExtensionNs="com.intellij">

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

@@ -0,0 +1,26 @@
+package com.cedricziel.idea.typo3.extbase.persistence;
+
+import com.intellij.psi.PsiElement;
+import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
+import com.jetbrains.php.lang.psi.elements.Field;
+
+import java.util.Set;
+
+public class ExtbaseModelCollectionReturnTypeProviderTest extends LightCodeInsightFixtureTestCase {
+    @Override
+    protected String getTestDataPath() {
+        return "testData/com/cedricziel/idea/typo3/extbase/persistence";
+    }
+
+    public void testResolvesObjectStoragePropertiesToObjectTypes() {
+        myFixture.copyFileToProject("PersistenceMocks.php");
+        myFixture.configureByFile("FieldTypeProvider.php");
+
+        PsiElement elementAtCaret = myFixture.getElementAtCaret();
+
+        assertInstanceOf(elementAtCaret, Field.class);
+
+        Set<String> types = ((Field) elementAtCaret).getInferredType().getTypes();
+        assertTrue(types.contains("\\My\\Extension\\Domain\\Model\\Book[]"));
+    }
+}

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

@@ -0,0 +1,20 @@
+<?php
+
+namespace MyExt {
+
+    class FieldTypeProvider extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
+    {
+        /**
+         * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\My\Extension\Domain\Model\Book>
+         */
+        protected $book;
+
+        public function getBook()
+        {
+            foreach ($this-><caret>book as $b) {
+                $b->getAuthor();
+            }
+        }
+    }
+
+}

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

@@ -6,6 +6,10 @@ class QueryResultInterface {}
     class ObjectStorage {}
 }
 
+namespace TYPO3\CMS\Extbase\DomainObject {
+    class AbstractEntity {}
+}
+
 namespace My\Extension\Domain\Model {
     class Book extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {
         /**