Skip to content

[Translation] Extract constraint class names instead of relying on service declaration #49785

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

Closed
nfragnet wants to merge 2 commits into from
Closed

[Translation] Extract constraint class names instead of relying on service declaration #49785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e65a155
Extract constraint class names by parsing files instead of relying on…
Mar 23, 2023
a967888
Code style update
Mar 24, 2023
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
50 changes: 39 additions & 11 deletions src/Symfony/Component/Translation/DependencyInjection/TranslatorPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Validator\Constraint;

class TranslatorPass implements CompilerPassInterface
{
Expand Down Expand Up @@ -51,17 +53,7 @@ public function process(ContainerBuilder $container)

if ($container->hasDefinition('validator') && $container->hasDefinition('translation.extractor.visitor.constraint')) {
$constraintVisitorDefinition = $container->getDefinition('translation.extractor.visitor.constraint');
$constraintClassNames = [];

foreach ($container->findTaggedServiceIds('validator.constraint_validator', true) as $id => $attributes) {
$serviceDefinition = $container->getDefinition($id);
// Resolve constraint validator FQCN even if defined as %foo.validator.class% parameter
$className = $container->getParameterBag()->resolveValue($serviceDefinition->getClass());
// Extraction of the constraint class name from the Constraint Validator FQCN
$constraintClassNames[] = str_replace('Validator', '', substr(strrchr($className, '\\'), 1));
}

$constraintVisitorDefinition->setArgument(0, $constraintClassNames);
$constraintVisitorDefinition->setArgument(0, $this->extractConstraintClassNames());
}

if (!$container->hasParameter('twig.default_path')) {
Expand All @@ -86,4 +78,40 @@ public function process(ContainerBuilder $container)
}
}
}

/**
* @return array An array of all contraints class names
* contained in Validator Component
*/
private function extractConstraintClassNames(): array
{
$directory = __DIR__.'/../../Validator/Constraints';

$finder = new Finder();
$finder->files()->in($directory)->name('*.php');
$classes = [];

foreach ($finder as $file) {
$filePath = $file->getRealPath();
$fileContents = file_get_contents($filePath);

preg_match('/namespace\s+([^\s;]+).*class\s+(\w+)/s', $fileContents, $matches);
if (3 !== \count($matches)) {
continue;
}

$namespace = $matches[1];
$className = $matches[2];
$fqcn = $namespace.'\\'.$className;

if (
class_exists($fqcn) &&
is_subclass_of($fqcn, Constraint::class)
) {
$classes[] = $className;
}
}

return $classes;
}
}
18 changes: 4 additions & 14 deletions src/Symfony/Component/Translation/Tests/DependencyInjection/TranslatorPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\Translation\DependencyInjection\TranslatorPass;
use Symfony\Component\Translation\Extractor\Visitor\ConstraintVisitor;
use Symfony\Component\Validator\Constraints\IsbnValidator;
use Symfony\Component\Validator\Constraints\LengthValidator;
use Symfony\Component\Validator\Constraints\NotBlankValidator;
use Symfony\Component\Validator\Constraints\TimeValidator;

class TranslatorPassTest extends TestCase
{
Expand Down Expand Up @@ -132,19 +128,13 @@ public function testValidPhpAstExtractorConstraintVisitorArguments()
->setArguments([null, null, null, null]);
$container->register('validator');
$constraintVisitor = $container->register('translation.extractor.visitor.constraint', ConstraintVisitor::class);
$container->register('validator.not_blank', NotBlankValidator::class)
->addTag('validator.constraint_validator');
$container->register('validator.isbn', IsbnValidator::class)
->addTag('validator.constraint_validator');
$container->register('validator.length', LengthValidator::class)
->addTag('validator.constraint_validator');
$container->register('validator.time', '%foo.time.validator.class%')
->addTag('validator.constraint_validator');
$container->setParameter('foo.time.validator.class', TimeValidator::class);

$pass = new TranslatorPass();
$pass->process($container);

$this->assertSame(['NotBlank', 'Isbn', 'Length', 'Time'], $constraintVisitor->getArgument(0));
$this->assertContains('NotBlank', $constraintVisitor->getArgument(0));
$this->assertContains('Isbn', $constraintVisitor->getArgument(0));
$this->assertContains('Length', $constraintVisitor->getArgument(0));
$this->assertContains('Time', $constraintVisitor->getArgument(0));
}
}