Merge pull request #11455 from creative-commoners/pulls/5.3/fix-i18n

FIX Anonymous function use statements in text collector
silverstripe · Nov 5, 2024 · 84c09fd · 84c09fd
2 parents fe39a2a + 9116d8a
commit 84c09fd
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 2 deletions.
diff --git a/src/i18n/TextCollection/i18nTextCollector.php b/src/i18n/TextCollection/i18nTextCollector.php
@@ -602,6 +602,7 @@ public function collectFromCode($content, $fileName, Module $module)
         $entities = [];
 
         $tokens = token_get_all("<?php\n" . $content);
+        $lines = explode("\n", str_replace("\r\n", "\n", $content));
         $inTransFn = false;
         $inConcat = false;
         $inNamespace = false;
@@ -622,10 +623,14 @@ public function collectFromCode($content, $fileName, Module $module)
             $previousToken = $thisToken;
             $thisToken = $token;
             if (is_array($token)) {
-                list($id, $text) = $token;
+                list($id, $text, $lineNo) = $token;
+                // minus 2 is used so the the line we get corresponds with what number token_get_all() returned
+                $line = $lines[$lineNo - 2] ?? '';
 
                 // Collect use statements so we can get fully qualified class names
-                if ($id === T_USE) {
+                // Note that T_USE will match both use statements and anonymous functions with the "use" keyword
+                // e.g. $func = function () use ($var) { ... };
+                if ($id === T_USE && !preg_match('#use *\(#', $line)) {
                     $inUse = true;
                     $currentUse = [];
                     continue;

diff --git a/tests/php/i18n/i18nTextCollectorTest.php b/tests/php/i18n/i18nTextCollectorTest.php
@@ -714,6 +714,58 @@ public function testCollectFromEntityProvidersInCustomObject()
         );
     }
 
+    public function testCollectFromAnonymousMethod()
+    {
+        $c = i18nTextCollector::create();
+        $mymodule = ModuleLoader::inst()->getManifest()->getModule('i18ntestmodule');
+        $php = <<<PHP
+<?php
+namespace SilverStripe\Framework\Core;
+
+class MyClass
+{
+    public function getNewLines(\$class) {
+        Deprecation::withSuppressedNotice(function () {
+            \$this->someMethod(_t(
+                MyClass::class . '.SOMETHING_A',
+                'something a',
+            ));
+        });
+    }
+
+    public function getNewLinesWithSomething(\$class, \$something) {
+        Deprecation::withSuppressedNotice(function () use (\$something) {
+            \$this->someMethod(_t(
+                MyClass::class . '.SOMETHING_B',
+                'something {something}',
+                ['something' => \$something]
+            ));
+        });
+    }
+
+    public function getNewLinesWithSomething(\$class, \$something) {
+        Deprecation::withSuppressedNotice(function (
+            \$myparam
+        ) use (\$something) {
+            \$this->someMethod(_t(
+                MyClass::class . '.SOMETHING_C',
+                'something {something} {myparam}',
+                ['something' => \$something, 'myparam' => \$myparam]
+            ));
+        });
+    }
+}
+PHP;
+        $this->assertEquals(
+            [
+                'SilverStripe\\Framework\\Core\\MyClass.SOMETHING_A' => "something a",
+                'SilverStripe\\Framework\\Core\\MyClass.SOMETHING_B' => "something {something}",
+                'SilverStripe\\Framework\\Core\\MyClass.SOMETHING_C' => "something {something} {myparam}",
+            ],
+            $c->collectFromCode($php, null, $mymodule)
+        );
+    }
+
     public function testCollectFromEntityProvidersInWebRoot()
     {
         // Collect from i18nProviderClass