Import project files

Author: andytson-inviqa

.gitignore

@@ -0,0 +1,2 @@
+/composer.lock
+/vendor/

README.md

@@ -0,0 +1,32 @@
+# phpstan-magento1 extension
+
+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 also with phpstan/phpstan-shim.
+
+By default phpstan with this extension will test public/app/code/local only.
+
+## Usage
+
+Add `phpstan.neon` to your Magento 1 project.
+
+Make sure it has
+
+```neon
+includes:
+	- vendor/inviqa/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:
+
+```bash
+composer require inviqa/phpstan-magento2 phpstan/phpstan
+```
+
+With uncoupled phar package:
+
+```bash
+composer require inviqa/phpstan-magento2 phpstan/phpstan-shim
+```

composer.json

@@ -0,0 +1,14 @@
+{
+    "name": "inviqa/phpstan-magento1",
+    "description": "Extension for PHPStan to allow analysis of Magento 1 code.",
+    "type": "library",
+    "require": {
+        "phpstan/phpstan": "0.11.*"
+    },
+	"autoload": {
+		"psr-4": {
+			"PHPStanMagento1\\": "src/"
+		}
+	},
+    "license": "MIT"
+}

extension.neon

@@ -0,0 +1,18 @@
+parameters:
+    vendor_path: %currentWorkingDirectory%/vendor
+    paths:
+        - %currentWorkingDirectory%/public/app/code/local
+    bootstrap: %vendor_path%/inviqa/phpstan-magento1/phpstan-bootstrap.php
+    excludes_analyse:
+        - %currentWorkingDirectory%/public/app/code/local/*/*/data/*
+        - %currentWorkingDirectory%/public/app/code/local/*/*/sql/*
+
+services:
+    -
+        class: PHPStanMagento1\Type\Mage\HelperMethodsReturnTypeExtension
+        tags:
+            - phpstan.broker.dynamicStaticMethodReturnTypeExtension
+    -
+        class: PHPStanMagento1\Reflection\Varien\Object\MagicMethodsReflectionExtension
+        tags:
+            - phpstan.broker.methodsClassReflectionExtension

phpstan-bootstrap.php

@@ -0,0 +1,11 @@
+<?php
+
+if (!class_exists('Mage')) {
+    require_once __DIR__ . '/../../../public/app/Mage.php';
+}
+
+// workaround Magento's use of date phpdoc typehint for string type
+// better would be to implement the typehint to make it appear string type
+class date {}
+
+Mage::app();

src/Reflection/Varien/Object/MagicMethodReflection.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace PHPStanMagento1\Reflection\Varien\Object;
+
+use PHPStan\Reflection\ClassMemberReflection;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\TrivialParametersAcceptor;
+
+class MagicMethodReflection implements MethodReflection
+{
+    /**
+     * @var ClassReflection
+     */
+    private $declaringClass;
+
+    public function __construct(ClassReflection $declaringClass, string $name)
+    {
+        $this->declaringClass = $declaringClass;
+        $this->name = $name;
+    }
+
+    public function getDeclaringClass(): ClassReflection
+    {
+        return $this->declaringClass;
+    }
+
+    public function getPrototype(): ClassMemberReflection
+    {
+        return $this;
+    }
+
+    public function isStatic(): bool
+    {
+        return false;
+    }
+
+    public function isPrivate(): bool
+    {
+        return false;
+    }
+
+    public function isPublic(): bool
+    {
+        return true;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+	/**
+	 * @return \PHPStan\Reflection\ParametersAcceptor[]
+	 */
+	public function getVariants(): array
+	{
+		return [
+			new TrivialParametersAcceptor(),
+		];
+	}
+}

src/Reflection/Varien/Object/MagicMethodsReflectionExtension.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace PHPStanMagento1\Reflection\Varien\Object;
+
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\MethodsClassReflectionExtension;
+
+use Varien_Object;
+
+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);
+    }
+
+    public function getMethod(ClassReflection $classReflection, string $methodName): MethodReflection
+    {
+        return new MagicMethodReflection($classReflection, $methodName);
+    }
+}

src/Type/Mage/HelperMethodsReturnTypeExtension.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace PHPStanMagento1\Type\Mage;
+
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\DynamicStaticMethodReturnTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+
+use Mage;
+
+class HelperMethodsReturnTypeExtension implements DynamicStaticMethodReturnTypeExtension
+{
+    public function getClass(): string
+    {
+        return Mage;
+    }
+
+    public function isStaticMethodSupported(MethodReflection $methodReflection): bool
+    {
+        return in_array(
+            $methodReflection->getName(),
+            [
+                'getModel',
+                'getResourceModel',
+                'getResourceSingleton',
+                'getSingleton',
+                'helper',
+            ]
+        );
+    }
+
+    public function getTypeFromStaticMethodCall(MethodReflection $methodReflection, StaticCall $methodCall, Scope $scope): Type
+    {
+        if (!isset($methodCall->args[0]) || !$methodCall->args[0]->value instanceof String_) {
+            throw new ShouldNotHappenException();
+        }
+
+        $name = $methodCall->args[0]->value->value;
+        $class = $this->getClassFromHelperMethod($methodReflection->getName(), $name);
+        return new ObjectType($class);
+    }
+
+    private function getClassFromHelperMethod($method, $name)
+    {
+        $config = Mage::getConfig();
+        switch ($method) {
+            case 'getModel':
+            case 'getSingleton':
+                return $config->getModelClassName($name);
+            case 'getResourceModel':
+            case 'getResourceSingleton':
+                return $config->getModelClassName($name);
+            case 'helper':
+                return $config->getHelperClassName($name);
+        }
+        throw new ShouldNotHappenException();
+    }
+}