Removes deprecated class Piwik\Translate (matomo-org#15586)

* Removes deprecated class Piwik\Translate * use submodule branches * adjust test * fix typo * readd deprecated Piwik\Translate * submodule updates
alemonteiro · Feb 20, 2020 · fa23dc7 · fa23dc7
1 parent 361bc55
commit fa23dc7
Show file tree

Hide file tree

Showing 58 changed files with 151 additions and 138 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,7 @@ The Product Changelog at **[matomo.org/changelog](https://matomo.org/changelog)*
 * The deprecated Platform API class `\Piwik\Registry` has been removed. Use `\Piwik\Container\StaticContainer` instead
 * The deprecated Platform API class `\Piwik\TaskScheduler` has been removed. Use `\Piwik\Scheduler\Scheduler` instead
 * The deprecated Platform API class `\Piwik\DeviceDetectorFactory` has been removed. Use `\Piwik\DeviceDetector\DeviceDetectorFactory` instead
+* The deprecated Platform API class `\Piwik\Translate` has been removed. Use `\Piwik\Translation\Translator` instead.
 * The JavaScript tracker now uses `sendBeacon` by default if supported by the browser. You can disable this by calling the tracker method `disableAlwaysUseSendBeacon`. As a result, callback parameters won't work anymore and a tracking request might not appear in the developer tools.
 * The console option `--piwik-domain` has been removed. Use `--matomo-domain` instead
 * The core plugin `CustomPiwikJs` has been renamed to `CustomJsTracker`

diff --git a/core/AssetManager.php b/core/AssetManager.php
@@ -139,7 +139,7 @@ public function getCssInclusionDirective()
      */
     public function getJsInclusionDirective()
     {
-        $result = "<script type=\"text/javascript\">\n" . Translate::getJavascriptTranslations() . "\n</script>";
+        $result = "<script type=\"text/javascript\">\n" . StaticContainer::get('Piwik\Translation\Translator')->getJavascriptTranslations() . "\n</script>";
 
         if ($this->isMergedAssetsDisabled()) {
             $this->getMergedCoreJSAsset()->delete();

diff --git a/core/CacheId.php b/core/CacheId.php
@@ -8,13 +8,14 @@
  */
 namespace Piwik;
 
+use Piwik\Container\StaticContainer;
 use Piwik\Plugin\Manager;
 
 class CacheId
 {
     public static function languageAware($cacheId)
     {
-        return $cacheId . '-' . Translate::getLanguageLoaded();
+        return $cacheId . '-' . StaticContainer::get('Piwik\Translation\Translator')->getCurrentLanguage();
     }
 
     public static function pluginAware($cacheId)

diff --git a/core/Piwik.php b/core/Piwik.php
@@ -18,11 +18,6 @@
 use Piwik\Plugins\UsersManager\API as APIUsersManager;
 use Piwik\Translation\Translator;
 
-/**
- * @see core/Translate.php
- */
-require_once PIWIK_INCLUDE_PATH . '/core/Translate.php';
-
 /**
  * Main piwik helper class.
  *

diff --git a/core/Translate.php b/core/Translate.php
@@ -27,7 +27,8 @@ class Translate
      */
     public static function clean($s)
     {
-        return html_entity_decode(trim($s), ENT_QUOTES, 'UTF-8');
+        self::triggerDeprecationNotice();
+        return self::getTranslator()->clean($s);
     }
 
     /**
@@ -51,6 +52,7 @@ public static function unloadEnglishTranslation()
      */
     public static function reloadLanguage($language = false)
     {
+        self::triggerDeprecationNotice();
     }
 
     /**
@@ -61,6 +63,7 @@ public static function reloadLanguage($language = false)
      */
     public static function loadCoreTranslation($language = false)
     {
+        self::triggerDeprecationNotice();
         self::getTranslator()->addDirectory(PIWIK_INCLUDE_PATH . '/lang');
     }
 
@@ -69,6 +72,7 @@ public static function loadCoreTranslation($language = false)
      */
     public static function mergeTranslationArray($translation)
     {
+        self::triggerDeprecationNotice();
     }
 
     /**
@@ -77,12 +81,14 @@ public static function mergeTranslationArray($translation)
      */
     public static function getLanguageToLoad()
     {
+        self::triggerDeprecationNotice();
         return self::getTranslator()->getCurrentLanguage();
     }
 
     /** Reset the cached language to load. Used in tests. */
     public static function reset()
     {
+        self::triggerDeprecationNotice();
         self::getTranslator()->reset();
     }
 
@@ -92,11 +98,13 @@ public static function reset()
      */
     public static function getLanguageLoaded()
     {
+        self::triggerDeprecationNotice();
         return self::getTranslator()->getCurrentLanguage();
     }
 
     public static function getLanguageDefault()
     {
+        self::triggerDeprecationNotice();
         return self::getTranslator()->getDefaultLanguage();
     }
 
@@ -105,11 +113,13 @@ public static function getLanguageDefault()
      */
     public static function getJavascriptTranslations()
     {
+        self::triggerDeprecationNotice();
         return self::getTranslator()->getJavascriptTranslations();
     }
 
     public static function findTranslationKeyForTranslation($translation)
     {
+        self::triggerDeprecationNotice();
         return self::getTranslator()->findTranslationKeyForTranslation($translation);
     }
 
@@ -123,7 +133,15 @@ private static function getTranslator()
 
     public static function loadAllTranslations()
     {
+        self::triggerDeprecationNotice();
         self::loadCoreTranslation();
         Manager::getInstance()->loadPluginTranslations();
     }
+
+    protected static function triggerDeprecationNotice()
+    {
+        if (Development::isEnabled()) {
+            Log::warning('Using \Piwik\Translate is deprecated. Use \Piwik\Translation\Translator instead.');
+        }
+    }
 }
diff --git a/core/Translation/Translator.php b/core/Translation/Translator.php
@@ -60,6 +60,17 @@ public function __construct(LoaderInterface $loader, array $directories = null)
         $this->directories = $directories;
     }
 
+    /**
+     * Clean a string that may contain HTML special chars, single/double quotes, HTML entities, leading/trailing whitespace
+     *
+     * @param string $s
+     * @return string
+     */
+    public static function clean($s)
+    {
+        return html_entity_decode(trim($s), ENT_QUOTES, 'UTF-8');
+    }
+
     /**
      * Returns an internationalized string using a translation ID. If a translation
      * cannot be found for the ID, the ID is returned.

diff --git a/core/Twig.php b/core/Twig.php
@@ -240,7 +240,7 @@ protected function addFunction_getJavascriptTranslations()
     {
         $getJavascriptTranslations = new Twig_SimpleFunction(
             'getJavascriptTranslations',
-            array('Piwik\\Translate', 'getJavascriptTranslations')
+            array(StaticContainer::get('Piwik\Translation\Translator'), 'getJavascriptTranslations')
         );
         $this->twig->addFunction($getJavascriptTranslations);
     }

diff --git a/piwik.php b/piwik.php
@@ -46,7 +46,6 @@
 require_once PIWIK_INCLUDE_PATH . '/core/SettingsServer.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Tracker.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Config.php';
-require_once PIWIK_INCLUDE_PATH . '/core/Translate.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Tracker/Cache.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Tracker/Request.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Cookie.php';

diff --git a/plugins/Actions/tests/Unit/ArchiverTest.php b/plugins/Actions/tests/Unit/ArchiverTest.php
@@ -9,8 +9,8 @@
 namespace Piwik\Plugins\Actions\tests\Unit;
 
 use Piwik\Plugins\Actions\ArchivingHelper;
+use Piwik\Tests\Framework\Fixture;
 use Piwik\Tracker\Action;
-use Piwik\Translate;
 
 require_once PIWIK_INCLUDE_PATH . '/plugins/Actions/Actions.php';
 
@@ -23,12 +23,12 @@ class ArchiverTests extends \PHPUnit\Framework\TestCase
 {
     public function setUp()
     {
-        Translate::loadAllTranslations();
+        Fixture::loadAllTranslations();
     }
 
     public function tearDown()
     {
-        Translate::reset();
+        Fixture::resetTranslations();
     }
 
     public function getActionNameTestData()

diff --git a/plugins/Contents/tests/System/ContentsTest.php b/plugins/Contents/tests/System/ContentsTest.php
@@ -7,9 +7,9 @@
  */
 namespace Piwik\Plugins\Contents\tests\System;
 
+use Piwik\Tests\Framework\Fixture;
 use Piwik\Tests\Framework\TestCase\SystemTestCase;
 use Piwik\Plugins\Contents\tests\Fixtures\TwoVisitsWithContents;
-use Piwik\Translate;
 
 /**
  * Testing Contents
@@ -48,13 +48,13 @@ protected function getApiToCall()
     protected function setup()
     {
         parent::setup();
-        Translate::loadAllTranslations();
+        Fixture::loadAllTranslations();
     }
 
     protected function tearDown()
     {
         parent::tearDown();
-        Translate::reset();
+        Fixture::resetTranslations();
     }
 
     public function getApiForTesting()

diff --git a/plugins/CoreConsole/Commands/GenerateReport.php b/plugins/CoreConsole/Commands/GenerateReport.php
@@ -10,11 +10,10 @@
 namespace Piwik\Plugins\CoreConsole\Commands;
 
 use Piwik\Columns\Dimension;
+use Piwik\Container\StaticContainer;
 use Piwik\Piwik;
 use Piwik\Plugin\Manager;
-use Piwik\Plugin\Report;
 use Piwik\Plugin\ReportsProvider;
-use Piwik\Translate;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -210,7 +209,7 @@ protected function getCategory(InputInterface $input, OutputInterface $output, $
             $validate($category);
         }
 
-        $translationKey = Translate::findTranslationKeyForTranslation($category);
+        $translationKey = StaticContainer::get('Piwik\Translation\Translator')->findTranslationKeyForTranslation($category);
         if (!empty($translationKey)) {
             return $translationKey;
         }

diff --git a/plugins/CoreConsole/Commands/GenerateWidget.php b/plugins/CoreConsole/Commands/GenerateWidget.php
@@ -9,9 +9,9 @@
 
 namespace Piwik\Plugins\CoreConsole\Commands;
 
+use Piwik\Container\StaticContainer;
 use Piwik\Piwik;
 use Piwik\Plugin\Manager;
-use Piwik\Translate;
 use Piwik\Widget\WidgetsList;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -125,7 +125,7 @@ protected function getExistingCategories()
     /**
      * @param InputInterface $input
      * @param OutputInterface $output
-     * @return array
+     * @return string
      * @throws \RuntimeException
      */
     protected function getCategory(InputInterface $input, OutputInterface $output)
@@ -148,7 +148,7 @@ protected function getCategory(InputInterface $input, OutputInterface $output)
             $validate($category);
         }
 
-        $translationKey = Translate::findTranslationKeyForTranslation($category);
+        $translationKey = StaticContainer::get('Piwik\Translation\Translator')->findTranslationKeyForTranslation($category);
         if (!empty($translationKey)) {
             return $translationKey;
         }
@@ -161,7 +161,7 @@ protected function getCategory(InputInterface $input, OutputInterface $output)
     /**
      * @param InputInterface $input
      * @param OutputInterface $output
-     * @return array
+     * @return string
      * @throws \RuntimeException
      */
     protected function getPluginName(InputInterface $input, OutputInterface $output)

diff --git a/plugins/CoreVisualizations/tests/Integration/SparklinesConfigTest.php b/plugins/CoreVisualizations/tests/Integration/SparklinesConfigTest.php
@@ -12,7 +12,6 @@
 use Piwik\Tests\Framework\Fixture;
 use Piwik\Tests\Framework\Mock\FakeAccess;
 use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
-use Piwik\Translate;
 
 /**
  * @group CoreVisualizations
@@ -37,12 +36,12 @@ public function setUp()
 
         $this->config = new Config();
 
-        Translate::loadAllTranslations();
+        Fixture::loadAllTranslations();
     }
 
     public function tearDown()
     {
-        Translate::reset();
+        Fixture::resetTranslations();
 
         parent::tearDown();
     }

diff --git a/plugins/CustomAlerts b/plugins/CustomAlerts
diff --git a/plugins/CustomDimensions b/plugins/CustomDimensions
diff --git a/plugins/DeviceDetectorCache b/plugins/DeviceDetectorCache
diff --git a/plugins/Feedback/API.php b/plugins/Feedback/API.php
@@ -9,10 +9,10 @@
 namespace Piwik\Plugins\Feedback;
 use Piwik\Common;
 use Piwik\Config;
+use Piwik\Container\StaticContainer;
 use Piwik\IP;
 use Piwik\Mail;
 use Piwik\Piwik;
-use Piwik\Translate;
 use Piwik\Url;
 use Piwik\Version;
 
@@ -80,11 +80,13 @@ private function sendMail($subject, $body)
 
     private function getEnglishTranslationForFeatureName($featureName)
     {
-        if (Translate::getLanguageLoaded() == 'en') {
+        $translator = StaticContainer::get('Piwik\Translation\Translator');
+
+        if ($translator->getCurrentLanguage() == 'en') {
             return $featureName;
         }
 
-        $translationKeyForFeature = Translate::findTranslationKeyForTranslation($featureName);
+        $translationKeyForFeature = $translator->findTranslationKeyForTranslation($featureName);
 
         return Piwik::translate($translationKeyForFeature, array(), 'en');
     }

diff --git a/plugins/GeoIp2/tests/System/ConvertRegionCodesToIsoTest.php b/plugins/GeoIp2/tests/System/ConvertRegionCodesToIsoTest.php
@@ -14,7 +14,6 @@
 use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2;
 use Piwik\Tests\Framework\Fixture;
 use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
-use Piwik\Translate;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Tester\CommandTester;
 
@@ -126,7 +125,7 @@ public function testExecute_ShouldConvertRegionCodes()
         );
 
         // we need to manually reload the translations since they get reset for some reason in IntegrationTestCase::tearDown();
-        Translate::loadAllTranslations();
+        Fixture::loadAllTranslations();
 
         $this->assertApiResponseEqualsExpected("UserCountry.getRegion", $queryParams);
         $this->assertApiResponseEqualsExpected("UserCountry.getCountry", $queryParams);

diff --git a/plugins/ImageGraph/API.php b/plugins/ImageGraph/API.php
@@ -12,12 +12,12 @@
 use Piwik\API\Request;
 use Piwik\Archive\DataTableFactory;
 use Piwik\Common;
+use Piwik\Container\StaticContainer;
 use Piwik\DataTable\Map;
 use Piwik\Filesystem;
 use Piwik\Period;
 use Piwik\Piwik;
 use Piwik\SettingsServer;
-use Piwik\Translate;
 
 /**
  * The ImageGraph.get API call lets you generate beautiful static PNG Graphs for any existing Matomo report.
@@ -139,7 +139,7 @@ public function get(
         $useUnicodeFont = array(
             'am', 'ar', 'el', 'fa', 'fi', 'he', 'ja', 'ka', 'ko', 'te', 'th', 'zh-cn', 'zh-tw',
         );
-        $languageLoaded = Translate::getLanguageLoaded();
+        $languageLoaded = StaticContainer::get('Piwik\Translation\Translator')->getCurrentLanguage();
         $font = self::getFontPath(self::DEFAULT_FONT);
         if (in_array($languageLoaded, $useUnicodeFont)) {
             $unicodeFontPath = self::getFontPath(self::UNICODE_FONT);
+0 −2		Model.php
+3 −3		tests/Integration/ControllerTest.php
+3 −3		tests/Integration/NotifierTest.php
+1 −1		tests/Unit/DataTable/Filter/AddSegmentMetadataTest.php
+1 −1		tests/Unit/Dimension/ActiveTest.php
+1 −1		tests/Unit/Dimension/CaseSensitiveTest.php
+1 −1		tests/Unit/Dimension/ExtractionsTest.php
+3 −3		tests/Unit/Dimension/NameTest.php
+1 −1		tests/Unit/Dimension/ScopeTest.php