Update for Flarum beta 16

composer.json

@@ -29,8 +29,8 @@
         }
     ],
     "require": {
-        "flarum/core": ">=0.1.0-beta.15 <0.1.0-beta.16",
-        "symfony/yaml": "^4.0"
+        "flarum/core": ">=0.1.0-beta.16 <0.1.0-beta.17",
+        "symfony/yaml": "^5.0"
     },
     "replace": {
         "flagrow/linguist": "*"

extend.php

@@ -3,8 +3,7 @@
 namespace FoF\Linguist;
 
 use Flarum\Extend;
-use FoF\Linguist\Extenders\ClearCacheStatus;
-use FoF\Linguist\Extenders\LoadStrings;
+use Flarum\Foundation\Event\ClearingCache;
 use FoF\Linguist\Api\Controllers;
 
 return [
@@ -20,6 +19,10 @@
         ->delete('/fof/linguist/strings/{id:[0-9]+}', 'fof.linguist.api.strings.delete', Controllers\StringDeleteController::class)
         ->get('/fof/linguist/export', 'fof.linguist.api.export', Controllers\ExportController::class)
         ->post('/fof/linguist/import', 'fof.linguist.api.import', Controllers\ImportController::class),
-    new ClearCacheStatus(),
-    new LoadStrings(),
+
+    (new Extend\ServiceProvider())
+        ->register(Providers\LoadStrings::class),
+
+    (new Extend\Event())
+        ->listen(ClearingCache::class, Listeners\ClearCacheStatus::class),
 ];

js/package.json

@@ -9,5 +9,8 @@
     "scripts": {
         "dev": "webpack --mode development --watch",
         "build": "webpack --mode production"
+    },
+    "devDependencies": {
+        "flarum": "0.1.0-beta.16"
     }
 }

js/src/admin/components/StringLocale.js

@@ -1,6 +1,6 @@
 import app from 'flarum/app';
-import ItemList from 'flarum/utils/ItemList';
-import Button from 'flarum/components/Button';
+import ItemList from 'flarum/common/utils/ItemList';
+import Button from 'flarum/common/components/Button';
 import highlightMithril from '../utils/highlightMithril';
 
 /* global m */

js/src/admin/models/StringKey.js

@@ -1,4 +1,4 @@
-import Model from 'flarum/Model';
+import Model from 'flarum/common/Model';
 
 export default class StringKey extends Model {
     key = Model.attribute('key');

js/src/admin/models/TextString.js

@@ -1,4 +1,4 @@
-import Model from 'flarum/Model';
+import Model from 'flarum/common/Model';
 
 export default class TextString extends Model {
     key = Model.attribute('key');

js/src/admin/pages/CoveragePage.js

@@ -1,6 +1,6 @@
 import app from 'flarum/app';
-import Button from 'flarum/components/Button';
-import icon from 'flarum/helpers/icon';
+import Button from 'flarum/common/components/Button';
+import icon from 'flarum/common/helpers/icon';
 import localesAsArray from '../utils/localesAsArray';
 import namespaceLabel from '../utils/namespaceLabel';
 import frontendLabel from '../utils/frontendLabel';

js/src/admin/pages/ExportPage.js

@@ -1,7 +1,7 @@
 import app from 'flarum/app';
-import Select from 'flarum/components/Select';
-import Switch from 'flarum/components/Switch';
-import LinkButton from 'flarum/components/LinkButton';
+import Select from 'flarum/common/components/Select';
+import Switch from 'flarum/common/components/Switch';
+import LinkButton from 'flarum/common/components/LinkButton';
 import localesAsArray from '../utils/localesAsArray';
 import namespaceLabel from '../utils/namespaceLabel';
 

js/src/admin/pages/ImportPage.js

@@ -1,8 +1,8 @@
 import app from 'flarum/app';
-import Button from 'flarum/components/Button';
-import Select from 'flarum/components/Select';
-import Switch from 'flarum/components/Switch';
-import extractText from 'flarum/utils/extractText';
+import Button from 'flarum/common/components/Button';
+import Select from 'flarum/common/components/Select';
+import Switch from 'flarum/common/components/Switch';
+import extractText from 'flarum/common/utils/extractText';
 import localesAsArray from '../utils/localesAsArray';
 
 /* global m */

js/src/admin/pages/LinguistPage.js

@@ -1,6 +1,6 @@
 import app from 'flarum/app';
-import ExtensionPage from 'flarum/components/ExtensionPage';
-import LoadingIndicator from 'flarum/components/LoadingIndicator';
+import ExtensionPage from 'flarum/admin/components/ExtensionPage';
+import LoadingIndicator from 'flarum/common/components/LoadingIndicator';
 import StringsPage from './StringsPage';
 import CoveragePage from './CoveragePage';
 import ExportPage from './ExportPage';

js/src/admin/pages/StringsPage.js

@@ -1,10 +1,10 @@
 import app from 'flarum/app';
-import Button from 'flarum/components/Button';
-import Dropdown from 'flarum/components/Dropdown';
-import Select from 'flarum/components/Select';
-import Alert from 'flarum/components/Alert';
-import LoadingModal from 'flarum/components/LoadingModal';
-import extractText from 'flarum/utils/extractText';
+import Button from 'flarum/common/components/Button';
+import Dropdown from 'flarum/common/components/Dropdown';
+import Select from 'flarum/common/components/Select';
+import Alert from 'flarum/common/components/Alert';
+import LoadingModal from 'flarum/admin/components/LoadingModal';
+import extractText from 'flarum/common/utils/extractText';
 import localesAsArray from '../utils/localesAsArray';
 import StringKey from '../components/StringKey';
 import namespaceLabel from '../utils/namespaceLabel';

resources/less/admin/page.less

@@ -30,6 +30,9 @@
     }
 
     .ExtensionPage-settings {
+        // So the dropdowns don't go out of stream on pages with no results
+        min-height: 400px;
+
         // Allow horizontal scrolling for the table in coverage tab
         overflow-x: auto;
 

src/Api/Controllers/ExportController.php

@@ -2,18 +2,25 @@
 
 namespace FoF\Linguist\Api\Controllers;
 
+use Flarum\Locale\Translator;
 use FoF\Linguist\TextString;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use Laminas\Diactoros\Response\TextResponse;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
-use Symfony\Component\Translation\MessageCatalogueInterface;
 use Symfony\Component\Yaml\Yaml;
 
 class ExportController implements RequestHandlerInterface
 {
+    protected $translator;
+
+    public function __construct(Translator $translator)
+    {
+        $this->translator = $translator;
+    }
+
     public function handle(ServerRequestInterface $request): ResponseInterface
     {
         $request->getAttribute('actor')->assertAdmin();
@@ -49,10 +56,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface
         }
 
         if (Arr::get($request->getQueryParams(), 'includeOriginals') && $locale !== null) {
-            /**
-             * @var MessageCatalogueInterface $catalogue
-             */
-            $catalogue = app('translator')->getCatalogue($locale);
+            $catalogue = $this->translator->getCatalogue($locale);
 
             $originals = $catalogue->all('messages');
 

src/Api/Controllers/StringKeyIndexController.php

@@ -12,15 +12,17 @@ class StringKeyIndexController extends AbstractListController
 {
     public $serializer = StringKeySerializer::class;
 
+    protected $repository;
+
+    public function __construct(DefaultStringsRepository $repository)
+    {
+        $this->repository = $repository;
+    }
+
     protected function data(ServerRequestInterface $request, Document $document)
     {
         $request->getAttribute('actor')->assertAdmin();
 
-        /**
-         * @var $repository DefaultStringsRepository
-         */
-        $repository = app(DefaultStringsRepository::class);
-
-        return $repository->allTranslations();
+        return $this->repository->allTranslations();
     }
 }

src/Listeners/ClearCacheStatus.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace FoF\Linguist\Listeners;
+
+use Flarum\Foundation\Event\ClearingCache;
+use Flarum\Settings\SettingsRepositoryInterface;
+
+class ClearCacheStatus
+{
+    protected $settings;
+
+    public function __construct(SettingsRepositoryInterface $settings)
+    {
+        $this->settings = $settings;
+    }
+
+    public function handle(ClearingCache $event)
+    {
+        // When the cache has been cleared, either from Linguist tab or anywhere else, we remove our flag
+        $this->settings->delete('fof.linguist.should-clear-cache');
+    }
+}

src/Extenders/LoadStrings.php → src/Providers/LoadStrings.php

@@ -1,25 +1,23 @@
 <?php
 
-namespace FoF\Linguist\Extenders;
+namespace FoF\Linguist\Providers;
 
-use Flarum\Extend\ExtenderInterface;
-use Flarum\Extension\Extension;
+use Flarum\Foundation\AbstractServiceProvider;
 use Flarum\Locale\LocaleManager;
 use FoF\Linguist\Translator\StringLoader;
-use Illuminate\Contracts\Container\Container;
 
-class LoadStrings implements ExtenderInterface
+class LoadStrings extends AbstractServiceProvider
 {
-    public function extend(Container $container, Extension $extension = null)
+    public function register()
     {
         // Other extensions register their translations via `resolving()`, so we need to use `afterResolving()`
         // to put our custom loader at the end to be able to override all translations
-        $container->afterResolving(
+        $this->container->afterResolving(
             LocaleManager::class,
             function (LocaleManager $locales) {
                 $translator = $locales->getTranslator();
 
-                $translator->addLoader('fof_linguist', app(StringLoader::class));
+                $translator->addLoader('fof_linguist', $this->container->make(StringLoader::class));
 
                 // Add the custom loader to every language available in Flarum
                 foreach ($locales->getLocales() as $locale => $name) {

src/Repositories/DefaultStringsRepository.php

@@ -13,21 +13,18 @@ class DefaultStringsRepository
 {
     protected $settings;
     protected $events;
+    protected $manager;
 
-    public function __construct(SettingsRepositoryInterface $settings, Dispatcher $events)
+    public function __construct(SettingsRepositoryInterface $settings, Dispatcher $events, LocaleManager $manager)
     {
         $this->settings = $settings;
         $this->events = $events;
+        $this->manager = $manager;
     }
 
     public function allTranslations()
     {
-        /**
-         * @var $manager LocaleManager
-         */
-        $manager = app(LocaleManager::class);
-
-        $translator = $manager->getTranslator();
+        $translator = $this->manager->getTranslator();
 
         // Use our own cache factory that will force a fresh catalog load and not write it to file.
         // This allows us to get fresh original strings without the Linguist-defined ones without
@@ -41,7 +38,7 @@ public function allTranslations()
         // We disable our own translation loader so custom strings don't replace original ones
         TranslationLock::stopLoadingTranslations();
 
-        foreach (array_keys($manager->getLocales()) as $locale) {
+        foreach (array_keys($this->manager->getLocales()) as $locale) {
             foreach (Arr::get($translator->getCatalogue($locale)->all(), 'messages', []) as $key => $string) {
                 if (!Arr::has($translations, $key)) {
                     $translations[$key] = [