Add new extension-mage-autoload.neon to run stan without static refle…

…ction

This extension provides 2 configs:
extension-mage-autoload.neon (without static reflection,
Mage is autoloaded and executed)
extension.neon (Mage.php is not executed thanks to the static reflection)
Both modes now run with similar performance, thanks to the config cacheing.

README.md

@@ -6,7 +6,7 @@ It doesn't require db connection to run.
 
 ## Usage
 
-Add `phpstan.neon` to your Magento 1 project.
+Add `phpstan.neon` to your Magento 1/OpenMage project.
 
 Make sure it has
 
@@ -40,10 +40,6 @@ includes:
     - vendor/macopedia/phpstan-magento1/extension.neon
 parameters:
     magentoRootPath: %currentWorkingDirectory%/htdocs
-    paths:
-        - %currentWorkingDirectory%/path/to/magento/app/code/local
-    autoload_files:
-        - %currentWorkingDirectory%/path/to/magento/app/Mage.php
     paths:
         #lets start small with just our extensions
         - %currentWorkingDirectory%/app/code/local/VendorName/ModuleName
@@ -56,7 +52,7 @@ parameters:
 
 ## Data/SQL scripts can't be tested
 
-Since these scripts use a presumed $this variable due to being included from a setup class, work is needed to:
+Since these scripts use a presumed `$this` variable due to being included from a setup class, work is needed to:
 
 * work out the correct setup class
 * somehow make phpstan aware of it for the file
@@ -65,7 +61,7 @@ Since these scripts use a presumed $this variable due to being included from a s
 
 This causes subsequent calls to the class object to assume the scope of the super-class that defined the return type.
 
-This is due to their PHPDoc not using the up to date way of specifying fluency with subclasses using "$this" as the type.
+This is due to their PHPDoc not using the up to date way of specifying fluency with subclasses using `$this` as the type.
 
 Options to resolve:
 
@@ -74,7 +70,7 @@ Options to resolve:
  * Define @method PHPDoc for the called methods in the subclass
  * Add the error to the parameters.ignoreErrors phpstan configuration to ignore it - this loses the ability to properly type the subseqent methods of the fluent interface
 
-## Mage_Core_Model_Abstract::load $id is not an integer
+## Mage_Core_Model_Abstract::load `$id` is not an integer
 
 This is due to an inadequate PHPDoc of the load method of the Mage_Core_Model_Abstract class. It should have used a "mixed" type to support when a field is specified as the 2nd argument.
 

extension-mage-autoload.neon

@@ -0,0 +1,53 @@
+# This configuration file doesn't use static reflection for loading Mage class (so it executes code of Mage file).
+# Make sure you DON'T have local.xml file in your project when using this config. Otherwise you'll get errors
+# about connecting to db
+# this config will also throw warnings "PHP Warning:  Constant DS already defined in", this is an issue in phpstan
+# https://github.com/phpstan/phpstan/issues/6744#event-6194525980
+parametersSchema:
+    magentoRootPath: string()
+parameters:
+    magentoRootPath: %currentWorkingDirectory%/htdocs
+    staticReflection: false
+    excludePaths:
+        - */app/code/local/*/*/data/*
+        - */app/code/local/*/*/sql/*
+    bootstrapFiles:
+        - %magentoRootPath%/app/Mage.php
+        - phpstan-bootstrap-mage-autoload.php
+
+    typeAliases:
+        Mage_Catalog_Model_Entity_Product_Collection: 'Mage_Catalog_Model_Resource_Product_Collection'
+        callback: 'callable'
+    earlyTerminatingMethodCalls:
+        Mage:
+            - throwException
+
+services:
+    -
+        class: PHPStanMagento1\Reflection\Varien\Object\MagicMethodsReflectionExtension
+        tags:
+            - phpstan.broker.methodsClassReflectionExtension
+    -
+        class: PHPStanMagento1\Type\Mage\CoreModelLayout\Helper
+        tags:
+            - phpstan.broker.dynamicMethodReturnTypeExtension
+    -
+        class: PHPStanMagento1\Type\Mage\CoreModelLayout\GetBlockSingleton
+        tags:
+            - phpstan.broker.dynamicMethodReturnTypeExtension
+    -
+        class: PHPStanMagento1\Type\Mage\GetModel
+        tags:
+            - phpstan.broker.dynamicStaticMethodReturnTypeExtension
+    -
+        class: PHPStanMagento1\Type\Mage\GetResourceModel
+        tags:
+            - phpstan.broker.dynamicStaticMethodReturnTypeExtension
+    -
+        class: PHPStanMagento1\Type\Mage\GetSingleton
+        tags:
+            - phpstan.broker.dynamicStaticMethodReturnTypeExtension
+    -
+        class: PHPStanMagento1\Type\Mage\Helper
+        tags:
+            - phpstan.broker.dynamicStaticMethodReturnTypeExtension

extension.neon

@@ -9,13 +9,6 @@ parameters:
         - phpstan-bootstrap.php
     scanFiles:
         - %magentoRootPath%/app/Mage.php
-        - %magentoRootPath%/app/code/core/Mage/Core/functions.php
-    scanDirectories:
-        #for static reflection, so we don't have to call autoloader
-        - %magentoRootPath%/lib/
-        - %magentoRootPath%/app/code/local/
-        - %magentoRootPath%/app/code/community/
-        - %magentoRootPath%/app/code/core/
     typeAliases:
         Mage_Catalog_Model_Entity_Product_Collection: 'Mage_Catalog_Model_Resource_Product_Collection'
         callback: 'callable'

phpstan-bootstrap-mage-autoload.php

@@ -0,0 +1,41 @@
+<?php
+declare(strict_types=1);
+
+use PHPStanMagento1\Autoload\Magento\ModuleControllerAutoloader;
+
+/**
+ * @var $container \PHPStan\DependencyInjection\MemoizingContainer
+ */
+$magentoRootPath = $container->getParameter('magentoRootPath');
+if (empty($magentoRootPath)) {
+    throw new \Exception('Please set "magentoRootPath" in your phpstan.neon.');
+}
+
+if (!defined('BP')) {
+    define('BP', $magentoRootPath);
+}
+
+(new ModuleControllerAutoloader('local'))->register();
+(new ModuleControllerAutoloader('core'))->register();
+(new ModuleControllerAutoloader('community'))->register();
+
+/**
+ * We replace the original Varien_Autoload autoloader with a custom one in order to prevent errors with invalid classes
+ * that are used throughout the Magento core code.
+ * The original autoloader would in this case return false and lead to an error in phpstan because the type alias in extension.neon
+ * is evaluated afterwards.
+ *
+ * @see \Varien_Autoload::autoload()
+ */
+spl_autoload_register(static function($className) {
+    spl_autoload_unregister([Varien_Autoload::instance(), 'autoload']);
+
+    $classFile = str_replace(' ', DIRECTORY_SEPARATOR, ucwords(str_replace('_', ' ', $className)));
+    $classFile .= '.php';
+
+    foreach (explode(':', get_include_path()) as $path) {
+        if (\file_exists($path . DIRECTORY_SEPARATOR . $classFile)) {
+            return include $classFile;
+        }
+    }
+}, true, true);

phpstan-bootstrap.php

@@ -3,13 +3,6 @@
 
 use PHPStanMagento1\Autoload\Magento\ModuleControllerAutoloader;
 
-if (!defined('DS')) {
-    define('DS', DIRECTORY_SEPARATOR);
-}
-if (!defined('PS')) {
-    define('PS', PATH_SEPARATOR);
-}
-
 /**
  * @var $container \PHPStan\DependencyInjection\MemoizingContainer
  */
@@ -22,6 +15,15 @@
     define('BP', $magentoRootPath);
 }
 
+define('staticReflection', true);
+
+if (!defined('DS')) {
+    define('DS', DIRECTORY_SEPARATOR);
+}
+if (!defined('PS')) {
+    define('PS', PATH_SEPARATOR);
+}
+
 /**
  * Set include path
  */

src/Type/Mage/GetResourceModel.php

@@ -5,6 +5,9 @@
 
 final class GetResourceModel extends StaticMethodReturnTypeDetector
 {
+    /**
+     * @throws \PHPStan\Broker\ClassNotFoundException
+     */
     public function getMagentoClassName(string $identifier): string
     {
         $className = $this->getMagentoConfig()->getResourceModelClassName($identifier);