Merge pull request #3 from siebdc2/master

PHP 8.1 compatibility
phpro · May 19, 2022 · d3c47a3 · d3c47a3
2 parents ce17637 + 483bdce
commit d3c47a3
Show file tree

Hide file tree

Showing 51 changed files with 343 additions and 81 deletions.
diff --git a/.github/workflows/grumphp.yml b/.github/workflows/grumphp.yml
@@ -8,7 +8,6 @@ jobs:
       fail-fast: true
       matrix:
         php-versions:
-          - "7.3"
           - "7.4"
           - "8.1"
         dependencies:

diff --git a/.php_cs → .php-cs-fixer.php b/.php_cs → .php-cs-fixer.php
@@ -2,14 +2,14 @@
 /**
  * PHP Coding Standards fixer configuration
  */
-use PhpCsFixer\Config;
-use PhpCsFixer\Finder;
 
-$finder = Finder::create()
+$finder = PhpCsFixer\Finder::create()
     ->in('./')
     ->name(['*.php']);
 
-return Config::create()
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
+    ->setUsingCache(false)
     ->setRules([
         '@PSR2' => true,
         'no_useless_else' => true,
@@ -40,7 +40,5 @@
         'compact_nullable_typehint' => true,
         'fully_qualified_strict_types' => true,
     ])
-    ->setFinder($finder)
-    ->setRiskyAllowed(true)
-    ->setUsingCache(false);
+    ->setFinder($finder);
 
diff --git a/Api/Data/TranslationInterface.php b/Api/Data/TranslationInterface.php
@@ -5,11 +5,11 @@
 
 interface TranslationInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
-    const STRING = 'string';
-    const LOCALE = 'locale';
-    const TRANSLATE = 'translate';
-    const FRONTEND = 'frontend';
-    const KEY_ID = 'key_id';
+    public const STRING = 'string';
+    public const LOCALE = 'locale';
+    public const TRANSLATE = 'translate';
+    public const FRONTEND = 'frontend';
+    public const KEY_ID = 'key_id';
 
     /**
      * @return int|null
@@ -68,12 +68,14 @@ public function setFrontend($frontend);
 
     /**
      * Retrieve existing extension attributes object or create a new one.
+     *
      * @return \Phpro\Translations\Api\Data\TranslationExtensionInterface|null
      */
     public function getExtensionAttributes();
 
     /**
      * Set an extension attributes object.
+     *
      * @param \Phpro\Translations\Api\Data\TranslationExtensionInterface $extensionAttributes
      * @return $this
      */

diff --git a/Api/Data/TranslationSearchResultsInterface.php b/Api/Data/TranslationSearchResultsInterface.php
@@ -8,12 +8,14 @@ interface TranslationSearchResultsInterface extends \Magento\Framework\Api\Searc
 
     /**
      * Get Translation list.
+     *
      * @return \Phpro\Translations\Api\Data\TranslationInterface[]
      */
     public function getItems();
 
     /**
      * Set translate list.
+     *
      * @param \Phpro\Translations\Api\Data\TranslationInterface[] $items
      * @return $this
      */

diff --git a/Api/ExportManagementInterface.php b/Api/ExportManagementInterface.php
@@ -7,5 +7,11 @@
 
 interface ExportManagementInterface
 {
+    /**
+     * Export function
+     *
+     * @param array|null $locale
+     * @return ExportStats
+     */
     public function export(?array $locale): ExportStats;
 }
diff --git a/Api/ImportManagementInterface.php b/Api/ImportManagementInterface.php
@@ -9,6 +9,7 @@ interface ImportManagementInterface
 {
     /**
      * Import Magento translation CSV to the database.
+     *
      * Example structure: "Foo","Foo value",module,Magento_Catalog
      *
      * @param string $filePath
@@ -20,6 +21,7 @@ public function importMagentoCsv(string $filePath, string $locale): ImportStats;
 
     /**
      * Import translation CSV (based on export) to the database.
+     *
      * Example structure: "Bar","Bar value",en_US
      *
      * @param string $filePath

diff --git a/Api/TranslationDataManagementInterface.php b/Api/TranslationDataManagementInterface.php
@@ -7,6 +7,7 @@ interface TranslationDataManagementInterface
 {
     /**
      * Add the translation key for all enabled locales of the Magento instance.
+     *
      * If default translation is not set, the translation key will be used as default translation.
      *
      * @param string $translationKey
@@ -25,6 +26,7 @@ public function create(string $translationKey, string $translationValue, array $
 
     /**
      * Delete a translation for given translation key and locale(s).
+     *
      * In case no locales are given, all enabled locales will be used.
      *
      * @param string $translationKey

diff --git a/Api/TranslationRepositoryInterface.php b/Api/TranslationRepositoryInterface.php
@@ -10,6 +10,7 @@ interface TranslationRepositoryInterface
 
     /**
      * Save Translation
+     *
      * @param \Phpro\Translations\Api\Data\TranslationInterface $translation
      * @throws \Magento\Framework\Exception\LocalizedException
      * @return \Phpro\Translations\Api\Data\TranslationInterface
@@ -20,6 +21,7 @@ public function save(
 
     /**
      * Retrieve Translation
+     *
      * @param string $translationId
      * @throws \Magento\Framework\Exception\LocalizedException
      * @return \Phpro\Translations\Api\Data\TranslationInterface
@@ -28,6 +30,7 @@ public function getById($translationId);
 
     /**
      * Retrieve Translation matching the specified criteria.
+     *
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @throws \Magento\Framework\Exception\LocalizedException
      * @return \Phpro\Translations\Api\Data\TranslationSearchResultsInterface
@@ -38,6 +41,7 @@ public function getList(
 
     /**
      * Delete translation by given key and locales.
+     *
      * @param string $translationKey
      * @param array $locales
      * @return bool true on success
@@ -46,6 +50,7 @@ public function deleteByTranslationKeyAndLocales(string $translationKey, array $
 
     /**
      * Delete Translation by ID
+     *
      * @param string $translationId
      * @throws \Magento\Framework\Exception\NoSuchEntityException
      * @throws \Magento\Framework\Exception\LocalizedException

diff --git a/Block/Adminhtml/Translation/Edit/BackButton.php b/Block/Adminhtml/Translation/Edit/BackButton.php
@@ -9,6 +9,8 @@ class BackButton extends GenericButton implements ButtonProviderInterface
 {
 
     /**
+     * Get data for back (reset) button
+     *
      * @return array
      */
     public function getButtonData()

diff --git a/Block/Adminhtml/Translation/Edit/DeleteButton.php b/Block/Adminhtml/Translation/Edit/DeleteButton.php
@@ -9,6 +9,8 @@ class DeleteButton extends GenericButton implements ButtonProviderInterface
 {
 
     /**
+     * Get data for back (reset) button
+     *
      * @return array
      */
     public function getButtonData()

diff --git a/Block/Adminhtml/Translation/Edit/GenericButton.php b/Block/Adminhtml/Translation/Edit/GenericButton.php
@@ -7,6 +7,9 @@
 
 abstract class GenericButton
 {
+    /**
+     * @var Context
+     */
     protected $context;
 
     /**

diff --git a/Block/Adminhtml/Translation/Edit/SaveAndContinueButton.php b/Block/Adminhtml/Translation/Edit/SaveAndContinueButton.php
@@ -9,6 +9,8 @@ class SaveAndContinueButton extends GenericButton implements ButtonProviderInter
 {
 
     /**
+     * Get data for back (reset) button
+     *
      * @return array
      */
     public function getButtonData()

diff --git a/Block/Adminhtml/Translation/Edit/SaveButton.php b/Block/Adminhtml/Translation/Edit/SaveButton.php
@@ -9,6 +9,8 @@ class SaveButton extends GenericButton implements ButtonProviderInterface
 {
 
     /**
+     * Get data for back (reset) button
+     *
      * @return array
      */
     public function getButtonData()

diff --git a/Block/Adminhtml/Translation/GenerateJson/SaveButton.php b/Block/Adminhtml/Translation/GenerateJson/SaveButton.php
@@ -10,6 +10,8 @@ class SaveButton extends GenericButton implements ButtonProviderInterface
 {
 
     /**
+     * Get data for back (reset) button
+     *
      * @return array
      */
     public function getButtonData()

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,4 +10,4 @@
 
 ## [1.1.0] - 2022-05-18
 ### Added
-- PHP 8.0 compatibility
+- PHP 8.1 compatibility
diff --git a/Console/Command/Export.php b/Console/Command/Export.php
@@ -11,8 +11,8 @@
 
 class Export extends Command
 {
-    const COMMAND_NAME = 'phpro:translations:export';
-    const ARGUMENT_LOCALES = 'locales';
+    private const COMMAND_NAME = 'phpro:translations:export';
+    private const ARGUMENT_LOCALES = 'locales';
 
     /**
      * @var ExportManagementInterface
@@ -26,6 +26,9 @@ public function __construct(
         parent::__construct();
     }
 
+    /**
+     * Configure export command
+     */
     protected function configure(): void
     {
         $this->setName(self::COMMAND_NAME);
@@ -35,6 +38,10 @@ protected function configure(): void
         parent::configure();
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
     protected function execute(InputInterface $input, OutputInterface $output): void
     {
         try {

diff --git a/Console/Command/GenerateFrontendTranslations.php b/Console/Command/GenerateFrontendTranslations.php
@@ -13,8 +13,11 @@
 
 class GenerateFrontendTranslations extends Command
 {
-    const COMMAND_NAME = 'phpro:translations:generate-frontend-translations';
+    private const COMMAND_NAME = 'phpro:translations:generate-frontend-translations';
 
+    /**
+     * @var InlineTranslationsGenerator
+     */
     private $inlineTranslationsGenerator;
 
     public function __construct(
@@ -24,6 +27,9 @@ public function __construct(
         parent::__construct();
     }
 
+    /**
+     * Configure frontend translations command
+     */
     protected function configure(): void
     {
         $this->setName(self::COMMAND_NAME);
@@ -32,6 +38,10 @@ protected function configure(): void
         parent::configure();
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
     protected function execute(InputInterface $input, OutputInterface $output): void
     {
         try {
@@ -55,6 +65,10 @@ protected function execute(InputInterface $input, OutputInterface $output): void
         }
     }
 
+    /**
+     * @param int $storeId
+     * @return InlineGenerateStatsCollection
+     */
     private function generatedTranslations(int $storeId): InlineGenerateStatsCollection
     {
         if (0 === $storeId) {

diff --git a/Console/Command/Import.php b/Console/Command/Import.php
@@ -13,15 +13,16 @@
 
 class Import extends Command
 {
-    const COMMAND_NAME = 'phpro:translations:import';
-    const ARGUMENT_CSV_FILE = 'csvfile';
-    const ARGUMENT_LOCALE = 'locale';
-    const OPTION_CLEAR_CACHE = 'clear-cache';
+    private const COMMAND_NAME = 'phpro:translations:import';
+    private const ARGUMENT_CSV_FILE = 'csvfile';
+    private const ARGUMENT_LOCALE = 'locale';
+    private const OPTION_CLEAR_CACHE = 'clear-cache';
 
     /**
      * @var ImportManagementInterface
      */
     private $importer;
+
     /**
      * @var Manager
      */
@@ -36,6 +37,9 @@ public function __construct(
         parent::__construct();
     }
 
+    /**
+     * Configure import command
+     */
     protected function configure(): void
     {
         $this->setName(self::COMMAND_NAME);
@@ -47,6 +51,10 @@ protected function configure(): void
         parent::configure();
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
     protected function execute(InputInterface $input, OutputInterface $output): void
     {
         try {

diff --git a/Console/Command/ImportFull.php b/Console/Command/ImportFull.php
@@ -13,14 +13,15 @@
 
 class ImportFull extends Command
 {
-    const COMMAND_NAME = 'phpro:translations:import-full';
-    const ARGUMENT_CSV_FILE = 'csvfile';
-    const OPTION_CLEAR_CACHE = 'clear-cache';
+    private const COMMAND_NAME = 'phpro:translations:import-full';
+    private const ARGUMENT_CSV_FILE = 'csvfile';
+    private const OPTION_CLEAR_CACHE = 'clear-cache';
 
     /**
      * @var ImportManagementInterface
      */
     private $importer;
+
     /**
      * @var Manager
      */
@@ -35,6 +36,9 @@ public function __construct(
         parent::__construct();
     }
 
+    /**
+     * Configure import full command
+     */
     protected function configure(): void
     {
         $this->setName(self::COMMAND_NAME);
@@ -45,6 +49,10 @@ protected function configure(): void
         parent::configure();
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
     protected function execute(InputInterface $input, OutputInterface $output): void
     {
         try {

diff --git a/Controller/Adminhtml/Translation.php b/Controller/Adminhtml/Translation.php
@@ -8,7 +8,7 @@
 
 abstract class Translation extends Action
 {
-    const ADMIN_RESOURCE = 'Phpro_Translations::translations';
+    public const ADMIN_RESOURCE = 'Phpro_Translations::translations';
 
     /**
      * Init page
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,6 @@ jobs: @@
           fail-fast: true
           matrix:
             php-versions:
-              - "7.3"
               - "7.4"
               - "8.1"
             dependencies:
@@ Expand Down @@