Add translator (#257)

Author: xepozz

.github/workflows/build.yml

@@ -31,7 +31,7 @@ jobs:
     name: PHP ${{ matrix.php }}-${{ matrix.os }}
 
     env:
-      extensions: fileinfo
+      extensions: fileinfo, intl
       key: cache-v1
       YII_C3: true
 

composer.json

@@ -22,6 +22,7 @@
     },
     "require": {
         "php": "^8.0",
+        "ext-intl": "*",
         "httpsoft/http-message": "^1.0.5",
         "psr/container": "^2.0",
         "psr/http-message": "^1.0",
@@ -47,11 +48,15 @@
         "yiisoft/log-target-file": "^2.0",
         "yiisoft/router": "^1.2",
         "yiisoft/router-fastroute": "^1.1",
+        "yiisoft/translator": "^1.1",
+        "yiisoft/translator-formatter-intl": "^1.0",
+        "yiisoft/translator-message-php": "^1.0",
         "yiisoft/view": "^6.0",
         "yiisoft/yii-console": "^1.3",
         "yiisoft/yii-debug": "^3.0@dev",
         "yiisoft/yii-event": "^1.0",
         "yiisoft/yii-http": "^1.0",
+        "yiisoft/yii-middleware": "dev-master",
         "yiisoft/yii-runner-console": "^1.0",
         "yiisoft/yii-runner-http": "^1.0",
         "yiisoft/yii-view": "^5.0"

config/common/i18n.php

@@ -4,6 +4,8 @@
 
 use Yiisoft\I18n\Locale;
 
+/** @var $params array */
+
 return [
     Locale::class => [
         'class' => Locale::class,

config/common/router.php

@@ -18,7 +18,7 @@
             ->middleware(CsrfMiddleware::class)
             ->middleware(FormatDataResponse::class)
             ->addGroup(
-                Group::create(null)
+                Group::create('/{_language}')
                     ->routes(...$config->get('routes'))
             );
 

config/common/translator.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use Yiisoft\Aliases\Aliases;
+use Yiisoft\Translator\CategorySource;
+use Yiisoft\Translator\Formatter\Intl\IntlMessageFormatter;
+use Yiisoft\Translator\Message\Php\MessageSource;
+
+/** @var array $params */
+
+return [
+    // Configure application CategorySource
+    'translation.app' => static function (Aliases $aliases) use ($params) {
+        return new CategorySource(
+            $params['yiisoft/translator']['defaultCategory'],
+            new MessageSource($aliases->get('@messages')),
+            new IntlMessageFormatter(),
+        );
+    },
+];

config/params.php

@@ -5,10 +5,12 @@
 use App\Command\Hello;
 use App\ViewInjection\CommonViewInjection;
 use App\ViewInjection\LayoutViewInjection;
+use App\ViewInjection\TranslatorViewInjection;
 use Yiisoft\Definitions\Reference;
 use Yiisoft\ErrorHandler\Middleware\ErrorCatcher;
 use Yiisoft\Router\Middleware\Router;
 use Yiisoft\Session\SessionMiddleware;
+use Yiisoft\Yii\Middleware\Locale;
 use Yiisoft\Yii\View\CsrfViewInjection;
 
 return [
@@ -17,9 +19,16 @@
         'locale' => 'en',
         'name' => 'My Project',
     ],
+    'locale' => [
+        'locales' => ['en' => 'en-US', 'ru' => 'ru-RU'],
+        'ignoredRequests' => [
+            '/debug**',
+        ],
+    ],
     'middlewares' => [
         ErrorCatcher::class,
         SessionMiddleware::class,
+        Locale::class,
         Router::class,
     ],
 
@@ -29,7 +38,7 @@
             '@assets' => '@root/public/assets',
             '@assetsUrl' => '@baseUrl/assets',
             '@baseUrl' => '/',
-            '@message' => '@root/resources/message',
+            '@messages' => '@resources/messages',
             '@npm' => '@root/node_modules',
             '@public' => '@root/public',
             '@resources' => '@root/resources',
@@ -40,11 +49,23 @@
         ],
     ],
 
+    'yiisoft/translator' => [
+        'locale' => 'en',
+        'fallbackLocale' => 'en',
+        'defaultCategory' => 'app',
+        'categorySources' => [
+            // You can add categories from your application and additional modules using `Reference::to` below
+            // Reference::to(ApplicationCategorySource::class),
+            Reference::to('translation.app'),
+        ],
+    ],
+
     'yiisoft/yii-view' => [
         'injections' => [
             Reference::to(CommonViewInjection::class),
             Reference::to(CsrfViewInjection::class),
             Reference::to(LayoutViewInjection::class),
+            Reference::to(TranslatorViewInjection::class),
         ],
     ],
 

config/web/application.php

@@ -20,4 +20,11 @@
             'fallbackHandler' => Reference::to(NotFoundHandler::class),
         ],
     ],
+    \Yiisoft\Yii\Middleware\Locale::class => [
+        '__construct()' => [
+            'locales' => $params['locale']['locales'],
+            'ignoredRequests' => $params['locale']['ignoredRequests'],
+        ],
+        'withEnableSaveLocale()' => [false],
+    ],
 ];

resources/message/en-US/app.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'site.hello' => 'Hello',
+    'site.start_with' => 'Let\'s start something great with <strong>Yii3</strong>',
+    'site.guide_remind' => 'Don\'t forget to check the guide',
+];

resources/messages/en/app.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'site.hello' => 'Привет',
+    'site.start_with' => 'Давайте создадим что-нибудь при помощи <strong>Yii3</strong>',
+    'site.guide_remind' => 'Не забудьте просмотреть инструкцию',
+];

resources/messages/ru/app.php

@@ -3,21 +3,26 @@
 declare(strict_types=1);
 
 /**
- * @var \Yiisoft\View\WebView $this
- * @var \App\ApplicationParameters $applicationParameters
+ * @var WebView $this
+ * @var TranslatorInterface $translator
+ * @var ApplicationParameters $applicationParameters
  */
 
+use App\ApplicationParameters;
+use Yiisoft\Translator\TranslatorInterface;
+use Yiisoft\View\WebView;
+
 $this->setTitle($applicationParameters->getName());
 ?>
 
 <div class="text-center">
-    <h1>Hello!</h1>
+    <h1><?= $translator->translate('site.hello')?>!</h1>
 
-    <p>Let's start something great with <strong>Yii3</strong>!</p>
+    <p><?= $translator->translate('site.start_with')?>!</p>
 
     <p>
         <a href="https://github.com/yiisoft/docs/tree/master/guide/en" target="_blank" rel="noopener">
-            <i>Don't forget to check the guide.</i>
+            <i><?= $translator->translate('site.guide_remind')?>.</i>
         </a>
     </p>
 </div>

resources/views/site/index.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\ViewInjection;
+
+use Yiisoft\Translator\TranslatorInterface;
+use Yiisoft\Yii\View\CommonParametersInjectionInterface;
+
+final class TranslatorViewInjection implements CommonParametersInjectionInterface
+{
+    public function __construct(private TranslatorInterface $translator)
+    {
+    }
+
+    public function getCommonParameters(): array
+    {
+        return [
+            'translator' => $this->translator,
+        ];
+    }
+}

src/ViewInjection/TranslatorViewInjection.php

@@ -15,4 +15,12 @@ public function testIndexPage(AcceptanceTester $I): void
         $I->expectTo('see page home.');
         $I->see('Hello!');
     }
+
+    public function testIndexPageRu(AcceptanceTester $I): void
+    {
+        $I->wantTo('home page works.');
+        $I->amOnPage('/ru/');
+        $I->expectTo('see page home.');
+        $I->see('Привет!');
+    }
 }

tests/Acceptance/HomeCest.php

@@ -13,7 +13,7 @@ public function about(AcceptanceTester $I): void
         $I->amOnPage('/about');
         $I->wantTo('see about page.');
         $I->see('404');
-        $I->see('The page /about not found.');
+        $I->see('The page /en/about not found.');
         $I->see('The above error occurred while the Web server was processing your request.');
         $I->see('Please contact us if you think this is a server error. Thank you.');
     }
@@ -23,7 +23,7 @@ public function aboutReturnHome(AcceptanceTester $I): void
         $I->amOnPage('/about');
         $I->wantTo('see about page.');
         $I->see('404');
-        $I->see('The page /about not found.');
+        $I->see('The page /en/about not found.');
         $I->see('The above error occurred while the Web server was processing your request.');
         $I->see('Please contact us if you think this is a server error. Thank you.');
         $I->click('Go Back Home');