some housekeeping

ma4nn · ma4nn · commit 259d1fd3ab2c · 2020-04-16T16:43:34.000+02:00
diff --git a/composer.json b/composer.json
@@ -3,8 +3,8 @@
     "description": "Extension for PHPStan to allow analysis of Magento 1 code.",
     "type": "library",
     "require": {
-        "phpstan/phpstan": "0.11.*",
-        "php": ">= 7.0",
+        "phpstan/phpstan": "^0.11",
+        "php": ">= 7.2",
         "nikic/php-parser": "^4.4"
     },
     "replace": {
diff --git a/phpstan-bootstrap.php b/phpstan-bootstrap.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 use PHPStanMagento1\Autoload\Magento\ModuleControllerAutoloader;
 
diff --git a/src/Autoload/Magento/ModuleControllerAutoloader.php b/src/Autoload/Magento/ModuleControllerAutoloader.php
@@ -5,43 +5,41 @@
 
 use Mage;
 use ReflectionClass;
-use Exception;
 
-class ModuleControllerAutoloader
+final class ModuleControllerAutoloader
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     private $magentoRoot;
 
+    /** @var string */
     private $codePool;
 
-    public function __construct($codePool, $magentoRoot = null)
+    public function __construct(string $codePool, $magentoRoot = null)
     {
         if (empty($magentoRoot)) {
             $mageClass = new ReflectionClass(Mage::class);
             if ($mageClass->getFileName() !== false) {
-                $magentoRoot = dirname($mageClass->getFileName(), 2);
+                $magentoRoot = \dirname($mageClass->getFileName(), 2);
             } else {
-                throw new Exception('Could not find path to Mage class');
+                throw new \RuntimeException('Could not find path to Mage class');
             }
         }
         $this->codePool = $codePool;
         $this->magentoRoot = $magentoRoot;
     }
 
-    public function register()
+    public function register(): void
     {
         spl_autoload_register([$this, 'autoload']);
     }
 
-    public function autoload($className)
+    public function autoload($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]);
             $controllerFilename = sprintf('%s/app/code/%s/%s/%s/controllers/%s.php', $this->magentoRoot, $this->codePool, $match[1], $match[2], $class);
             if (file_exists($controllerFilename)) {
-                (function ($file) {
+                (static function ($file) {
                     include $file;
                 })($controllerFilename);
             }
diff --git a/src/Reflection/Varien/Object/MagicMethodReflection.php b/src/Reflection/Varien/Object/MagicMethodReflection.php
@@ -8,16 +8,12 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\TrivialParametersAcceptor;
 
-class MagicMethodReflection implements MethodReflection
+final class MagicMethodReflection implements MethodReflection
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     private $name;
 
-    /**
-     * @var ClassReflection
-     */
+    /** @var ClassReflection */
     private $declaringClass;
 
     public function __construct(ClassReflection $declaringClass, string $name)
@@ -56,13 +52,13 @@ public function getName(): string
         return $this->name;
     }
 
-	/**
-	 * @return \PHPStan\Reflection\ParametersAcceptor[]
-	 */
-	public function getVariants(): array
-	{
-		return [
-			new TrivialParametersAcceptor(),
-		];
-	}
+    /**
+     * @return \PHPStan\Reflection\ParametersAcceptor[]
+     */
+    public function getVariants(): array
+    {
+        return [
+            new TrivialParametersAcceptor(),
+        ];
+    }
 }
diff --git a/src/Reflection/Varien/Object/MagicMethodsReflectionExtension.php b/src/Reflection/Varien/Object/MagicMethodsReflectionExtension.php
@@ -9,13 +9,13 @@
 
 use Varien_Object;
 
-class MagicMethodsReflectionExtension implements MethodsClassReflectionExtension
+final class MagicMethodsReflectionExtension implements MethodsClassReflectionExtension
 {
     public function hasMethod(ClassReflection $classReflection, string $methodName): bool
     {
         $magentoMagicMethods = ['get', 'set', 'uns', 'has'];
         return $classReflection->isSubclassOf(Varien_Object::class)
-            && in_array(substr($methodName, 0, 3), $magentoMagicMethods);
+            && \in_array(substr($methodName, 0, 3), $magentoMagicMethods, true);
     }
 
     public function getMethod(ClassReflection $classReflection, string $methodName): MethodReflection
diff --git a/src/Type/Mage/Core/Model/Layout/HelperMethodsReturnTypeExtension.php b/src/Type/Mage/Core/Model/Layout/HelperMethodsReturnTypeExtension.php
@@ -15,8 +15,7 @@
 use Mage;
 use Mage_Core_Model_Layout;
 
-
-class HelperMethodsReturnTypeExtension implements DynamicMethodReturnTypeExtension
+final class HelperMethodsReturnTypeExtension implements DynamicMethodReturnTypeExtension
 {
     public function getClass(): string
     {
@@ -25,7 +24,7 @@ public function getClass(): string
 
     public function isMethodSupported(MethodReflection $methodReflection): bool
     {
-        return in_array(
+        return \in_array(
             $methodReflection->getName(),
             [
                 'getBlockSingleton',
@@ -34,6 +33,9 @@ public function isMethodSupported(MethodReflection $methodReflection): bool
         );
     }
 
+    /**
+     * @throws \PHPStan\ShouldNotHappenException
+     */
     public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
     {
         if (!isset($methodCall->args[0]) || !$methodCall->args[0]->value instanceof String_) {
@@ -45,7 +47,10 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
         return new ObjectType($class);
     }
 
-    private function getClassFromHelperMethod($method, $name)
+    /**
+     * @throws \PHPStan\ShouldNotHappenException
+     */
+    private function getClassFromHelperMethod(string $method, string $name): string
     {
         $config = Mage::getConfig();
         switch ($method) {
@@ -54,6 +59,7 @@ private function getClassFromHelperMethod($method, $name)
             case 'helper':
                 return $config->getHelperClassName($name);
         }
+
         throw new ShouldNotHappenException();
     }
 }
diff --git a/src/Type/Mage/HelperMethodsReturnTypeExtension.php b/src/Type/Mage/HelperMethodsReturnTypeExtension.php
@@ -15,7 +15,7 @@
 
 use Mage;
 
-class HelperMethodsReturnTypeExtension implements DynamicStaticMethodReturnTypeExtension
+final class HelperMethodsReturnTypeExtension implements DynamicStaticMethodReturnTypeExtension
 {
     public function getClass(): string
     {
@@ -24,7 +24,7 @@ public function getClass(): string
 
     public function isStaticMethodSupported(MethodReflection $methodReflection): bool
     {
-        return in_array(
+        return \in_array(
             $methodReflection->getName(),
             [
                 'getModel',
@@ -36,6 +36,9 @@ public function isStaticMethodSupported(MethodReflection $methodReflection): boo
         );
     }
 
+    /**
+     * @throws \PHPStan\ShouldNotHappenException
+     */
     public function getTypeFromStaticMethodCall(MethodReflection $methodReflection, StaticCall $methodCall, Scope $scope): Type
     {
         if (!isset($methodCall->args[0]) || !$methodCall->args[0]->value instanceof String_) {
@@ -52,7 +55,10 @@ public function getTypeFromStaticMethodCall(MethodReflection $methodReflection,
         return new ObjectType($class);
     }
 
-    private function getClassFromHelperMethod($method, $name)
+    /**
+     * @throws \PHPStan\ShouldNotHappenException
+     */
+    private function getClassFromHelperMethod(string $method, string $name)
     {
         $config = Mage::getConfig();
         switch ($method) {
@@ -65,6 +71,7 @@ private function getClassFromHelperMethod($method, $name)
             case 'helper':
                 return $config->getHelperClassName($name);
         }
+
         throw new ShouldNotHappenException();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`<?php`
	`2`	`+declare(strict_types=1);`
`2`	`3`
`3`	`4`	`use PHPStanMagento1\Autoload\Magento\ModuleControllerAutoloader;`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -5,43 +5,41 @@`
`5`	`5`
`6`	`6`	`use Mage;`
`7`	`7`	`use ReflectionClass;`
`8`		`-use Exception;`
`9`	`8`
`10`		`-class ModuleControllerAutoloader`
	`9`	`+final class ModuleControllerAutoloader`
`11`	`10`	`{`
`12`		`- /**`
`13`		`- * @var string`
`14`		`- */`
	`11`	`+ /** @var string */`
`15`	`12`	`private $magentoRoot;`
`16`	`13`
	`14`	`+ /** @var string */`
`17`	`15`	`private $codePool;`
`18`	`16`
`19`		`- public function __construct($codePool, $magentoRoot = null)`
	`17`	`+ public function __construct(string $codePool, $magentoRoot = null)`
`20`	`18`	`{`
`21`	`19`	`if (empty($magentoRoot)) {`
`22`	`20`	`$mageClass = new ReflectionClass(Mage::class);`
`23`	`21`	`if ($mageClass->getFileName() !== false) {`
`24`		`- $magentoRoot = dirname($mageClass->getFileName(), 2);`
	`22`	`+ $magentoRoot = \dirname($mageClass->getFileName(), 2);`
`25`	`23`	`} else {`
`26`		`- throw new Exception('Could not find path to Mage class');`
	`24`	`+ throw new \RuntimeException('Could not find path to Mage class');`
`27`	`25`	`}`
`28`	`26`	`}`
`29`	`27`	`$this->codePool = $codePool;`
`30`	`28`	`$this->magentoRoot = $magentoRoot;`
`31`	`29`	`}`
`32`	`30`
`33`		`- public function register()`
	`31`	`+ public function register(): void`
`34`	`32`	`{`
`35`	`33`	`spl_autoload_register([$this, 'autoload']);`
`36`	`34`	`}`
`37`	`35`
`38`		`- public function autoload($className)`
	`36`	`+ public function autoload($className): void`
`39`	`37`	`{`
`40`	`38`	`if (preg_match('/^([a-zA-Z0-9\x7f-\xff])_([a-zA-Z0-9\x7f-\xff])_([a-zA-Z0-9_\x7f-\xff]+)/', $className, $match) === 1) {`
`41`	`39`	`$class = str_replace('_', '/', $match[3]);`
`42`	`40`	`$controllerFilename = sprintf('%s/app/code/%s/%s/%s/controllers/%s.php', $this->magentoRoot, $this->codePool, $match[1], $match[2], $class);`
`43`	`41`	`if (file_exists($controllerFilename)) {`
`44`		`- (function ($file) {`
	`42`	`+ (static function ($file) {`
`45`	`43`	`include $file;`
`46`	`44`	`})($controllerFilename);`
`47`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,13 +9,13 @@`
`9`	`9`
`10`	`10`	`use Varien_Object;`
`11`	`11`
`12`		`-class MagicMethodsReflectionExtension implements MethodsClassReflectionExtension`
	`12`	`+final class MagicMethodsReflectionExtension implements MethodsClassReflectionExtension`
`13`	`13`	`{`
`14`	`14`	`public function hasMethod(ClassReflection $classReflection, string $methodName): bool`
`15`	`15`	`{`
`16`	`16`	`$magentoMagicMethods = ['get', 'set', 'uns', 'has'];`
`17`	`17`	`return $classReflection->isSubclassOf(Varien_Object::class)`
`18`		`- && in_array(substr($methodName, 0, 3), $magentoMagicMethods);`
	`18`	`+ && \in_array(substr($methodName, 0, 3), $magentoMagicMethods, true);`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`public function getMethod(ClassReflection $classReflection, string $methodName): MethodReflection`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,7 @@`
`15`	`15`	`use Mage;`
`16`	`16`	`use Mage_Core_Model_Layout;`
`17`	`17`
`18`		`-`
`19`		`-class HelperMethodsReturnTypeExtension implements DynamicMethodReturnTypeExtension`
	`18`	`+final class HelperMethodsReturnTypeExtension implements DynamicMethodReturnTypeExtension`
`20`	`19`	`{`
`21`	`20`	`public function getClass(): string`
`22`	`21`	`{`
`@@ -25,7 +24,7 @@ public function getClass(): string`
`25`	`24`
`26`	`25`	`public function isMethodSupported(MethodReflection $methodReflection): bool`
`27`	`26`	`{`
`28`		`- return in_array(`
	`27`	`+ return \in_array(`
`29`	`28`	`$methodReflection->getName(),`
`30`	`29`	`[`
`31`	`30`	`'getBlockSingleton',`
`@@ -34,6 +33,9 @@ public function isMethodSupported(MethodReflection $methodReflection): bool`
`34`	`33`	`);`
`35`	`34`	`}`
`36`	`35`
	`36`	`+ /**`
	`37`	`+ * @throws \PHPStan\ShouldNotHappenException`
	`38`	`+ */`
`37`	`39`	`public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type`
`38`	`40`	`{`
`39`	`41`	`if (!isset($methodCall->args[0]) \|\| !$methodCall->args[0]->value instanceof String_) {`
`@@ -45,7 +47,10 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method`
`45`	`47`	`return new ObjectType($class);`
`46`	`48`	`}`
`47`	`49`
`48`		`- private function getClassFromHelperMethod($method, $name)`
	`50`	`+ /**`
	`51`	`+ * @throws \PHPStan\ShouldNotHappenException`
	`52`	`+ */`
	`53`	`+ private function getClassFromHelperMethod(string $method, string $name): string`
`49`	`54`	`{`
`50`	`55`	`$config = Mage::getConfig();`
`51`	`56`	`switch ($method) {`
`@@ -54,6 +59,7 @@ private function getClassFromHelperMethod($method, $name)`
`54`	`59`	`case 'helper':`
`55`	`60`	`return $config->getHelperClassName($name);`
`56`	`61`	`}`
	`62`	`+`
`57`	`63`	`throw new ShouldNotHappenException();`
`58`	`64`	`}`
`59`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`
`16`	`16`	`use Mage;`
`17`	`17`
`18`		`-class HelperMethodsReturnTypeExtension implements DynamicStaticMethodReturnTypeExtension`
	`18`	`+final class HelperMethodsReturnTypeExtension implements DynamicStaticMethodReturnTypeExtension`
`19`	`19`	`{`
`20`	`20`	`public function getClass(): string`
`21`	`21`	`{`
`@@ -24,7 +24,7 @@ public function getClass(): string`
`24`	`24`
`25`	`25`	`public function isStaticMethodSupported(MethodReflection $methodReflection): bool`
`26`	`26`	`{`
`27`		`- return in_array(`
	`27`	`+ return \in_array(`
`28`	`28`	`$methodReflection->getName(),`
`29`	`29`	`[`
`30`	`30`	`'getModel',`
`@@ -36,6 +36,9 @@ public function isStaticMethodSupported(MethodReflection $methodReflection): boo`
`36`	`36`	`);`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ /**`
	`40`	`+ * @throws \PHPStan\ShouldNotHappenException`
	`41`	`+ */`
`39`	`42`	`public function getTypeFromStaticMethodCall(MethodReflection $methodReflection, StaticCall $methodCall, Scope $scope): Type`
`40`	`43`	`{`
`41`	`44`	`if (!isset($methodCall->args[0]) \|\| !$methodCall->args[0]->value instanceof String_) {`
`@@ -52,7 +55,10 @@ public function getTypeFromStaticMethodCall(MethodReflection $methodReflection,`
`52`	`55`	`return new ObjectType($class);`
`53`	`56`	`}`
`54`	`57`
`55`		`- private function getClassFromHelperMethod($method, $name)`
	`58`	`+ /**`
	`59`	`+ * @throws \PHPStan\ShouldNotHappenException`
	`60`	`+ */`
	`61`	`+ private function getClassFromHelperMethod(string $method, string $name)`
`56`	`62`	`{`
`57`	`63`	`$config = Mage::getConfig();`
`58`	`64`	`switch ($method) {`
`@@ -65,6 +71,7 @@ private function getClassFromHelperMethod($method, $name)`
`65`	`71`	`case 'helper':`
`66`	`72`	`return $config->getHelperClassName($name);`
`67`	`73`	`}`
	`74`	`+`
`68`	`75`	`throw new ShouldNotHappenException();`
`69`	`76`	`}`
`70`	`77`	`}`