Merge pull request ateli-development#2 from vianetz/compatibility_with_phpstan_v0.12

Compatibility with phpstan v0.12

Author: ma4nn

README.md

@@ -1,8 +1,8 @@
-# phpstan-magento1 extension
+# PHPStan Extension for Magento 1
 
 Extension for [PHPStan](https://github.com/phpstan/phpstan) to allow analysis of Magento 1 code.
 
-Currently it assumes Magento is installed in the public/ directory of the project root. Further work is needed in phpstan itself to allow more intellegence for extensions to be more customised whilst working with both phpstan/phpstan and phpstan/phpstan-shim.
+Currently it assumes Magento is installed in the `htdocs/` directory of the project root. Further work is needed in phpstan itself to allow more intellegence for extensions to be more customised whilst working with both phpstan/phpstan and phpstan/phpstan-shim.
 
 ## Usage
 
@@ -12,23 +12,15 @@ Make sure it has
 
 ```neon
 includes:
-    - vendor/inviqa/phpstan-magento1/extension.neon
+    - vendor/vianetz/phpstan-magento1/extension.neon
 ```
 
-Whilst this extension depends on phpstan/phpstan, it can also depend on phpstan/phpstan-shim, which decouples its dependencies from the project's own use of them.
-
-With coupled dependencies:
+Then run
 
 ```bash
 composer require inviqa/phpstan-magento1 phpstan/phpstan
 ```
 
-With uncoupled phar package:
-
-```bash
-composer require inviqa/phpstan-magento1 phpstan/phpstan-shim
-```
-
 ## Alternative Magento path
 
 By default this extension assumes the Magento directory is `%currentWorkingDirectory%/htdocs`.
@@ -39,9 +31,6 @@ Add to the project's phpstan.neon:
 parameters:
     paths:
         - %currentWorkingDirectory%/path/to/magento/app/code/local
-    excludes_analyse:
-        - %currentWorkingDirectory%/path/to/magento/app/code/local/*/*/data/*
-        - %currentWorkingDirectory%/path/to/magento/app/code/local/*/*/sql/*
     autoload_files:
         - %currentWorkingDirectory%/path/to/magento/app/Mage.php
 ```

composer.json

@@ -3,9 +3,8 @@
     "description": "Extension for PHPStan to allow analysis of Magento 1 code.",
     "type": "library",
     "require": {
-        "phpstan/phpstan": "^0.11",
-        "php": ">= 7.2",
-        "nikic/php-parser": "^4.4"
+        "phpstan/phpstan": "^0.11|^0.12",
+        "php": ">= 7.2"
     },
     "replace": {
         "inviqa/phpstan-magento1": "0.1.5"

extension.neon

@@ -1,9 +1,8 @@
 parameters:
-    vendor_path: %currentWorkingDirectory%/vendor
-    bootstrap: %vendor_path%/vianetz/phpstan-magento1/phpstan-bootstrap.php
+    bootstrap: %currentWorkingDirectory%/vendor/vianetz/phpstan-magento1/phpstan-bootstrap.php
     excludes_analyse:
-        - %currentWorkingDirectory%/htdocs/app/code/local/*/*/data/*
-        - %currentWorkingDirectory%/htdocs/app/code/local/*/*/sql/*
+        - */app/code/local/*/*/data/*
+        - */app/code/local/*/*/sql/*
     autoload_files:
         - %currentWorkingDirectory%/htdocs/app/Mage.php
 
@@ -13,10 +12,26 @@ services:
         tags:
             - phpstan.broker.methodsClassReflectionExtension
     -
-        class: PHPStanMagento1\Type\Mage\Core\Model\Layout\HelperMethodsReturnTypeExtension
+        class: PHPStanMagento1\Type\Mage\CoreModelLayout\Helper
         tags:
             - phpstan.broker.dynamicMethodReturnTypeExtension
     -
-        class: PHPStanMagento1\Type\Mage\HelperMethodsReturnTypeExtension
+        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

phpstan-bootstrap.php

@@ -11,4 +11,4 @@
 // better would be to implement the typehint to make it appear string type
 class date {}
 
-Mage::app();
+Mage::app();

src/Autoload/Magento/ModuleControllerAutoloader.php

@@ -33,7 +33,7 @@ public function register(): void
         spl_autoload_register([$this, 'autoload']);
     }
 
-    public function autoload($className): void
+    public function autoload(string $className): void
     {
         if (preg_match('/^([a-zA-Z0-9\x7f-\xff]*)_([a-zA-Z0-9\x7f-\xff]*)_([a-zA-Z0-9_\x7f-\xff]+)/', $className, $match) === 1) {
             $class = str_replace('_', '/', $match[3]);

src/Reflection/Varien/Object/MagicMethodReflection.php

@@ -61,4 +61,39 @@ public function getVariants(): array
             new TrivialParametersAcceptor(),
         ];
     }
+
+    public function getDocComment(): ?string
+    {
+        return null;
+    }
+
+    public function isDeprecated(): \PHPStan\TrinaryLogic
+    {
+        return \PHPStan\TrinaryLogic::createMaybe();
+    }
+
+    public function getDeprecatedDescription(): ?string
+    {
+        return null;
+    }
+
+    public function isFinal(): \PHPStan\TrinaryLogic
+    {
+        return \PHPStan\TrinaryLogic::createNo();
+    }
+
+    public function isInternal(): \PHPStan\TrinaryLogic
+    {
+        return \PHPStan\TrinaryLogic::createMaybe();
+    }
+
+    public function getThrowType(): ?\PHPStan\Type\Type
+    {
+        return null;
+    }
+
+    public function hasSideEffects(): \PHPStan\TrinaryLogic
+    {
+        return \PHPStan\TrinaryLogic::createMaybe();
+    }
 }

src/Reflection/Varien/Object/MagicMethodsReflectionExtension.php

@@ -14,7 +14,7 @@ final class MagicMethodsReflectionExtension implements MethodsClassReflectionExt
     public function hasMethod(ClassReflection $classReflection, string $methodName): bool
     {
         $magentoMagicMethods = ['get', 'set', 'uns', 'has'];
-        return $classReflection->isSubclassOf(Varien_Object::class)
+        return ($classReflection->isSubclassOf(Varien_Object::class) || $classReflection->getName() === Varien_Object::class)
             && \in_array(substr($methodName, 0, 3), $magentoMagicMethods, true);
     }
 

src/Type/Mage/Core/Model/Layout/HelperMethodsReturnTypeExtension.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPStanMagento1\Type\Mage\CoreModelLayout;
+
+final class GetBlockSingleton extends MethodReturnTypeDetector
+{
+    public function getMagentoClassName(string $identifier): string
+    {
+        return $this->getMagentoConfig()->getBlockClassName($identifier);
+    }
+
+    protected static function getMethodName(): string
+    {
+        return 'getBlockSingleton';
+    }
+}

src/Type/Mage/CoreModelLayout/GetBlockSingleton.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPStanMagento1\Type\Mage\CoreModelLayout;
+
+final class Helper extends MethodReturnTypeDetector
+{
+    public function getMagentoClassName(string $identifier): string
+    {
+        return $this->getMagentoConfig()->getHelperClassName($identifier);
+    }
+
+    protected static function getMethodName(): string
+    {
+        return 'helper';
+    }
+}

src/Type/Mage/CoreModelLayout/Helper.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPStanMagento1\Type\Mage\CoreModelLayout;
+
+abstract class MethodReturnTypeDetector extends \PHPStanMagento1\Type\Mage\MethodReturnTypeDetector implements \PHPStan\Type\DynamicMethodReturnTypeExtension
+{
+    public function getClass(): string
+    {
+        return \Mage_Core_Model_Layout::class;
+    }
+}

src/Type/Mage/CoreModelLayout/MethodReturnTypeDetector.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPStanMagento1\Type\Mage;
+
+final class GetModel extends StaticMethodReturnTypeDetector
+{
+    public function getMagentoClassName(string $identifier): string
+    {
+        return $this->getMagentoConfig()->getModelClassName($identifier);
+    }
+
+    protected static function getMethodName(): string
+    {
+        return 'getModel';
+    }
+}

src/Type/Mage/GetModel.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPStanMagento1\Type\Mage;
+
+final class GetResourceModel extends StaticMethodReturnTypeDetector
+{
+    public function getMagentoClassName(string $identifier): string
+    {
+        return $this->getMagentoConfig()->getResourceModelClassName($identifier);
+    }
+
+    protected static function getMethodName(): string
+    {
+        return 'getResourceModel';
+    }
+}

src/Type/Mage/GetResourceModel.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPStanMagento1\Type\Mage;
+
+final class GetResourceSingleton extends StaticMethodReturnTypeDetector
+{
+    public function getMagentoClassName(string $identifier): string
+    {
+        return $this->getMagentoConfig()->getResourceModelClassName($identifier);
+    }
+
+    protected static function getMethodName(): string
+    {
+        return 'getResourceSingleton';
+    }
+}

src/Type/Mage/GetResourceSingleton.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPStanMagento1\Type\Mage;
+
+final class GetSingleton extends StaticMethodReturnTypeDetector
+{
+    public function getMagentoClassName(string $identifier): string
+    {
+        return $this->getMagentoConfig()->getModelClassName($identifier);
+    }
+
+    protected static function getMethodName(): string
+    {
+        return 'getSingleton';
+    }
+}

src/Type/Mage/GetSingleton.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPStanMagento1\Type\Mage;
+
+final class Helper extends StaticMethodReturnTypeDetector
+{
+    public function getMagentoClassName(string $identifier): string
+    {
+        return $this->getMagentoConfig()->getHelperClassName($identifier);
+    }
+
+    protected static function getMethodName(): string
+    {
+        return 'helper';
+    }
+}