Merge pull request #52 from wikimedia/use-all-domains

Change Intuition::msg() to check all domains for messages

Author: MusikAnimal

README.md

@@ -6,7 +6,7 @@ A Symfony 4 bundle that provides some common parts of web-based tools in Wikimed
 Features:
 
 * OAuth user authentication against [Meta Wiki](https://meta.wikimedia.org/).
-* Internationalization with the Intuition and jQuery.i18n libraries.
+* Internationalization with the [Intuition](https://intuition.toolforge.org/) and jQuery.i18n libraries.
 * Interface to connect and query the [replica databases](https://wikitech.wikimedia.org/wiki/Wiki_replicas)
 * PHP Code Sniffer ruleset
 * Base Wikimedia UI stylesheet (LESS)
@@ -93,10 +93,10 @@ to the full URL to `Special:OAuth`.
 Add a login link to the relevant Twig template (often `base.html.twig`), e.g.:
 
     {% if logged_in_user() %}
-      {{ msg( 'logged-in-as', [ logged_in_user().username ] ) }}
-      <a href="{{ path('toolforge_logout') }}">{{ msg('logout') }}</a>
+      {{ msg( 'toolforge-logged-in-as', [ logged_in_user().username ] ) }}
+      <a href="{{ path('toolforge_logout') }}">{{ msg('toolforge-logout') }}</a>
     {% else %}
-      <a href="{{ path('toolforge_login') }}">{{ msg('login') }}</a>
+      <a href="{{ path('toolforge_login') }}">{{ msg('toolforge-login') }}</a>
     {% endif %}
 
 The internationalization parts of this are explained below.
@@ -140,6 +140,11 @@ ultimately be redirected back to `https://my-tool.toolforge.org/my-page?foo=bar`
 
 ### Internationalization (Intuition and jQuery.i18n)
 
+Internationalization is handled similarly to how it is done in MediaWiki,
+with translated strings being stored in `i18n/` directories.
+The bundle comes with some strings of its own, all prefixed with `toolforge_`;
+it is recommended that these are used where possible because it reduces the work for translators.
+
 #### 1. PHP
 
 In PHP, set your application's i18n 'domain' with the following in `config/packages/toolforge.yaml`:
@@ -148,9 +153,9 @@ In PHP, set your application's i18n 'domain' with the following in `config/packa
         intuition:
             domain: 'app-name-here'
 
-You can inject Intuition into your controllers via type hinting, e.g.:
+You can inject (the bundle's subclass of) Intuition into your controllers via type hinting, e.g.:
 
-    public function indexAction( Request $request, Intuition $intuition ) { /*...*/ }
+    public function indexAction( Request $request, \Wikimedia\ToolforgeBundle\Service\Intuition $intuition ) { /*...*/ }
 
 The following Twig functions and filters are available:
 
@@ -182,7 +187,7 @@ In Javascript, you need to do three things to enable internationalisation:
        <script type="text/javascript" src="https://tools-static.wmflabs.org/cdnjs/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
        {% include '@toolforge/i18n.html.twig' %}
 
-   (The jQuery can of course be left out if you're already loading that through other means.)
+   (The jQuery can be left out if you're already loading that through other means.)
 
 3. And symlink your `i18n/` directory from `public/i18n/`,
    so that the language files can be loaded by from Javascript.

Resources/i18n/de.json

@@ -1,3 +1,3 @@
 {
-  "logout": "Abmelden"
+  "toolforge-logout": "Abmelden"
 }

Resources/i18n/en.json

@@ -1,3 +1,5 @@
 {
-  "logout": "Logout"
+  "toolforge-login": "Log in",
+  "toolforge-logout": "Log out",
+  "toolforge-logged-in-as": "You are logged in as '$1'"
 }

Resources/i18n/qqq.json

@@ -1,3 +1,5 @@
 {
-  "logout": "Text for logout link."
+  "toolforge-login": "Text for the log in link.",
+  "toolforge-logout": "Text for the log out link.",
+  "toolforge-logged-in-as": "Tooltip text showing the name of the current user.\n\nParameters:\n\n* $1 — the username of the logged-in user"
 }

Service/Intuition.php

@@ -55,4 +55,14 @@ public static function serviceFactory(
 
         return $intuition;
     }
+
+    /**
+     * Get names of all registered domains.
+     *
+     * @return string[]
+     */
+    public function getDomains(): array
+    {
+        return array_keys($this->domainInfos);
+    }
 }

Twig/Extension.php

@@ -4,13 +4,13 @@
 
 namespace Wikimedia\ToolforgeBundle\Twig;
 
-use Krinkle\Intuition\Intuition;
 use NumberFormatter;
 use Symfony\Component\HttpFoundation\Session\Session;
 use Symfony\Component\Process\Process;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFilter;
 use Twig\TwigFunction;
+use Wikimedia\ToolforgeBundle\Service\Intuition;
 
 class Extension extends AbstractExtension
 {
@@ -86,35 +86,46 @@ public function msgIfExists(string $message = '', array $vars = [])
         return $message;
     }
 
-
     /**
      * See if a given i18n message exists.
      * If this returns false it means msg() would return "[message-key]"
-     * Parameters the same as msg(), except $fail which is overwritten.
+     *
      * @param string $message The message.
      * @param string[] $vars
      * @return bool
      */
     public function msgExists(string $message = '', array $vars = []): bool
     {
-        return $this->intuition->msgExists($message, [
-            'domain' => $this->domain,
-            'variables' => is_array($vars) ? $vars : [],
-        ]);
+        foreach ($this->intuition->getDomains() as $domain) {
+            $exists = $this->intuition->msgExists($message, [
+                'domain' => $domain,
+                'variables' => is_array($vars) ? $vars : [],
+            ]);
+            if ($exists) {
+                return true;
+            }
+        }
+        return false;
     }
 
     /**
-     * Get an i18n message.
+     * Get an i18n message, searching all registered domains.
      * @param string $message
      * @param string[] $vars
      * @return mixed|null|string
      */
     public function msg(string $message = '', array $vars = [])
     {
-        return $this->intuition->msg($message, [
-            'domain' => $this->domain,
-            'variables' => $vars,
-        ]);
+        // Check all domains for this message.
+        foreach ($this->intuition->getDomains() as $domain) {
+            if ($this->intuition->msgExists($message, ['domain' => $domain])) {
+                return $this->intuition->msg($message, [
+                    'domain' => $domain,
+                    'variables' => $vars,
+                ]);
+            }
+        }
+        return $this->intuition->bracketMsg($message);
     }
 
     /**