symfony · welcoMattic · Mar 12, 2025 · Jun 23, 2025 · Jun 23, 2025 · Jun 23, 2025
@@ -13,6 +13,7 @@
 
 use PhpParser\Node;
 use PhpParser\NodeVisitor;
+use Symfony\Component\Translation\TranslatableMessage;
 
 /**
  * @author Mathieu Santostefano <msantostefano@protonmail.com>
@@ -39,7 +40,7 @@ public function leaveNode(Node $node): ?Node
             return null;
         }
 
-        if (!\in_array('TranslatableMessage', $className->getParts(), true)) {
+        if (TranslatableMessage::class !== $className->name) {
             return null;
         }
 

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Translation\Tests\Extractor\Visitor;
+
+use PhpParser\NodeVisitor;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Translation\Extractor\PhpAstExtractor;
+use Symfony\Component\Translation\MessageCatalogue;
+
+abstract class AbstractVisitorTestCase extends TestCase
+{
+    /**
+     * @param string|iterable<string> $resource Files, a file or a directory
+     */
+    protected function extract(NodeVisitor $visitor, string|iterable $resource): MessageCatalogue
+    {
+        $extractor = new PhpAstExtractor([$visitor]);
+        $extractor->setPrefix('prefix');
+
+        $catalogue = new MessageCatalogue('en');
+
+        $extractor->extract($resource, $catalogue);
+
+        return $catalogue;
+    }
+}
@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Translation\Tests\Extractor\Visitor;
+
+use Symfony\Component\Translation\Extractor\Visitor\ConstraintVisitor;
+
+final class ConstraintVisitorTest extends AbstractVisitorTestCase
+{
+    private const FIXTURES_FOLDER = __DIR__.'/../../Fixtures/extractor-php-ast/constraint-visitor/';
+
+    public function testExtractMessages()
+    {
+        $catalogue = $this->extract(new ConstraintVisitor(['NotBlank', 'Isbn', 'Length']), self::FIXTURES_FOLDER);
+
+        $this->assertEquals(
+            [
+                'validators' => [
+                    'message-in-constraint-attribute' => 'prefixmessage-in-constraint-attribute',
+                    // 'custom Isbn message from attribute' => 'prefixcustom Isbn message from attribute',
+                    'custom Isbn message from attribute with options as array' => 'prefixcustom Isbn message from attribute with options as array',
+                    'custom Length exact message from attribute from named argument' => 'prefixcustom Length exact message from attribute from named argument',
+                    'custom Length exact message from attribute from named argument 1/2' => 'prefixcustom Length exact message from attribute from named argument 1/2',
+                    'custom Length min message from attribute from named argument 2/2' => 'prefixcustom Length min message from attribute from named argument 2/2',
+                    // 'custom Isbn message' => 'prefixcustom Isbn message',
+                    'custom Isbn message with options as array' => 'prefixcustom Isbn message with options as array',
+                    'custom Isbn message from named argument' => 'prefixcustom Isbn message from named argument',
+                    'custom Length exact message from named argument' => 'prefixcustom Length exact message from named argument',
+                    'custom Length exact message from named argument 1/2' => 'prefixcustom Length exact message from named argument 1/2',
+                    'custom Length min message from named argument 2/2' => 'prefixcustom Length min message from named argument 2/2',
+                ],
+            ],
+            $catalogue->all(),
+        );
+
+        $fixtureFolder = str_replace(\DIRECTORY_SEPARATOR, '/', self::FIXTURES_FOLDER);
+
+        $this->assertEquals(['sources' => [$fixtureFolder.'validator-constraints.php:7']], $catalogue->getMetadata('message-in-constraint-attribute', 'validators'));
+    }
+}
@@ -0,0 +1,116 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Translation\Tests\Extractor\Visitor;
+
+use Symfony\Component\Translation\Extractor\Visitor\TransMethodVisitor;
+
+final class TransMethodVisitorTest extends AbstractVisitorTestCase
+{
+    private const FIXTURES_FOLDER = __DIR__.'/../../Fixtures/extractor-php-ast/trans-method-visitor/';
+    public const OTHER_DOMAIN = 'not_messages';
+
+    public function testExtractMessages()
+    {
+        $catalogue = $this->extract(new TransMethodVisitor(), self::FIXTURES_FOLDER);
+
+        $expectedHeredoc = <<<EOF
+            heredoc key with whitespace and escaped \$\n sequences
+            EOF;
+        $expectedNowdoc = <<<'EOF'
+            nowdoc key with whitespace and nonescaped \$\n sequences
+            EOF;
+
+        $this->assertEquals(
+            [
+                'messages' => [
+                    'single-quoted key' => 'prefixsingle-quoted key',
+                    'double-quoted key' => 'prefixdouble-quoted key',
+                    'heredoc key' => 'prefixheredoc key',
+                    'nowdoc key' => 'prefixnowdoc key',
+                    "double-quoted key with whitespace and escaped \$\n\" sequences" => "prefixdouble-quoted key with whitespace and escaped \$\n\" sequences",
+                    'single-quoted key with whitespace and nonescaped \\$\\n\' sequences' => 'prefixsingle-quoted key with whitespace and nonescaped \\$\\n\' sequences',
+                    $expectedHeredoc => 'prefix'.$expectedHeredoc,
+                    $expectedNowdoc => 'prefix'.$expectedNowdoc,
+                    'single-quoted key with "quote mark at the end"' => 'prefixsingle-quoted key with "quote mark at the end"',
+                    'concatenated message with heredoc and nowdoc' => 'prefixconcatenated message with heredoc and nowdoc',
+                    'default domain' => 'prefixdefault domain',
+                    'mix-named-arguments' => 'prefixmix-named-arguments',
+                    'mix-named-arguments-locale' => 'prefixmix-named-arguments-locale',
+                    'mix-named-arguments-without-domain' => 'prefixmix-named-arguments-without-domain',
+                    "heredoc\nindented\n  further" => "prefixheredoc\nindented\n  further",
+                    "nowdoc\nindented\n  further" => "prefixnowdoc\nindented\n  further",
+                    'translatable-short single-quoted key' => 'prefixtranslatable-short single-quoted key',
+                    'translatable-short double-quoted key' => 'prefixtranslatable-short double-quoted key',
+                    'translatable-short heredoc key' => 'prefixtranslatable-short heredoc key',
+                    'translatable-short nowdoc key' => 'prefixtranslatable-short nowdoc key',
+                    "translatable-short double-quoted key with whitespace and escaped \$\n\" sequences" => "prefixtranslatable-short double-quoted key with whitespace and escaped \$\n\" sequences",
+                    'translatable-short single-quoted key with whitespace and nonescaped \$\n\' sequences' => 'prefixtranslatable-short single-quoted key with whitespace and nonescaped \$\n\' sequences',
+                    'translatable-short single-quoted key with "quote mark at the end"' => 'prefixtranslatable-short single-quoted key with "quote mark at the end"',
+                    'translatable-short '.$expectedHeredoc => 'prefixtranslatable-short '.$expectedHeredoc,
+                    'translatable-short '.$expectedNowdoc => 'prefixtranslatable-short '.$expectedNowdoc,
+                    'translatable-short concatenated message with heredoc and nowdoc' => 'prefixtranslatable-short concatenated message with heredoc and nowdoc',
+                    'translatable-short default domain' => 'prefixtranslatable-short default domain',
+                    'translatable-short-fqn single-quoted key' => 'prefixtranslatable-short-fqn single-quoted key',
+                    'translatable-short-fqn double-quoted key' => 'prefixtranslatable-short-fqn double-quoted key',
+                    'translatable-short-fqn heredoc key' => 'prefixtranslatable-short-fqn heredoc key',
+                    'translatable-short-fqn nowdoc key' => 'prefixtranslatable-short-fqn nowdoc key',
+                    "translatable-short-fqn double-quoted key with whitespace and escaped \$\n\" sequences" => "prefixtranslatable-short-fqn double-quoted key with whitespace and escaped \$\n\" sequences",
+                    'translatable-short-fqn single-quoted key with whitespace and nonescaped \$\n\' sequences' => 'prefixtranslatable-short-fqn single-quoted key with whitespace and nonescaped \$\n\' sequences',
+                    'translatable-short-fqn single-quoted key with "quote mark at the end"' => 'prefixtranslatable-short-fqn single-quoted key with "quote mark at the end"',
+                    'translatable-short-fqn '.$expectedHeredoc => 'prefixtranslatable-short-fqn '.$expectedHeredoc,
+                    'translatable-short-fqn '.$expectedNowdoc => 'prefixtranslatable-short-fqn '.$expectedNowdoc,
+                    'translatable-short-fqn concatenated message with heredoc and nowdoc' => 'prefixtranslatable-short-fqn concatenated message with heredoc and nowdoc',
+                    'translatable-short-fqn default domain' => 'prefixtranslatable-short-fqn default domain',
+                ],
+                'not_messages' => [
+                    'other-domain-test-no-params-short-array' => 'prefixother-domain-test-no-params-short-array',
+                    'other-domain-test-no-params-long-array' => 'prefixother-domain-test-no-params-long-array',
+                    'other-domain-test-params-short-array' => 'prefixother-domain-test-params-short-array',
+                    'other-domain-test-params-long-array' => 'prefixother-domain-test-params-long-array',
+                    'typecast' => 'prefixtypecast',
+                    'ordered-named-arguments-in-trans-method' => 'prefixordered-named-arguments-in-trans-method',
+                    'disordered-named-arguments-in-trans-method' => 'prefixdisordered-named-arguments-in-trans-method',
+                    'variable-assignation-inlined-in-trans-method-call1' => 'prefixvariable-assignation-inlined-in-trans-method-call1',
+                    'variable-assignation-inlined-in-trans-method-call2' => 'prefixvariable-assignation-inlined-in-trans-method-call2',
+                    'variable-assignation-inlined-in-trans-method-call3' => 'prefixvariable-assignation-inlined-in-trans-method-call3',
+                    'variable-assignation-inlined-with-named-arguments-in-trans-method' => 'prefixvariable-assignation-inlined-with-named-arguments-in-trans-method',
+                    'mix-named-arguments-without-parameters' => 'prefixmix-named-arguments-without-parameters',
+                    'mix-named-arguments-disordered' => 'prefixmix-named-arguments-disordered',
+                    'const-domain' => 'prefixconst-domain',
+                    'translatable-short other-domain-test-no-params-short-array' => 'prefixtranslatable-short other-domain-test-no-params-short-array',
+                    'translatable-short other-domain-test-no-params-long-array' => 'prefixtranslatable-short other-domain-test-no-params-long-array',
+                    'translatable-short other-domain-test-params-short-array' => 'prefixtranslatable-short other-domain-test-params-short-array',
+                    'translatable-short other-domain-test-params-long-array' => 'prefixtranslatable-short other-domain-test-params-long-array',
+                    'translatable-short typecast' => 'prefixtranslatable-short typecast',
+                    'translatable-short-fqn other-domain-test-no-params-short-array' => 'prefixtranslatable-short-fqn other-domain-test-no-params-short-array',
+                    'translatable-short-fqn other-domain-test-no-params-long-array' => 'prefixtranslatable-short-fqn other-domain-test-no-params-long-array',
+                    'translatable-short-fqn other-domain-test-params-short-array' => 'prefixtranslatable-short-fqn other-domain-test-params-short-array',
+                    'translatable-short-fqn other-domain-test-params-long-array' => 'prefixtranslatable-short-fqn other-domain-test-params-long-array',
+                    'translatable-short-fqn typecast' => 'prefixtranslatable-short-fqn typecast',
+                ],
+            ],
+            $catalogue->all(),
+        );
+
+        $fixtureFolder = str_replace(\DIRECTORY_SEPARATOR, '/', self::FIXTURES_FOLDER);
+
+        $this->assertEquals(['sources' => [$fixtureFolder.'translation.html.php:2']], $catalogue->getMetadata('single-quoted key'));
+        $this->assertEquals(['sources' => [$fixtureFolder.'translation.html.php:37']], $catalogue->getMetadata('other-domain-test-no-params-short-array', 'not_messages'));
+        $this->assertEquals(['sources' => [$fixtureFolder.'translation-73.html.php:8']], $catalogue->getMetadata("nowdoc\nindented\n  further"));
+
+        $this->assertEquals(['sources' => [$fixtureFolder.'translatable-short.html.php:2']], $catalogue->getMetadata('translatable-short single-quoted key'));
+        $this->assertEquals(['sources' => [$fixtureFolder.'translatable-short.html.php:37']], $catalogue->getMetadata('translatable-short other-domain-test-no-params-short-array', 'not_messages'));
+
+        $this->assertEquals(['sources' => [$fixtureFolder.'translatable-short-fqn.html.php:2']], $catalogue->getMetadata('translatable-short-fqn single-quoted key'));
+        $this->assertEquals(['sources' => [$fixtureFolder.'translatable-short-fqn.html.php:37']], $catalogue->getMetadata('translatable-short-fqn other-domain-test-no-params-short-array', 'not_messages'));
+    }
+}
@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Translation\Tests\Extractor\Visitor;
+
+use Symfony\Component\Translation\Extractor\Visitor\TranslatableMessageVisitor;
+
+final class TranslatableMessageVisitorTest extends AbstractVisitorTestCase
+{
+    private const FIXTURES_FOLDER = __DIR__.'/../../Fixtures/extractor-php-ast/translatable-message-visitor/';
+
+    public function testExtractMessages()
+    {
+        $catalogue = $this->extract(new TranslatableMessageVisitor(), self::FIXTURES_FOLDER);
+
+        $expectedHeredoc = <<<EOF
+            heredoc key with whitespace and escaped \$\n sequences
+            EOF;
+        $expectedNowdoc = <<<'EOF'
+            nowdoc key with whitespace and nonescaped \$\n sequences
+            EOF;
+
+        $this->assertEquals(
+            [
+                'messages' => [
+                    'translatable single-quoted key' => 'prefixtranslatable single-quoted key',
+                    'translatable double-quoted key' => 'prefixtranslatable double-quoted key',
+                    'translatable heredoc key' => 'prefixtranslatable heredoc key',
+                    'translatable nowdoc key' => 'prefixtranslatable nowdoc key',
+                    "translatable double-quoted key with whitespace and escaped \$\n\" sequences" => "prefixtranslatable double-quoted key with whitespace and escaped \$\n\" sequences",
+                    'translatable single-quoted key with whitespace and nonescaped \$\n\' sequences' => 'prefixtranslatable single-quoted key with whitespace and nonescaped \$\n\' sequences',
+                    'translatable single-quoted key with "quote mark at the end"' => 'prefixtranslatable single-quoted key with "quote mark at the end"',
+                    'translatable '.$expectedHeredoc => 'prefixtranslatable '.$expectedHeredoc,
+                    'translatable '.$expectedNowdoc => 'prefixtranslatable '.$expectedNowdoc,
+                    'translatable concatenated message with heredoc and nowdoc' => 'prefixtranslatable concatenated message with heredoc and nowdoc',
+                    'translatable default domain' => 'prefixtranslatable default domain',
+                    'translatable-fqn single-quoted key' => 'prefixtranslatable-fqn single-quoted key',
+                    'translatable-fqn double-quoted key' => 'prefixtranslatable-fqn double-quoted key',
+                    'translatable-fqn heredoc key' => 'prefixtranslatable-fqn heredoc key',
+                    'translatable-fqn nowdoc key' => 'prefixtranslatable-fqn nowdoc key',
+                    "translatable-fqn double-quoted key with whitespace and escaped \$\n\" sequences" => "prefixtranslatable-fqn double-quoted key with whitespace and escaped \$\n\" sequences",
+                    'translatable-fqn single-quoted key with whitespace and nonescaped \$\n\' sequences' => 'prefixtranslatable-fqn single-quoted key with whitespace and nonescaped \$\n\' sequences',
+                    'translatable-fqn single-quoted key with "quote mark at the end"' => 'prefixtranslatable-fqn single-quoted key with "quote mark at the end"',
+                    'translatable-fqn '.$expectedHeredoc => 'prefixtranslatable-fqn '.$expectedHeredoc,
+                    'translatable-fqn '.$expectedNowdoc => 'prefixtranslatable-fqn '.$expectedNowdoc,
+                    'translatable-fqn concatenated message with heredoc and nowdoc' => 'prefixtranslatable-fqn concatenated message with heredoc and nowdoc',
+                    'translatable-fqn default domain' => 'prefixtranslatable-fqn default domain',
+                ],
+                'not_messages' => [
+                    'translatable other-domain-test-no-params-short-array' => 'prefixtranslatable other-domain-test-no-params-short-array',
+                    'translatable other-domain-test-no-params-long-array' => 'prefixtranslatable other-domain-test-no-params-long-array',
+                    'translatable other-domain-test-params-short-array' => 'prefixtranslatable other-domain-test-params-short-array',
+                    'translatable other-domain-test-params-long-array' => 'prefixtranslatable other-domain-test-params-long-array',
+                    'translatable typecast' => 'prefixtranslatable typecast',
+                    'translatable-fqn other-domain-test-no-params-short-array' => 'prefixtranslatable-fqn other-domain-test-no-params-short-array',
+                    'translatable-fqn other-domain-test-no-params-long-array' => 'prefixtranslatable-fqn other-domain-test-no-params-long-array',
+                    'translatable-fqn other-domain-test-params-short-array' => 'prefixtranslatable-fqn other-domain-test-params-short-array',
+                    'translatable-fqn other-domain-test-params-long-array' => 'prefixtranslatable-fqn other-domain-test-params-long-array',
+                    'translatable-fqn typecast' => 'prefixtranslatable-fqn typecast',
+                ],
+            ],
+            $catalogue->all(),
+        );
+
+        $fixtureFolder = str_replace(\DIRECTORY_SEPARATOR, '/', self::FIXTURES_FOLDER);
+
+        $this->assertEquals(['sources' => [$fixtureFolder.'translatable.html.php:3']], $catalogue->getMetadata('translatable single-quoted key'));
+        $this->assertEquals(['sources' => [$fixtureFolder.'translatable.html.php:38']], $catalogue->getMetadata('translatable other-domain-test-no-params-short-array', 'not_messages'));
+
+        $this->assertEquals(['sources' => [$fixtureFolder.'translatable-fqn.html.php:2']], $catalogue->getMetadata('translatable-fqn single-quoted key'));
+        $this->assertEquals(['sources' => [$fixtureFolder.'translatable-fqn.html.php:37']], $catalogue->getMetadata('translatable-fqn other-domain-test-no-params-short-array', 'not_messages'));
+    }
+}