feat: scramble api docs helper

Author: phpsa

composer.json

@@ -16,13 +16,14 @@
   ],
   "require": {
     "php": "^8.1",
-    "laravel/framework": "^9.0|^10.0|^11.0|^12.0"
+    "laravel/framework": "^10.0|^11.0|^12.0"
   },
   "require-dev": {
     "doctrine/dbal": ">=2.3",
+    "dedoc/scramble": "^0.12.6",
     "mockery/mockery": "^1.0",
-    "nunomaduro/larastan": "^2.0|^3.0",
-    "orchestra/testbench": "^7.0|^8.0|^9.0|^10.0",
+    "larastan/larastan": "^2.0|^3.0",
+    "orchestra/testbench": "^8.0|^9.0|^10.0",
     "phpunit/phpunit": "^9.5|^10.0"
   },
   "autoload": {

phpstan.neon.dist

@@ -1,5 +1,5 @@
 includes:
-    - ./vendor/nunomaduro/larastan/extension.neon
+    - ./vendor/larastan/larastan/extension.neon
     - ./phpstan-baseline.neon
 
 

src/Scramble/ApiResourceOpenApi.php

@@ -51,8 +51,8 @@ public function toSchema(Type $type)
 
         $file_url = $this->getModelPropertyType($type, 'file_url', $scope);
 
-        if (blank($fields)) {
-            $fields = $modelType->getMethodReturnType('toArray', [], $scope)->items;
+        if (blank($fields) && $modelType instanceof ObjectType) {
+            $fields = $modelType->getMethodReturnType('toArray', [], $scope)->items; //@phpstan-ignore property.notFound
         }
 
         //@todo -- check the mapResources property and add those fields to the array
@@ -62,18 +62,9 @@ public function toSchema(Type $type)
         return $this->openApiTransformer->transform($array);
     }
 
-    private function getPropertyDefinitionsFromResource(Type $type): array
-    {
-        $c = new ReflectionClass($type->name);
-
-        return collect(PhpDoc::parse($c->getDocComment())->getPropertyTagValues())->mapWithKeys(function ($value) {
-            return [str($value->propertyName)->replace('$', '')->toString() => new ArrayItemType_(str($value->propertyName)->replace('$', '')->toString(),)];
-        })->toArray();
-    }
-
     private function getPropertyArray(Type $type, string $propertyName, Type $modelType, Scope $scope, bool $isOptional): array
     {
-        $prop = new ReflectionProperty($type->name, $propertyName);
+        $prop = new ReflectionProperty($type->name, $propertyName); //@phpstan-ignore property.notFound
         $val = $prop->getValue();
         if (! is_array($val)) {
             return [];