Merge branch 'drop-php70-support' into v1-develop

hostep · hostep · commit cb0b70254e72 · 2024-04-08T13:49:11.000+02:00
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -14,12 +14,11 @@
         'declare_strict_types'                             => true,
         'no_alias_functions'                               => true,
         'no_useless_sprintf'                               => true,
-        'nullable_type_declaration_for_default_null_value' => false, // should be 'true' when we drop support for PHP 7.0 which didn't support nullable types yet
+        'nullable_type_declaration_for_default_null_value' => true,
         'ordered_imports'                                  => ['sort_algorithm' => 'alpha'],
         'phpdoc_align'                                     => ['align' => 'vertical'],
         'phpdoc_separation'                                => ['skip_unlisted_annotations' => true],
         'self_accessor'                                    => true,
-        'visibility_required'                              => ['elements' => ['property', 'method']], // removed 'const' since we still support PHP 7.0 for now
     ])
     ->setFinder($finder)
 ;
diff --git a/Checker/Catalog/Category/UrlKey.php b/Checker/Catalog/Category/UrlKey.php
@@ -9,8 +9,8 @@
 
 class UrlKey
 {
-    const URL_KEY_ATTRIBUTE = 'url_key';
-    const STORAGE_IDENTIFIER = 'category-url-key';
+    public const URL_KEY_ATTRIBUTE = 'url_key';
+    public const STORAGE_IDENTIFIER = 'category-url-key';
 
     private $duplicateUrlKeyChecker;
     private $emptyUrlKeyChecker;
diff --git a/Checker/Catalog/Category/UrlKey/DuplicateUrlKey.php b/Checker/Catalog/Category/UrlKey/DuplicateUrlKey.php
@@ -10,7 +10,7 @@
 
 class DuplicateUrlKey
 {
-    const DUPLICATED_PROBLEM_DESCRIPTION =
+    public const DUPLICATED_PROBLEM_DESCRIPTION =
         '%s categories were found which have a duplicated url_key value: "%s" within the same parent.'
         . ' Please fix because this will cause problems.';
 
diff --git a/Checker/Catalog/Category/UrlKey/EmptyUrlKey.php b/Checker/Catalog/Category/UrlKey/EmptyUrlKey.php
@@ -15,7 +15,7 @@
 
 class EmptyUrlKey
 {
-    const EMPTY_PROBLEM_DESCRIPTION = 'Category has an empty url_key value. This needs to be fixed.';
+    public const EMPTY_PROBLEM_DESCRIPTION = 'Category has an empty url_key value. This needs to be fixed.';
 
     private $storesUtil;
     private $categoryCollectionFactory;
diff --git a/Checker/Catalog/Category/UrlPath.php b/Checker/Catalog/Category/UrlPath.php
@@ -15,12 +15,12 @@
 
 class UrlPath
 {
-    const URL_PATH_ATTRIBUTE = 'url_path';
-    const URL_PATH_SEPARATOR = '/';
-    const PROBLEM_DESCRIPTION =
+    public const URL_PATH_ATTRIBUTE = 'url_path';
+    public const URL_PATH_SEPARATOR = '/';
+    public const PROBLEM_DESCRIPTION =
         'Category has an incorrect url_path value "%s". It should be "%s".'
         . ' Unfortunately this is not easily fixable using the backend of Magento.';
-    const STORAGE_IDENTIFIER = 'category-url-path';
+    public const STORAGE_IDENTIFIER = 'category-url-path';
 
     private $storesUtil;
     private $categoryCollectionFactory;
@@ -164,7 +164,7 @@ public function getCalculatedUrlPathForCategory(Category $category, int $storeId
         ));
     }
 
-    private function fetchAllCategoriesWithUrlPathCalculatedByUrlKey()
+    private function fetchAllCategoriesWithUrlPathCalculatedByUrlKey(): void
     {
         $this->calculatedUrlPathPerCategoryAndStoreId = [];
 
diff --git a/Checker/Catalog/Product/UrlKey.php b/Checker/Catalog/Product/UrlKey.php
@@ -9,8 +9,8 @@
 
 class UrlKey
 {
-    const URL_KEY_ATTRIBUTE = 'url_key';
-    const STORAGE_IDENTIFIER = 'product-url-key';
+    public const URL_KEY_ATTRIBUTE = 'url_key';
+    public const STORAGE_IDENTIFIER = 'product-url-key';
 
     private $duplicateUrlKeyChecker;
     private $emptyUrlKeyChecker;
diff --git a/Checker/Catalog/Product/UrlKey/DuplicateUrlKey.php b/Checker/Catalog/Product/UrlKey/DuplicateUrlKey.php
@@ -18,7 +18,7 @@
 
 class DuplicateUrlKey
 {
-    const DUPLICATED_PROBLEM_DESCRIPTION =
+    public const DUPLICATED_PROBLEM_DESCRIPTION =
         'Product has a duplicated url_key value (%s). It\'s the same as another product (ID: %s, Store: %s).'
         . ' Please fix because this will cause problems.';
 
@@ -118,7 +118,7 @@ private function checkForDuplicatedUrlKeyAttributeValues(): array
     /**
      * @param ProductCollection<ProductModel> $collection
      */
-    private function storeProductUrlKeyData(int $storeId, ProductCollection $collection)
+    private function storeProductUrlKeyData(int $storeId, ProductCollection $collection): void
     {
         foreach ($collection as $product) {
             assert(is_numeric($product->getEntityId()));
diff --git a/Checker/Catalog/Product/UrlKey/EmptyUrlKey.php b/Checker/Catalog/Product/UrlKey/EmptyUrlKey.php
@@ -18,7 +18,7 @@
 
 class EmptyUrlKey
 {
-    const EMPTY_PROBLEM_DESCRIPTION = 'Product has an empty url_key value. This needs to be fixed.';
+    public const EMPTY_PROBLEM_DESCRIPTION = 'Product has an empty url_key value. This needs to be fixed.';
 
     private $storesUtil;
     private $progress;
diff --git a/Checker/Catalog/Product/UrlPath.php b/Checker/Catalog/Product/UrlPath.php
@@ -16,11 +16,11 @@
 
 class UrlPath
 {
-    const URL_PATH_ATTRIBUTE = 'url_path';
-    const PROBLEM_DESCRIPTION =
+    public const URL_PATH_ATTRIBUTE = 'url_path';
+    public const PROBLEM_DESCRIPTION =
         'Product has a non-null url_path attribute, this is known to cause problems with url rewrites in Magento.'
         . ' It\'s advised to remove this value from the database.';
-    const STORAGE_IDENTIFIER = 'product-url-path';
+    public const STORAGE_IDENTIFIER = 'product-url-path';
 
     private $storesUtil;
     private $productCollectionFactory;
diff --git a/Console/Command/CheckCategoryUrlKeys.php b/Console/Command/CheckCategoryUrlKeys.php
@@ -37,7 +37,7 @@ public function __construct(
         parent::__construct();
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('catalog:category:integrity:urlkey');
         $this->setDescription('Checks data integrity of the values of the url_key category attribute.');
diff --git a/Console/Command/CheckCategoryUrlPaths.php b/Console/Command/CheckCategoryUrlPaths.php
@@ -37,7 +37,7 @@ public function __construct(
         parent::__construct();
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('catalog:category:integrity:urlpath');
         $this->setDescription('Checks data integrity of the values of the url_path category attribute.');
diff --git a/Console/Command/CheckProductUrlKeys.php b/Console/Command/CheckProductUrlKeys.php
@@ -41,7 +41,7 @@ public function __construct(
         parent::__construct();
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('catalog:product:integrity:urlkey');
         $this->setDescription('Checks data integrity of the values of the url_key product attribute.');
diff --git a/Console/Command/CheckProductUrlPaths.php b/Console/Command/CheckProductUrlPaths.php
@@ -37,7 +37,7 @@ public function __construct(
         parent::__construct();
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this->setName('catalog:product:integrity:urlpath');
         $this->setDescription('Checks data integrity of the values of the url_path product attribute.');
diff --git a/Console/Progress.php b/Console/Progress.php
@@ -24,12 +24,12 @@ public function __construct()
         $this->format = '';
     }
 
-    public function setOutput(OutputInterface $output)
+    public function setOutput(OutputInterface $output): void
     {
         $this->output = $output;
     }
 
-    public function initProgressBar(int $redrawFequency, string $format, string $message)
+    public function initProgressBar(int $redrawFequency, string $format, string $message): void
     {
         if ($this->canOutput()) {
             $this->progressBar = new ProgressBar($this->output);
@@ -42,35 +42,35 @@ public function initProgressBar(int $redrawFequency, string $format, string $mes
         }
     }
 
-    public function setGuestimatedSize(int $nrOfIndexes, int $sizePerIndex)
+    public function setGuestimatedSize(int $nrOfIndexes, int $sizePerIndex): void
     {
         for ($i = 0; $i < $nrOfIndexes; ++$i) {
             $this->sizeByIndex[$i] = $sizePerIndex;
         }
         $this->updateMaxSteps();
     }
 
-    public function updateExpectedSize(int $index, int $size)
+    public function updateExpectedSize(int $index, int $size): void
     {
         $this->sizeByIndex[$index] = $size;
         $this->updateMaxSteps();
     }
 
-    public function advance()
+    public function advance(): void
     {
         if ($this->canOutput()) {
             $this->progressBar->advance();
         }
     }
 
-    public function setMessage(string $message)
+    public function setMessage(string $message): void
     {
         if ($this->canOutput()) {
             $this->progressBar->setMessage($message);
         }
     }
 
-    public function finish()
+    public function finish(): void
     {
         if ($this->canOutput()) {
             $this->progressBar->finish();
@@ -82,7 +82,7 @@ private function canOutput(): bool
         return $this->output !== null;
     }
 
-    private function updateMaxSteps()
+    private function updateMaxSteps(): void
     {
         if ($this->canOutput()) {
             $newMaxStepsValue = (int) array_sum($this->sizeByIndex);
diff --git a/Controller/Adminhtml/Catalog/Category/UrlKey/Index.php b/Controller/Adminhtml/Catalog/Category/UrlKey/Index.php
@@ -11,7 +11,7 @@
 
 class Index extends BackendAction
 {
-    const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
+    public const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
 
     private $resultPageFactory;
 
diff --git a/Controller/Adminhtml/Catalog/Category/UrlKey/Refresh.php b/Controller/Adminhtml/Catalog/Category/UrlKey/Refresh.php
@@ -14,7 +14,7 @@
 
 class Refresh extends BackendAction
 {
-    const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
+    public const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
 
     private $scheduleJob;
     private $metaStorage;
diff --git a/Controller/Adminhtml/Catalog/Category/UrlPath/Index.php b/Controller/Adminhtml/Catalog/Category/UrlPath/Index.php
@@ -11,7 +11,7 @@
 
 class Index extends BackendAction
 {
-    const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
+    public const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
 
     private $resultPageFactory;
 
diff --git a/Controller/Adminhtml/Catalog/Category/UrlPath/Refresh.php b/Controller/Adminhtml/Catalog/Category/UrlPath/Refresh.php
@@ -14,7 +14,7 @@
 
 class Refresh extends BackendAction
 {
-    const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
+    public const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
 
     private $scheduleJob;
     private $metaStorage;
diff --git a/Controller/Adminhtml/Catalog/Product/UrlKey/Index.php b/Controller/Adminhtml/Catalog/Product/UrlKey/Index.php
@@ -11,7 +11,7 @@
 
 class Index extends BackendAction
 {
-    const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
+    public const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
 
     private $resultPageFactory;
 
diff --git a/Controller/Adminhtml/Catalog/Product/UrlKey/Refresh.php b/Controller/Adminhtml/Catalog/Product/UrlKey/Refresh.php
@@ -14,7 +14,7 @@
 
 class Refresh extends BackendAction
 {
-    const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
+    public const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
 
     private $scheduleJob;
     private $metaStorage;
diff --git a/Controller/Adminhtml/Catalog/Product/UrlPath/Index.php b/Controller/Adminhtml/Catalog/Product/UrlPath/Index.php
@@ -11,7 +11,7 @@
 
 class Index extends BackendAction
 {
-    const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
+    public const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
 
     private $resultPageFactory;
 
diff --git a/Controller/Adminhtml/Catalog/Product/UrlPath/Refresh.php b/Controller/Adminhtml/Catalog/Product/UrlPath/Refresh.php
@@ -14,7 +14,7 @@
 
 class Refresh extends BackendAction
 {
-    const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
+    public const ADMIN_RESOURCE = 'Baldwin_UrlDataIntegrityChecker::catalog_data_integrity';
 
     private $scheduleJob;
     private $metaStorage;
diff --git a/Cron/CheckCategoryUrlKey.php b/Cron/CheckCategoryUrlKey.php
@@ -9,7 +9,7 @@
 
 class CheckCategoryUrlKey
 {
-    const JOB_NAME = 'baldwin_urldataintegritychecker_cron_checkcategoryurlkey';
+    public const JOB_NAME = 'baldwin_urldataintegritychecker_cron_checkcategoryurlkey';
 
     private $urlKeyUpdater;
 
@@ -19,7 +19,7 @@ public function __construct(
         $this->urlKeyUpdater = $urlKeyUpdater;
     }
 
-    public function execute()
+    public function execute(): void
     {
         $this->urlKeyUpdater->refresh(MetaStorage::INITIATOR_CRON);
     }
diff --git a/Cron/CheckCategoryUrlPath.php b/Cron/CheckCategoryUrlPath.php
@@ -9,7 +9,7 @@
 
 class CheckCategoryUrlPath
 {
-    const JOB_NAME = 'baldwin_urldataintegritychecker_cron_checkcategoryurlpath';
+    public const JOB_NAME = 'baldwin_urldataintegritychecker_cron_checkcategoryurlpath';
 
     private $urlPathUpdater;
 
@@ -19,7 +19,7 @@ public function __construct(
         $this->urlPathUpdater = $urlPathUpdater;
     }
 
-    public function execute()
+    public function execute(): void
     {
         $this->urlPathUpdater->refresh(MetaStorage::INITIATOR_CRON);
     }
diff --git a/Cron/CheckProductUrlKey.php b/Cron/CheckProductUrlKey.php
@@ -9,7 +9,7 @@
 
 class CheckProductUrlKey
 {
-    const JOB_NAME = 'baldwin_urldataintegritychecker_cron_checkproducturlkey';
+    public const JOB_NAME = 'baldwin_urldataintegritychecker_cron_checkproducturlkey';
 
     private $urlKeyUpdater;
 
@@ -19,7 +19,7 @@ public function __construct(
         $this->urlKeyUpdater = $urlKeyUpdater;
     }
 
-    public function execute()
+    public function execute(): void
     {
         $this->urlKeyUpdater->refresh(MetaStorage::INITIATOR_CRON);
     }
diff --git a/Cron/CheckProductUrlPath.php b/Cron/CheckProductUrlPath.php
@@ -9,7 +9,7 @@
 
 class CheckProductUrlPath
 {
-    const JOB_NAME = 'baldwin_urldataintegritychecker_cron_checkproducturlpath';
+    public const JOB_NAME = 'baldwin_urldataintegritychecker_cron_checkproducturlpath';
 
     private $urlPathUpdater;
 
@@ -19,7 +19,7 @@ public function __construct(
         $this->urlPathUpdater = $urlPathUpdater;
     }
 
-    public function execute()
+    public function execute(): void
     {
         $this->urlPathUpdater->refresh(MetaStorage::INITIATOR_CRON);
     }
diff --git a/Makefile b/Makefile
@@ -12,8 +12,7 @@ check: checkstyle checkquality test
 checkstyle:
 	vendor-bin/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff --stop-on-violation --allow-risky=yes
 	vendor-bin/phpcs/vendor/bin/phpcs -s --standard=Magento2 --exclude=Magento2.Security.InsecureFunction,Magento2.Commenting.ClassPropertyPHPDocFormatting,Magento2.Annotation.MethodAnnotationStructure,Magento2.Annotation.MethodArguments,PSR12.Properties.ConstantVisibility,PSR2.Classes.ClassDeclaration,Squiz.WhiteSpace.ScopeClosingBrace,Magento2.Legacy.EscapeMethodsOnBlockClass --ignore=./vendor/,./vendor-bin/ .
-	vendor-bin/phpcs/vendor/bin/phpcs -s --standard=PHPCompatibility --runtime-set testVersion 7.0- --ignore=./vendor/,./vendor-bin/,./Test/ .
-	vendor-bin/phpcs/vendor/bin/phpcs -s --standard=PHPCompatibility --runtime-set testVersion 7.1- ./Test/
+	vendor-bin/phpcs/vendor/bin/phpcs -s --standard=PHPCompatibility --runtime-set testVersion 7.1- --ignore=./vendor/,./vendor-bin/ .
 	vendor/bin/composer normalize --dry-run
 
 .PHONY: checkquality
diff --git a/Model/ResourceModel/Catalog/Category/UrlKeyCollection.php b/Model/ResourceModel/Catalog/Category/UrlKeyCollection.php
@@ -105,7 +105,7 @@ public function createDataObject(array $arguments = []): DataObject
     /**
      * @return UrlKeyCollection<DataObject>
      */
-    public function setItems(array $items = null)
+    public function setItems(?array $items = null)
     {
         throw new LocalizedException(__('Not implemented: setItems!'));
     }
diff --git a/Model/ResourceModel/Catalog/Category/UrlPathCollection.php b/Model/ResourceModel/Catalog/Category/UrlPathCollection.php
@@ -105,7 +105,7 @@ public function createDataObject(array $arguments = []): DataObject
     /**
      * @return UrlPathCollection<DataObject>
      */
-    public function setItems(array $items = null)
+    public function setItems(?array $items = null)
     {
         throw new LocalizedException(__('Not implemented: setItems!'));
     }
diff --git a/Model/ResourceModel/Catalog/Product/UrlKeyCollection.php b/Model/ResourceModel/Catalog/Product/UrlKeyCollection.php
diff --git a/Model/ResourceModel/Catalog/Product/UrlPathCollection.php b/Model/ResourceModel/Catalog/Product/UrlPathCollection.php
diff --git a/README.md b/README.md
diff --git a/Storage/FileStorage.php b/Storage/FileStorage.php
diff --git a/Storage/Meta.php b/Storage/Meta.php
diff --git a/Test/Checker/Catalog/Product/UrlKey/DuplicateUrlKeyTest.php b/Test/Checker/Catalog/Product/UrlKey/DuplicateUrlKeyTest.php
diff --git a/Test/Storage/CacheStorageTest.php b/Test/Storage/CacheStorageTest.php
diff --git a/Util/Configuration.php b/Util/Configuration.php
diff --git a/composer.json b/composer.json
diff --git a/composer.lock b/composer.lock
diff --git a/phpstan.neon b/phpstan.neon

Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,8 @@`
`9`	`9`
`10`	`10`	`class UrlKey`
`11`	`11`	`{`
`12`		`- const URL_KEY_ATTRIBUTE = 'url_key';`
`13`		`- const STORAGE_IDENTIFIER = 'category-url-key';`
	`12`	`+ public const URL_KEY_ATTRIBUTE = 'url_key';`
	`13`	`+ public const STORAGE_IDENTIFIER = 'category-url-key';`
`14`	`14`
`15`	`15`	`private $duplicateUrlKeyChecker;`
`16`	`16`	`private $emptyUrlKeyChecker;`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`
`11`	`11`	`class DuplicateUrlKey`
`12`	`12`	`{`
`13`		`- const DUPLICATED_PROBLEM_DESCRIPTION =`
	`13`	`+ public const DUPLICATED_PROBLEM_DESCRIPTION =`
`14`	`14`	`'%s categories were found which have a duplicated url_key value: "%s" within the same parent.'`
`15`	`15`	`. ' Please fix because this will cause problems.';`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`
`16`	`16`	`class EmptyUrlKey`
`17`	`17`	`{`
`18`		`- const EMPTY_PROBLEM_DESCRIPTION = 'Category has an empty url_key value. This needs to be fixed.';`
	`18`	`+ public const EMPTY_PROBLEM_DESCRIPTION = 'Category has an empty url_key value. This needs to be fixed.';`
`19`	`19`
`20`	`20`	`private $storesUtil;`
`21`	`21`	`private $categoryCollectionFactory;`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`
`19`	`19`	`class EmptyUrlKey`
`20`	`20`	`{`
`21`		`- const EMPTY_PROBLEM_DESCRIPTION = 'Product has an empty url_key value. This needs to be fixed.';`
	`21`	`+ public const EMPTY_PROBLEM_DESCRIPTION = 'Product has an empty url_key value. This needs to be fixed.';`
`22`	`22`
`23`	`23`	`private $storesUtil;`
`24`	`24`	`private $progress;`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function __construct(`
`37`	`37`	`parent::__construct();`
`38`	`38`	`}`
`39`	`39`
`40`		`- protected function configure()`
	`40`	`+ protected function configure(): void`
`41`	`41`	`{`
`42`	`42`	`$this->setName('catalog:category:integrity:urlkey');`
`43`	`43`	`$this->setDescription('Checks data integrity of the values of the url_key category attribute.');`