Merge branch 'main' into documentation

Author: sreichel

.ddev/commands/web/magerun

@@ -5,7 +5,7 @@
 ## Example: "ddev magerun"
 
 if [ ! -f vendor/bin/n98-magerun ]; then
-  read -r -p "n98-magerun is not installed. Do you want to install it? [y/N] " INSTALL_MAGE
+  read -r -p "n98-magerun is not installed. Do you want to install it? [y/N] " INSTALL_MAGERUN
   INSTALL_MAGERUN=${INSTALL_MAGERUN,,} # to lower
   if [[ "${INSTALL_MAGERUN}" =~ ^(yes|y) ]]; then
     composer require --dev n98/magerun:dev-develop

.ddev/commands/web/openmage-admin

@@ -887,6 +887,7 @@
 'phpstan':
   - changed-files:
     - any-glob-to-any-file: [
+      .phpstan*,
       phpstan*,
       .github/workflows/phpstan.yml
     ]

.github/labeler.yml

@@ -75,7 +75,7 @@ jobs:
 
       - name: Get changed files
         id: changed-files-specific
-        uses: tj-actions/changed-files@v44
+        uses: tj-actions/changed-files@v45
         with:
           files: |
             composer.*

.github/workflows/check-files.yml

@@ -13,15 +13,8 @@ name: "CodeQL"
 
 on:
   workflow_call:
+  # Allow manually triggering the workflow.
   workflow_dispatch:
-  push:
-    branches: [ "main", "next", "v19" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main", "next", "v19" ]
-    paths-ignore:
-      - '**/*.md'
-      - '**/*.txt'
 
 jobs:
   analyze:

.github/workflows/codeql-analysis.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['7.4', '8.3']
+        php-versions: ['7.4', '8.4']
 
     steps:
       - name: Setup PHP

.github/workflows/phpstan.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        php: ['7.4', '8.3']
+        php: ['7.4', '8.4']
 
     name: PHP Syntax ${{ matrix.php }}
 

.github/workflows/syntax-php.yml

@@ -0,0 +1,57 @@
+name: Update Copyright
+
+on:
+  # Run automatically every month.
+  schedule:
+    - cron: '0 0 1 * *'
+  workflow_call:
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+jobs:
+  update_copyright:
+    name: Update Copyright
+    runs-on: [ubuntu-latest]
+
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 7.4
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --ignore-platform-req=ext-*
+
+      - name: Update Copyright
+        run: php -f shell/update-copyright.php
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: update copyright
+          title: Updated Copyright
+          body: |
+            - Updated copyright
+            
+            Auto-generated by [openmage/dev-copyright][1]
+            
+            [1]: https://github.com/OpenMage/dev-copyright
+          branch: update-copyright
+          base: main

.github/workflows/update-copyright.yml

@@ -70,8 +70,11 @@
 .phpcs*.xml
 !.phpcs*.xml.dist
 
+# PhpStan
+.phpstan*.neon
 phpstan*.neon
-!phpstan.dist.*.neon
+!.phpstan.dist.neon
+!.phpstan.dist.*.neon
 
 # dev scripts loaded via composer
 /shell/update-copyright.php

.gitignore

@@ -6,7 +6,10 @@
 */
 $config = new PhpCsFixer\Config();
 return $config
+    ->setRiskyAllowed(true)
     ->setRules([
+        // PHP arrays should be declared using the configured syntax.
+        'array_syntax' => ['syntax' => 'short'],
         // There MUST be one blank line after the namespace declaration.
         'blank_line_after_namespace' => true,
         // Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line.
@@ -17,6 +20,8 @@
         'class_definition' => true,
         // Remove extra spaces in a nullable typehint.
         'compact_nullable_typehint' => true,
+        // Concatenation should be spaced according to configuration.
+        'concat_space' => ['spacing' => 'one'],
         // The PHP constants `true`, `false`, and `null` MUST be written using the correct casing.
         'constant_case' => true,
         // Equal sign in declare statement should be surrounded by spaces or not following configuration.
@@ -33,6 +38,8 @@
         'indentation_type' => true,
         // All PHP files must use same line ending.
         'line_ending' => true,
+        // Use && and || logical operators instead of and and or.
+        'logical_operators' => true,
         // Cast should be written in lower case.
         'lowercase_cast' => true,
         // PHP keywords MUST be in lower case.
@@ -41,6 +48,8 @@
         'lowercase_static_reference' => true,
         // In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.
         'method_argument_space' => true,
+        // Replaces intval, floatval, doubleval, strval and boolval function calls with according type casting operator.
+        'modernize_types_casting' => true,
         // All instances created with new keyword must be followed by braces.
         'new_with_braces' => true,
         // There should be no empty lines after class opening brace.
@@ -100,6 +109,7 @@
         PhpCsFixer\Finder::create()
             ->in([
                 'app/code/core/Mage/',
+                'errors/',
                 'lib/Mage/',
                 'lib/Magento/',
                 'lib/Varien/',

.php-cs-fixer.dist.php

@@ -7,6 +7,7 @@
     <file>install.php</file>
     <file>app/Mage.php</file>
     <file>app/code/core/Mage/</file>
+    <file>errors/</file>
     <file>lib/Mage/</file>
     <file>lib/Magento/</file>
     <file>lib/Varien/</file>
@@ -66,6 +67,7 @@
         <exclude-pattern>*/core/Mage/Catalog/Model/Resource/Product/Compare/Item.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Catalog/Model/Resource/Product/Indexer/Price.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Catalog/Model/Resource/Product/Option/Value.php*</exclude-pattern>
+        <exclude-pattern>*/core/Mage/Catalog/Model/Resource/Product/Type/Configurable/Attribute.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/CatalogIndex/Model/Indexer.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/CatalogInventory/Model/Observer.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/CatalogInventory/Model/Api2/Stock/Item/Rest.php*</exclude-pattern>
@@ -111,6 +113,7 @@
         <exclude-pattern>*/core/Mage/ImportExport/Model/Import/Entity/Product/Type/Grouped.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/ImportExport/Model/Import/Proxy/Product/Resource.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Index/controllers/Adminhtml/ProcessController.php*</exclude-pattern>
+        <exclude-pattern>*/core/Mage/Index/Model/Observer.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Index/Model/Process.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Index/Model/Resource/Event.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Log/Model/Resource/Log.php*</exclude-pattern>
@@ -148,6 +151,7 @@
         <exclude-pattern>*/core/Mage/Sales/Model/Order/Shipment.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/SalesRule/Model/Observer.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/SalesRule/Model/Rule.php*</exclude-pattern>
+        <exclude-pattern>*/core/Mage/SalesRule/Model/Coupon/Massgenerator.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Tag/controllers/IndexController.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Tag/Model/Api.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/Tag/Model/Resource/Product/Collection.php*</exclude-pattern>
@@ -163,6 +167,7 @@
         <exclude-pattern>*/lib/Varien/Cache/Backend/Memcached.php*</exclude-pattern>
         <exclude-pattern>*/lib/Varien/Convert/Parser/Csv.php*</exclude-pattern>
         <exclude-pattern>*/lib/Varien/Object/Cache.php*</exclude-pattern>
+        <exclude-pattern>*/shell/indexer.php*</exclude-pattern>
         <exclude-pattern>*/core/Mage/*/data/*</exclude-pattern>
         <exclude-pattern>*/core/Mage/*/sql/*</exclude-pattern>
     </rule>

.phpcs.ecg.xml.dist

@@ -7,6 +7,7 @@
     <file>install.php</file>
     <file>app/Mage.php</file>
     <file>app/code/core/Mage/</file>
+    <file>errors/</file>
     <file>lib/Mage/</file>
     <file>lib/Magento/</file>
     <file>lib/Varien/</file>

.phpcs.php.xml.dist

@@ -7,6 +7,7 @@
     <file>install.php</file>
     <file>app/Mage.php</file>
     <file>app/code/core/Mage/</file>
+    <file>errors/</file>
     <file>lib/Mage/</file>
     <file>lib/Magento/</file>
     <file>lib/Varien/</file>

.phpcs.xml.dist

@@ -3290,11 +3290,6 @@ parameters:
 			count: 1
 			path: app/code/core/Mage/ImportExport/Model/Export/Entity/Product.php
 
-		-
-			message: "#^Offset int\\|string on non\\-empty\\-array\\<int\\|string, non\\-empty\\-array\\> in isset\\(\\) always exists and is not nullable\\.$#"
-			count: 2
-			path: app/code/core/Mage/ImportExport/Model/Export/Entity/Product.php
-
 		-
 			message: "#^Variable \\$collection might not be defined\\.$#"
 			count: 1
@@ -3490,11 +3485,6 @@ parameters:
 			count: 1
 			path: app/code/core/Mage/Payment/Model/Method/Abstract.php
 
-		-
-			message: "#^Loose comparison using \\!\\= between ''\\|'OT' and 'SS' will always evaluate to true\\.$#"
-			count: 1
-			path: app/code/core/Mage/Payment/Model/Method/Cc.php
-
 		-
 			message: "#^Method Mage_Payment_Model_Recurring_Profile\\:\\:exportStartDatetime\\(\\) should return string\\|Zend_Date but empty return statement found\\.$#"
 			count: 1
@@ -3970,6 +3960,11 @@ parameters:
 			count: 1
 			path: app/code/core/Mage/Sales/Model/Entity/Quote/Address/Attribute/Frontend/Tax.php
 
+		-
+			message: "#^Negated boolean expression is always true\\.$#"
+			count: 1
+			path: app/code/core/Mage/Sales/Model/Order.php
+
 		-
 			message: "#^Variable \\$oldArea might not be defined\\.$#"
 			count: 1

phpstan.dist.baseline.neon renamed to .phpstan.dist.baseline.neon

@@ -1,6 +1,6 @@
 includes:
     - vendor/macopedia/phpstan-magento1/extension.neon
-    - phpstan.dist.baseline.neon
+    - .phpstan.dist.baseline.neon
     - phar://phpstan.phar/conf/bleedingEdge.neon
 parameters:
     magentoRootPath: %currentWorkingDirectory%
@@ -12,6 +12,7 @@ parameters:
         - install.php
         - app/Mage.php
         - app/code/core/Mage
+        - errors
         - lib/Mage
         - lib/Magento
         - lib/Varien
@@ -50,9 +51,6 @@ parameters:
         - app/code/core/Mage/Paypal/Model/Report/Settlement.php
         - lib/Varien/Io/Sftp.php
 
-        # Class backup/db was not found while trying to analyse it
-        - app/code/core/Mage/Adminhtml/controllers/System/BackupController.php
-
         # Dataflow/Model/Convert/Iterator.php
         - app/code/core/Mage/Dataflow/Model/Convert/Iterator.php
 
@@ -70,6 +68,9 @@ parameters:
     checkFunctionNameCase: true
     checkInternalClassCaseSensitivity: true
     treatPhpDocTypesAsCertain: false
-
+    # For v1.12+ with "bleeding edge"
+    ignoreErrors:
+        -
+            identifier: missingType.iterableValue
 #    universalObjectCratesClasses:
 #        - Varien_Object

phpstan.dist.neon renamed to .phpstan.dist.neon

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2017-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2017-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
@@ -433,7 +433,7 @@ public static function getStoreConfigAsInt(string $path, $store = null): int
      * Retrieve config flag for store by path
      *
      * @param string $path
-     * @param mixed $store
+     * @param null|string|bool|int|Mage_Core_Model_Store $store
      * @return bool
      */
     public static function getStoreConfigFlag($path, $store = null)

app/Mage.php

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage_Admin
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2020-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2020-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 

app/code/core/Mage/Admin/Model/Acl/Assert/Ip.php

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage_Admin
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2020-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2020-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 

app/code/core/Mage/Admin/Model/Acl/Assert/Time.php

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage_Admin
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2019-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2019-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 

app/code/core/Mage/Admin/Model/Config.php

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage_Admin
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2020-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2020-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 

app/code/core/Mage/Admin/Model/Observer.php

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage_Admin
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2020-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2020-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 

app/code/core/Mage/Admin/Model/Redirectpolicy.php

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage_Admin
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2019-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2019-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 

app/code/core/Mage/Admin/Model/Resource/Acl.php

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage_Admin
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2019-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2019-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 

app/code/core/Mage/Admin/Model/Resource/Roles/Collection.php

@@ -9,7 +9,7 @@
  * @category   Mage
  * @package    Mage_Admin
  * @copyright  Copyright (c) 2006-2020 Magento, Inc. (https://www.magento.com)
- * @copyright  Copyright (c) 2019-2023 The OpenMage Contributors (https://www.openmage.org)
+ * @copyright  Copyright (c) 2019-2024 The OpenMage Contributors (https://www.openmage.org)
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */