Skip to content

Draft: Improvement - Add method annotations in iterator generated classes #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Draft: Improvement - Add method annotations in iterator generated classes #242

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions src/Utils/BeanDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1156,9 +1156,10 @@ public function generateResultIteratorPhpCode(): ?FileGenerator
$tableName = $this->table->getName();

$className = $this->namingStrategy->getResultIteratorClassName($tableName);
$classFullName = $this->resultIteratorNamespace.'\\'.$className;
$baseClassName = $this->namingStrategy->getBaseResultIteratorClassName($tableName);
$beanClassWithoutNameSpace = $this->namingStrategy->getBeanClassName($tableName);
$beanClassName = $this->beanNamespace.'\\'.$beanClassWithoutNameSpace;
$beanClassName = $this->namingStrategy->getBeanClassName($tableName);
$beanClassFullName = $this->beanNamespace.'\\'.$beanClassName;

$file->setDocBlock(new DocBlockGenerator(
<<<EOF
Expand All @@ -1167,14 +1168,27 @@ public function generateResultIteratorPhpCode(): ?FileGenerator
If you need to perform changes, edit the $className class instead!
EOF
));
$class->addUse(ResultIterator::class);

$uses = [ResultIterator::class, $classFullName, $beanClassFullName];
sort($uses);
foreach ($uses as $use) {
$class->addUse($use);
}

$class->setName($baseClassName);
$class->setExtendedClass(ResultIterator::class);

$class->setDocBlock((new DocBlockGenerator(
"The $baseClassName class will iterate over results of $beanClassWithoutNameSpace class.",
"The $baseClassName class will iterate over results of $beanClassName class.",
null,
[new Tag\MethodTag('getIterator', ['\\' . $beanClassName . '[]'])]
[
new Tag\MethodTag('first', [$beanClassName]),
new Tag\MethodTag('offsetGet', [$beanClassName]),
new Tag\MethodTag('getIterator', [$beanClassName . '[]']),
new Tag\MethodTag('toArray', [$beanClassName . '[]']),
new Tag\MethodTag('withOrder', [$className]),
new Tag\MethodTag('withParameters', [$className]),
]
))->setWordWrap(false));

$file = $this->codeGeneratorListener->onBaseResultIteratorGenerated($file, $this, $this->configuration);
Expand Down