Fix #184: Check FormTypeInterface instead of class name suffix

src/FileExtractor/PHPFileExtractor.php

@@ -33,8 +33,10 @@ final class PHPFileExtractor implements FileExtractor
     public function getSourceLocations(SplFileInfo $file, SourceCollection $collection): void
     {
         $path = $file->getRelativePath();
+        /** @phpstan-ignore-next-line */
         $parser = (new ParserFactory())->createForVersion(PhpVersion::fromString('8.1'));
         $traverser = new NodeTraverser();
+        $traverser->addVisitor(new NodeVisitor\NameResolver());
         foreach ($this->visitors as $v) {
             $v->init($collection, $file);
             $traverser->addVisitor($v);

src/Visitor/Php/Knp/Menu/AbstractKnpMenuVisitor.php

@@ -96,7 +96,8 @@ protected function isKnpMenuBuildingMethod(Node $node): bool
             if (!$returnType instanceof Node\Name) {
                 $this->isKnpMenuBuildingMethod = false;
             } else {
-                $this->isKnpMenuBuildingMethod = 'ItemInterface' === $returnType->toString();
+                $this->isKnpMenuBuildingMethod = 'ItemInterface' === $returnType->toString()
+                    || str_ends_with($returnType->toString(), '\\ItemInterface');
             }
         }
 

src/Visitor/Php/Symfony/FormTrait.php

@@ -12,22 +12,117 @@
 namespace Translation\Extractor\Visitor\Php\Symfony;
 
 use PhpParser\Node;
-use PhpParser\Node\Stmt;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitor\NameResolver;
+use PhpParser\ParserFactory;
+use PhpParser\PhpVersion;
 
 trait FormTrait
 {
     private bool $isFormType = false;
+    private array $classMap = [];
+    private string $symfonyInterface = 'FormTypeInterface';
 
-    /**
-     * Check if this node is a form type.
-     */
-    private function isFormType(Node $node): bool
+    protected function isFormType(Node $node): bool
     {
-        // only Traverse *Type
-        if ($node instanceof Stmt\Class_) {
-            $this->isFormType = 'Type' === substr($node->name, -4);
+        if (!$node instanceof Class_) {
+            return $this->isFormType;
+        }
+
+        $allInterfaces = $this->getAllInterfacesFromNode($node);
+
+        foreach ($allInterfaces as $interface) {
+            if ($interface === $this->symfonyInterface
+                || str_ends_with($interface, '\\'.$this->symfonyInterface)) {
+                $this->isFormType = true;
+            }
         }
 
         return $this->isFormType;
     }
+
+    protected function getAllInterfacesFromNode(Class_ $node): array
+    {
+        $interfaces = [];
+
+        foreach ($node->implements as $interface) {
+            $interfaces[] = $interface->toString();
+        }
+
+        if ($node->extends) {
+            $parentFqcn = $node->extends->toString();
+
+            $parentInterfaces = $this->loadParentInterfaces($parentFqcn);
+            $interfaces = array_merge($interfaces, $parentInterfaces);
+        }
+
+        return array_unique($interfaces);
+    }
+
+    protected function loadParentInterfaces(string $parentFqcn): array
+    {
+        $interfaces = [];
+
+        static $loading = [];
+        if (isset($loading[$parentFqcn])) {
+            return [];
+        }
+        $loading[$parentFqcn] = true;
+
+        try {
+            $filePath = $this->findClassFile($parentFqcn);
+
+            if (!$filePath || !file_exists($filePath)) {
+                unset($loading[$parentFqcn]);
+
+                return [];
+            }
+
+            /** @phpstan-ignore-next-line */
+            $parser = (new ParserFactory())->createForVersion(PhpVersion::fromString('8.1'));
+            $code = file_get_contents($filePath);
+            $stmts = $parser->parse($code);
+
+            $traverser = new NodeTraverser();
+            $traverser->addVisitor(new NameResolver());
+            $stmts = $traverser->traverse($stmts);
+
+            foreach ($stmts as $stmt) {
+                if ($stmt instanceof Node\Stmt\Namespace_) {
+                    foreach ($stmt->stmts as $subStmt) {
+                        if ($subStmt instanceof Class_) {
+                            $interfaces = array_merge(
+                                $interfaces,
+                                $this->getAllInterfacesFromNode($subStmt)
+                            );
+                        }
+                    }
+                } elseif ($stmt instanceof Class_) {
+                    $interfaces = array_merge(
+                        $interfaces,
+                        $this->getAllInterfacesFromNode($stmt)
+                    );
+                }
+            }
+        } catch (\Exception $e) {
+        }
+
+        unset($loading[$parentFqcn]);
+
+        return $interfaces;
+    }
+
+    private function findClassFile(string $fqcn): ?string
+    {
+        $autoloadFile = __DIR__.'/../../../../vendor/autoload.php';
+
+        if (!file_exists($autoloadFile)) {
+            return null;
+        }
+
+        $loader = require $autoloadFile;
+
+        return $loader->findFile($fqcn) ?: null;
+    }
 }

tests/Functional/Visitor/Php/Symfony/IsFormTypeTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Translation\Extractor\Tests\Functional\Visitor\Php\Symfony;
+
+use Translation\Extractor\Tests\Functional\Visitor\Php\BasePHPVisitorTest;
+use Translation\Extractor\Tests\Resources;
+use Translation\Extractor\Visitor\Php\Symfony\FormTypeLabelExplicit;
+
+class IsFormTypeTest extends BasePHPVisitorTest
+{
+    public function testParentFormTypeExtractsTranslations(): void
+    {
+        $collection = $this->getSourceLocations(
+            new FormTypeLabelExplicit(),
+            Resources\Php\Symfony\ParentType::class
+        );
+
+        $this->assertCount(1, $collection);
+        $source = $collection->first();
+        $this->assertEquals('parent.field.label', $source->getMessage());
+    }
+
+    public function testInheritedFormTypeIsProperlyDetected(): void
+    {
+        $collection = $this->getSourceLocations(
+            new FormTypeLabelExplicit(),
+            Resources\Php\Symfony\IsFormType::class
+        );
+
+        $this->assertCount(1, $collection);
+        $source = $collection->first();
+        $this->assertEquals('child.field.label', $source->getMessage());
+    }
+
+    public function testNonFormTypeDoesNotExtractTranslations(): void
+    {
+        $collection = $this->getSourceLocations(
+            new FormTypeLabelExplicit(),
+            Resources\Php\Symfony\NotAFormType::class
+        );
+
+        $this->assertCount(0, $collection);
+    }
+}

tests/Resources/Github/Issue_109.php

@@ -3,7 +3,7 @@
 namespace Translation\Extractor\Tests\Resources\Github;
 use Translation\Extractor\Annotation\Ignore;
 
-class MustNotBeIgnoredType
+class MustNotBeIgnoredType implements FormTypeInterface
 {
   public function buildForm(FormBuilderInterface $builder, array $options)
   {

tests/Resources/Github/Issue_111.php

@@ -4,7 +4,7 @@
 
 use Translation\Extractor\Annotation\Ignore;
 
-class Issue111Type
+class Issue111Type implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Github/Issue_62.php

@@ -3,7 +3,7 @@
 use Symfony\Component\Form\AbstractType;
 use Translation\Extractor\Annotation\Ignore;
 
-class EmptyValueType extends AbstractType
+class EmptyValueType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Github/Issue_78.php

@@ -3,7 +3,7 @@
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
 
-class EmptyValueType extends AbstractType
+class EmptyValueType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Github/Issue_80b.php

@@ -2,7 +2,7 @@
 
 use Symfony\Component\Form\AbstractType;
 
-class PlaceholderAsBooleanType extends AbstractType
+class PlaceholderAsBooleanType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Github/issue_82.php

@@ -2,7 +2,7 @@
 
 namespace Translation\Extractor\Tests\Resources\Github;
 
-class GlobalTranslationDomainType
+class GlobalTranslationDomainType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Github/issue_96.php

@@ -2,7 +2,7 @@
 
 namespace Translation\Extractor\Tests\Resources\Github;
 
-class GlobalTranslationDomainWithPlaceholderType
+class GlobalTranslationDomainWithPlaceholderType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/ChainedChoiceType.php

@@ -2,7 +2,7 @@
 
 namespace Translation\Extractor\Tests\Resources\Php\Symfony;
 
-class ChainedChoiceType
+class ChainedChoiceType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/DescriptionType.php

@@ -7,7 +7,7 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Translation\Extractor\Annotation\Desc;
 
-class DescriptionType extends AbstractType
+class DescriptionType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/EmptyValueType.php

@@ -7,7 +7,7 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
-class EmptyValueType extends AbstractType
+class EmptyValueType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/ExplicitLabelFalseType.php

@@ -3,7 +3,7 @@
 use Symfony\Component\Form\AbstractType;
 use Translation\Extractor\Annotation\Ignore;
 
-class ExplicitLabelFalseType extends AbstractType
+class ExplicitLabelFalseType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/ExplicitLabelType.php

@@ -4,7 +4,7 @@
 
 use Translation\Extractor\Annotation\Ignore;
 
-class ExplicitLabelType
+class ExplicitLabelType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/FormDomainChoiceType.php

@@ -2,7 +2,7 @@
 
 namespace Translation\Extractor\Tests\Resources\Php\Symfony;
 
-class FormDomainChoiceType
+class FormDomainChoiceType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
@@ -31,4 +31,4 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             'choice_translation_domain' => false,
         ]);
     }
-}
+}

tests/Resources/Php/Symfony/FormDomainType.php

@@ -2,7 +2,7 @@
 
 namespace Translation\Extractor\Tests\Resources\Php\Symfony;
 
-class FormDomainType
+class FormDomainType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
@@ -29,4 +29,4 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             'translation_domain' => false,
         ]);
     }
-}
+}

tests/Resources/Php/Symfony/FormInvalidMessageType.php

@@ -6,7 +6,7 @@
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\FormBuilderInterface;
 
-class FormInvalidMessageType extends AbstractType
+class FormInvalidMessageType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/HelpFormErrorType.php

@@ -6,7 +6,7 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Translation\Extractor\Annotation\Ignore;
 
-class PlaceholderFormErrorType extends AbstractType
+class PlaceholderFormErrorType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/HelpFormType.php

@@ -5,7 +5,7 @@
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\FormBuilderInterface;
 
-class HelpFormType extends AbstractType
+class HelpFormType implements FormTypeInterface
 {
     public function buildForm(FormBuilderInterface $builder, array $options)
     {

tests/Resources/Php/Symfony/ImplicitLabelType.php

@@ -2,7 +2,7 @@
 
 namespace Translation\Extractor\Tests\Resources\Php\Symfony;
 
-class ImplicitLabelType
+class ImplicitLabelType implements FormTypeInterface
 {
     const ISSUE_131 = 'issue_131';
 

tests/Resources/Php/Symfony/IsFormType.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Translation\Extractor\Tests\Resources\Php\Symfony;
+
+use Symfony\Component\Form\FormBuilderInterface;
+
+class IsFormType extends ParentType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        parent::buildForm($builder, $options);
+
+        $builder->add('child_field', null, [
+            'label' => 'child.field.label'
+        ]);
+    }
+}