Merge pull request #3 from TebexOllie/phpstan

Add PHPStan compatibility

composer.json

@@ -15,7 +15,8 @@
   "require-dev": {
     "phpunit/phpunit": "^7.0.0",
     "squizlabs/php_codesniffer" : "^3.0.0",
-    "phpunit/php-code-coverage": "^6.0.0"
+    "phpunit/php-code-coverage": "^6.0.0",
+    "phpstan/phpstan": "^1.10"
   },
   "autoload": {
     "psr-4": {

extension.neon

@@ -0,0 +1,5 @@
+services:
+	-
+		class: LiamWiltshire\LaravelModelMeta\PHPStan\ModelAttributeExtension
+		tags:
+			- phpstan.broker.propertiesClassReflectionExtension

src/PHPStan/MetaProperty.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace LiamWiltshire\LaravelModelMeta\PHPStan;
+
+use Illuminate\Database\Eloquent\Model;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\PropertiesClassReflectionExtension;
+use PHPStan\Reflection\PropertyReflection;
+use PHPStan\TrinaryLogic;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+
+class MetaProperty implements PropertyReflection
+{
+
+    private $classReflection;
+    private $propertyName;
+
+    public function __construct(ClassReflection $classReflection, string $propertyName)
+    {
+        $this->classReflection = $classReflection;
+        $this->propertyName = $propertyName;
+    }
+
+    public function isStatic(): bool
+    {
+        return false;
+    }
+
+    public function isPrivate(): bool
+    {
+        return false;
+    }
+
+    public function isPublic(): bool
+    {
+        return true;
+    }
+
+    public function isReadable(): bool
+    {
+        return true;
+    }
+
+    public function isWritable(): bool
+    {
+        return true;
+    }
+
+    public function isDeprecated(): TrinaryLogic
+    {
+        return false;
+    }
+
+    public function isInternal(): TrinaryLogic
+    {
+        return false;
+    }
+
+    public function canChangeTypeAfterAssignment(): bool
+    {
+        return true;
+    }
+
+    public function getReadableType(): Type
+    {
+        return new MixedType();
+    }
+
+    public function getWritableType(): Type
+    {
+        return new MixedType();
+    }
+
+    public function getDeclaringClass(): \PHPStan\Reflection\ClassReflection
+    {
+        return $this->classReflection;
+    }
+
+    public function getPropertyName(): string
+    {
+        return $this->propertyName;
+    }
+
+    public function getDocComment(): ?string
+    {
+        return null;
+    }
+
+    public function getDeprecatedDescription(): ?string
+    {
+        return null;
+    }
+}

src/PHPStan/ModelAttributeExtension.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace LiamWiltshire\LaravelModelMeta\PHPStan;
+
+use Illuminate\Database\Eloquent\Model;
+use LiamWiltshire\LaravelModelMeta\Concerns\HasMeta;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\PropertiesClassReflectionExtension;
+use PHPStan\Reflection\PropertyReflection;
+use Tebex\Checkout\Models\RecurringPayment;
+
+class ModelAttributeExtension implements PropertiesClassReflectionExtension
+{
+    public function hasProperty(ClassReflection $classReflection, string $propertyName): bool
+    {
+        foreach ($classReflection->getTraits() as $trait) {
+            if ($trait->getName() === (string)HasMeta::class) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public function getProperty(ClassReflection $classReflection, string $propertyName): PropertyReflection
+    {
+        return new MetaProperty($classReflection, $propertyName);
+    }
+}