ResultIterator: Use @method to declare getIterator() return type, fix findBy return type

Author: homersimpsons

src/Utils/BeanDescriptor.php

@@ -1157,23 +1157,11 @@ public function generateResultIteratorPhpCode(): ?FileGenerator
         $class->setName($baseClassName);
         $class->setExtendedClass(ResultIterator::class);
 
-        $class->setDocBlock(new DocBlockGenerator("The $baseClassName class will iterate over results of $beanClassWithoutNameSpace class."));
-
-        $getIteratorMethod = new MethodGenerator(
-            'getIterator',
-            [],
-            MethodGenerator::FLAG_PUBLIC,
-            'return parent::getIterator();',
-            (new DocBlockGenerator(
-                "Return a ResultIterator of $beanClassWithoutNameSpace instances.",
-                null,
-                [
-                    new ReturnTag(['\\' . $beanClassName . '[]', '\\' . InnerResultIterator::class])
-                ]
-            ))->setWordWrap(false)
-        );
-
-        $class->addMethodFromGenerator($getIteratorMethod);
+        $class->setDocBlock((new DocBlockGenerator(
+            "The $baseClassName class will iterate over results of $beanClassWithoutNameSpace class.",
+            null,
+            [new Tag\MethodTag('getIterator', ['\\' . $beanClassName . '[]'])]
+        ))->setWordWrap(false));
 
         return $file;
     }
@@ -1383,8 +1371,7 @@ private function generateFindByDaoCodeForIndex(Index $index, string $beanNamespa
             $params[] = new ParamTag('additionalTablesFetch', [ 'string[]' ], 'A list of additional tables to fetch (for performance improvement)');
             $parameters[] = (new ParameterGenerator('mode', '?int'))->setDefaultValue(null);
             $params[] = new ParamTag('mode', [ 'int', 'null' ], 'Either TDBMService::MODE_ARRAY or TDBMService::MODE_CURSOR (for large datasets). Defaults to TDBMService::MODE_ARRAY.');
-            $params[] = new ReturnTag([ '\\'.$beanNamespace.'\\'.$beanClassName.'[]', '\\'.ResultIterator::class ]);
-            $method->setReturnType('\\'.ResultIterator::class);
+            $method->setReturnType($this->resultIteratorNamespace . '\\' . $this->getResultIteratorClassName());
 
             $docBlock = new DocBlockGenerator("Get a list of $beanClassName filtered by ".implode(', ', $commentArguments).".", null, $params);
             $docBlock->setWordWrap(false);

src/Utils/TDBMDaoGenerator.php

@@ -282,7 +282,7 @@ private function psr2Fix(string $content): string
     /**
      * Writes the PHP ResultIterator file with typed accessors.
      */
-    private function generateResultIterator(BeanDescriptor $beanDescriptor)
+    private function generateResultIterator(BeanDescriptor $beanDescriptor) : void
     {
         $resultIteratorClassName = $beanDescriptor->getResultIteratorClassName();
         $resultIteratorBaseClassName = $beanDescriptor->getBaseResultIteratorClassName();

tests/Commands/AlteredConfigurationTest.php

@@ -32,6 +32,7 @@ public function testAlteredConfiguration(): void
         $this->assertSame($logger, $alteredConfiguration->getLogger());
         $this->assertSame('FooBean', $alteredConfiguration->getBeanNamespace());
         $this->assertSame('FooDao', $alteredConfiguration->getDaoNamespace());
+        $this->assertSame('FooResultIterator', $alteredConfiguration->getResultIteratorNamespace());
         $this->assertSame($configuration->getGeneratorEventDispatcher(), $alteredConfiguration->getGeneratorEventDispatcher());
         $this->assertSame($schemaAnalyzer, $alteredConfiguration->getSchemaAnalyzer());
         $this->assertSame($configuration->getPathFinder(), $alteredConfiguration->getPathFinder());

tests/Utils/BeanDescriptorTest.php

@@ -59,7 +59,7 @@ protected function setUp(): void
     public function testConstructor(): void
     {
         $usersTable = $this->schema->getTable('users');
-        $beanDescriptor = new BeanDescriptor($usersTable, 'Tdbm\\Test\\Beans', 'Tdbm\\Test\\Beans\\Generated', 'Tdbm\\Test\\Daos', 'Tdbm\\Test\\Daos\\Generated',  'Tdbm\\Test\\ResultIterators', 'Tdbm\\Test\\ResultIterators\\Generated', $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer, $this->getNamingStrategy(), AnnotationParser::buildWithDefaultAnnotations([]), new BaseCodeGeneratorListener(), $this->getConfiguration(), $this->createMock(BeanRegistry::class));
+        $beanDescriptor = new BeanDescriptor($usersTable, 'Tdbm\\Test\\Beans', 'Tdbm\\Test\\Beans\\Generated', 'Tdbm\\Test\\Daos', 'Tdbm\\Test\\Daos\\Generated', 'Tdbm\\Test\\ResultIterators', 'Tdbm\\Test\\ResultIterators\\Generated', $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer, $this->getNamingStrategy(), AnnotationParser::buildWithDefaultAnnotations([]), new BaseCodeGeneratorListener(), $this->getConfiguration(), $this->createMock(BeanRegistry::class));
         $beanDescriptor->initBeanPropertyDescriptors();
         $propertyDescriptors = $beanDescriptor->getBeanPropertyDescriptors();
         $firstElem = reset($propertyDescriptors);