[Translation] Fix constant domain resolution in PhpAstExtractor

VincentLanglet · nicolas-grekas · commit c43f6c0e57c2 · 2024-01-29T14:11:52.000+01:00
diff --git a/src/Symfony/Component/Translation/Extractor/PhpAstExtractor.php b/src/Symfony/Component/Translation/Extractor/PhpAstExtractor.php
@@ -46,6 +46,11 @@ public function extract(iterable|string $resource, MessageCatalogue $catalogue):
     {
         foreach ($this->extractFiles($resource) as $file) {
             $traverser = new NodeTraverser();
+
+            // This is needed to resolve namespaces in class methods/constants.
+            $nameResolver = new NodeVisitor\NameResolver();
+            $traverser->addVisitor($nameResolver);
+
             /** @var AbstractVisitor&NodeVisitor $visitor */
             foreach ($this->visitors as $visitor) {
                 $visitor->initialize($catalogue, $file, $this->prefix);
diff --git a/src/Symfony/Component/Translation/Extractor/Visitor/AbstractVisitor.php b/src/Symfony/Component/Translation/Extractor/Visitor/AbstractVisitor.php
@@ -119,6 +119,17 @@ private function getStringValue(Node $node): ?string
             return $node->expr->value;
         }
 
+        if ($node instanceof Node\Expr\ClassConstFetch) {
+            try {
+                $reflection = new \ReflectionClass($node->class->toString());
+                $constant = $reflection->getReflectionConstant($node->name->toString());
+                if (false !== $constant && \is_string($constant->getValue())) {
+                    return $constant->getValue();
+                }
+            } catch (\ReflectionException) {
+            }
+        }
+
         return null;
     }
 }
diff --git a/src/Symfony/Component/Translation/Extractor/Visitor/ConstraintVisitor.php b/src/Symfony/Component/Translation/Extractor/Visitor/ConstraintVisitor.php
@@ -32,6 +32,11 @@ public function beforeTraverse(array $nodes): ?Node
     }
 
     public function enterNode(Node $node): ?Node
+    {
+        return null;
+    }
+
+    public function leaveNode(Node $node): ?Node
     {
         if (!$node instanceof Node\Expr\New_ && !$node instanceof Node\Attribute) {
             return null;
@@ -100,11 +105,6 @@ public function enterNode(Node $node): ?Node
         return null;
     }
 
-    public function leaveNode(Node $node): ?Node
-    {
-        return null;
-    }
-
     public function afterTraverse(array $nodes): ?Node
     {
         return null;
diff --git a/src/Symfony/Component/Translation/Extractor/Visitor/TransMethodVisitor.php b/src/Symfony/Component/Translation/Extractor/Visitor/TransMethodVisitor.php
@@ -25,6 +25,11 @@ public function beforeTraverse(array $nodes): ?Node
     }
 
     public function enterNode(Node $node): ?Node
+    {
+        return null;
+    }
+
+    public function leaveNode(Node $node): ?Node
     {
         if (!$node instanceof Node\Expr\MethodCall && !$node instanceof Node\Expr\FuncCall) {
             return null;
@@ -53,11 +58,6 @@ public function enterNode(Node $node): ?Node
         return null;
     }
 
-    public function leaveNode(Node $node): ?Node
-    {
-        return null;
-    }
-
     public function afterTraverse(array $nodes): ?Node
     {
         return null;
diff --git a/src/Symfony/Component/Translation/Extractor/Visitor/TranslatableMessageVisitor.php b/src/Symfony/Component/Translation/Extractor/Visitor/TranslatableMessageVisitor.php
@@ -25,6 +25,11 @@ public function beforeTraverse(array $nodes): ?Node
     }
 
     public function enterNode(Node $node): ?Node
+    {
+        return null;
+    }
+
+    public function leaveNode(Node $node): ?Node
     {
         if (!$node instanceof Node\Expr\New_) {
             return null;
@@ -53,11 +58,6 @@ public function enterNode(Node $node): ?Node
         return null;
     }
 
-    public function leaveNode(Node $node): ?Node
-    {
-        return null;
-    }
-
     public function afterTraverse(array $nodes): ?Node
     {
         return null;
diff --git a/src/Symfony/Component/Translation/Tests/Extractor/PhpAstExtractorTest.php b/src/Symfony/Component/Translation/Tests/Extractor/PhpAstExtractorTest.php
@@ -20,6 +20,8 @@
 
 final class PhpAstExtractorTest extends TestCase
 {
+    public const OTHER_DOMAIN = 'not_messages';
+
     /**
      * @dataProvider resourcesProvider
      */
@@ -124,6 +126,7 @@ public function testExtraction(iterable|string $resource)
                 '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',
             ],
             'validators' => [
                 'message-in-constraint-attribute' => 'prefixmessage-in-constraint-attribute',
diff --git a/src/Symfony/Component/Translation/Tests/Fixtures/extractor-ast/translation.html.php b/src/Symfony/Component/Translation/Tests/Fixtures/extractor-ast/translation.html.php
@@ -62,3 +62,8 @@
 <?php echo $view['translator']->trans('mix-named-arguments-disordered', domain: 'not_messages', parameters: []); ?>
 
 <?php echo $view['translator']->trans(...); // should not fail ?>
+
+<?php
+use Symfony\Component\Translation\Tests\Extractor\PhpAstExtractorTest;
+echo $view['translator']->trans('const-domain', [], PhpAstExtractorTest::OTHER_DOMAIN);
+?>

Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,17 @@ private function getStringValue(Node $node): ?string`
`119`	`119`	`return $node->expr->value;`
`120`	`120`	`}`
`121`	`121`
	`122`	`+ if ($node instanceof Node\Expr\ClassConstFetch) {`
	`123`	`+ try {`
	`124`	`+ $reflection = new \ReflectionClass($node->class->toString());`
	`125`	`+ $constant = $reflection->getReflectionConstant($node->name->toString());`
	`126`	`+ if (false !== $constant && \is_string($constant->getValue())) {`
	`127`	`+ return $constant->getValue();`
	`128`	`+ }`
	`129`	`+ } catch (\ReflectionException) {`
	`130`	`+ }`
	`131`	`+ }`
	`132`	`+`
`122`	`133`	`return null;`
`123`	`134`	`}`
`124`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,11 @@ public function beforeTraverse(array $nodes): ?Node`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public function enterNode(Node $node): ?Node`
	`35`	`+ {`
	`36`	`+ return null;`
	`37`	`+ }`
	`38`	`+`
	`39`	`+ public function leaveNode(Node $node): ?Node`
`35`	`40`	`{`
`36`	`41`	`if (!$node instanceof Node\Expr\New_ && !$node instanceof Node\Attribute) {`
`37`	`42`	`return null;`
`@@ -100,11 +105,6 @@ public function enterNode(Node $node): ?Node`
`100`	`105`	`return null;`
`101`	`106`	`}`
`102`	`107`
`103`		`- public function leaveNode(Node $node): ?Node`
`104`		`- {`
`105`		`- return null;`
`106`		`- }`
`107`		`-`
`108`	`108`	`public function afterTraverse(array $nodes): ?Node`
`109`	`109`	`{`
`110`	`110`	`return null;`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,11 @@ public function beforeTraverse(array $nodes): ?Node`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`public function enterNode(Node $node): ?Node`
	`28`	`+ {`
	`29`	`+ return null;`
	`30`	`+ }`
	`31`	`+`
	`32`	`+ public function leaveNode(Node $node): ?Node`
`28`	`33`	`{`
`29`	`34`	`if (!$node instanceof Node\Expr\MethodCall && !$node instanceof Node\Expr\FuncCall) {`
`30`	`35`	`return null;`
`@@ -53,11 +58,6 @@ public function enterNode(Node $node): ?Node`
`53`	`58`	`return null;`
`54`	`59`	`}`
`55`	`60`
`56`		`- public function leaveNode(Node $node): ?Node`
`57`		`- {`
`58`		`- return null;`
`59`		`- }`
`60`		`-`
`61`	`61`	`public function afterTraverse(array $nodes): ?Node`
`62`	`62`	`{`
`63`	`63`	`return null;`