Fixed trait manipulator to avoid duplicate interface calls

Author: Roger Batista

EntityGeneratorBundle/Doctrine/EntityTrait/Adder.php

@@ -15,14 +15,17 @@ class Adder implements CodeGeneratorUnitInterface
     protected $classMetadata;
     protected $visibility;
 
+    protected GetReturnHint $getReturnHint;
+
     public function __construct(
         string $propertyName,
         string $type,
         bool $isNullable,
         $classMetadata,
+        GetReturnHint $getReturnHint,
         array $commentLines = [],
         array $columnOptions = [],
-        string $visibility = 'protected'
+        string $visibility = 'protected',
     ) {
         $this->propertyName = $propertyName;
         $this->type = $type;
@@ -31,6 +34,7 @@ public function __construct(
         $this->columnOptions = $columnOptions;
         $this->classMetadata = $classMetadata;
         $this->visibility = $visibility;
+        $this->getReturnHint = $getReturnHint;
     }
 
     public function toString(string $nlLeftPad = ''): string
@@ -41,7 +45,9 @@ public function toString(string $nlLeftPad = ''): string
         $methodName = 'add' . ucfirst($singularProperty);
 
         $fqdnSegments = explode('\\', $this->classMetadata->name);
-        $returnHint = $fqdnSegments[count($fqdnSegments) -2] . 'Interface';
+        $returnHint = $this->getReturnHint->execute(
+            $fqdnSegments[count($fqdnSegments) -2] . 'Interface'
+        );
 
         $response = [];
         $response[] = sprintf(

EntityGeneratorBundle/Doctrine/EntityTrait/GetReturnHint.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace IvozDevTools\EntityGeneratorBundle\Doctrine\EntityTrait;
+
+class GetReturnHint
+{
+    private array $useStatements;
+
+    public function __construct(
+        array $useStatements
+    )
+    {
+        $this->useStatements = $useStatements;
+    }
+
+    public function execute(string $returnHint): string
+    {
+        $similarInterfaces = false;
+
+        foreach (array_keys($this->useStatements) as $fqdn) {
+            $parts = explode('\\', $fqdn);
+            $lastValue = end($parts);
+
+            if ($lastValue === $returnHint) {
+                $similarInterfaces = true;
+                break;
+            }
+        }
+
+        if ($similarInterfaces) {
+            $returnHint = 'static';
+        }
+
+        return $returnHint;
+    }
+}

EntityGeneratorBundle/Doctrine/EntityTrait/Remover.php

@@ -15,14 +15,19 @@ class Remover implements CodeGeneratorUnitInterface
     protected $classMetadata;
     protected $visibility;
 
+    protected $returnHintCallable;
+    protected GetReturnHint $getReturnHint;
+
     public function __construct(
         string $propertyName,
         string $type,
         bool $isNullable,
         $classMetadata,
+        GetReturnHint $getReturnHint,
         array $commentLines = [],
         array $columnOptions = [],
-        string $visibility = 'protected'
+        string $visibility = 'protected',
+        ?callable $returnHintCallable = null
     ) {
         $this->propertyName = $propertyName;
         $this->type = $type;
@@ -31,6 +36,8 @@ public function __construct(
         $this->columnOptions = $columnOptions;
         $this->classMetadata = $classMetadata;
         $this->visibility = $visibility;
+        $this->returnHintCallable = $returnHintCallable;
+        $this->getReturnHint = $getReturnHint;
     }
 
     public function toString(string $nlLeftPad = ''): string
@@ -40,7 +47,9 @@ public function toString(string $nlLeftPad = ''): string
 
         $methodName = 'remove' . ucfirst($singularProperty);
         $fqdnSegments = explode('\\', $this->classMetadata->name);
-        $returnHint = $fqdnSegments[count($fqdnSegments) -2] . 'Interface';
+        $returnHint = $this->getReturnHint->execute(
+            $fqdnSegments[count($fqdnSegments) -2] . 'Interface'
+        );
 
         $response = [];
         $response[] = sprintf(

EntityGeneratorBundle/Doctrine/EntityTrait/Replacer.php

@@ -15,11 +15,14 @@ class Replacer implements CodeGeneratorUnitInterface
     protected $classMetadata;
     protected $visibility;
 
+    protected GetReturnHint $getReturnHint;
+
     public function __construct(
         string $propertyName,
         string $type,
         bool $isNullable,
         $classMetadata,
+        GetReturnHint $getReturnHint,
         array $commentLines = [],
         array $columnOptions = [],
         string $visibility = 'protected'
@@ -31,6 +34,7 @@ public function __construct(
         $this->columnOptions = $columnOptions;
         $this->classMetadata = $classMetadata;
         $this->visibility = $visibility;
+        $this->getReturnHint = $getReturnHint;
     }
 
     public function toString(string $nlLeftPad = ''): string
@@ -45,7 +49,9 @@ public function toString(string $nlLeftPad = ''): string
 
         $methodName = 'replace' . $camelCaseProperty;
         $fqdnSegments = explode('\\', $this->classMetadata->name);
-        $returnHint = $fqdnSegments[count($fqdnSegments) -2] . 'Interface';
+        $returnHint = $this->getReturnHint->execute(
+            $fqdnSegments[count($fqdnSegments) -2] . 'Interface'
+        );
 
         $response = [];
         $response[] = '/**';

EntityGeneratorBundle/Doctrine/EntityTrait/TraitManipulator.php

@@ -248,11 +248,13 @@ public function addSetter(
         array $columnOptions = [],
         string $visibility = 'protected'
     ) {
+        $getReturnHint = new GetReturnHint($this->useStatements);
         $this->methods[] = new Adder(
             $propertyName,
             $type,
             $isNullable,
             $classMetadata,
+            $getReturnHint,
             $commentLines,
             $columnOptions,
             $visibility
@@ -263,6 +265,7 @@ public function addSetter(
             $type,
             $isNullable,
             $classMetadata,
+            $getReturnHint,
             $commentLines,
             $columnOptions,
             $visibility
@@ -273,6 +276,7 @@ public function addSetter(
             $type,
             $isNullable,
             $classMetadata,
+            $getReturnHint,
             $commentLines,
             $columnOptions,
             $visibility