Custom Plugin for Laravel-api-controller package

[phpsa]

I am building this plugin to be part of the laravel-api-controller package.

Not the best work (yet) but is a work on progress, any feedback, tips or suggestions on improving welcome"

Currently it does the basic job:

• checks if toArray already setup per normal and ignores it
• falls back to our method properties that hold the allowed properties
• falls back to model if mixin defined.

-- wanting to :

1. track the relationships through a mapping
2. track column types from the property

<?php

namespace App\Scramble\Extensions;

use ReflectionProperty;
use Dedoc\Scramble\Infer\Scope\Scope;
use Dedoc\Scramble\Support\Type\Type;
use Dedoc\Scramble\Infer\Scope\GlobalScope;
use Dedoc\Scramble\Support\Type\ObjectType;
use Dedoc\Scramble\Support\Type\TypeHelper;
use Dedoc\Scramble\Support\Type\ArrayItemType_;
use Dedoc\Scramble\Support\Type\KeyedArrayType;
use Dedoc\Scramble\Extensions\TypeToSchemaExtension;
use Dedoc\Scramble\Support\Generator\Types\ArrayType;
use Dedoc\Scramble\Support\Helpers\JsonResourceHelper;
use Illuminate\Http\Resources\Json\ResourceCollection;
use Dedoc\Scramble\Support\Generator\Types\UnknownType;
use Dedoc\Scramble\Infer\Services\ReferenceTypeResolver;
use Phpsa\LaravelApiController\Http\Resources\ApiResource;
use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
use Dedoc\Scramble\Support\Type\UnknownType as UnknownTypeObject;
use Dedoc\Scramble\Support\Type\Reference\MethodCallReferenceType;
use Dedoc\Scramble\Support\Type\Reference\PropertyFetchReferenceType;
use Dedoc\Scramble\Support\InferExtensions\ResourceCollectionTypeInfer;
use Dedoc\Scramble\Support\PhpDoc;
use Dedoc\Scramble\Support\TypeToSchemaExtensions\JsonResourceTypeToSchema;
use ReflectionClass;

class ApiResourceOpenApi extends JsonResourceTypeToSchema
{
    public function shouldHandle(Type $type): bool
    {

        return $type instanceof ObjectType
        && $type->isInstanceOf(ApiResource::class)
        && ! $type->isInstanceOf(AnonymousResourceCollection::class);
    }

    public function toSchema(Type $type)
    {
        $x = $this->infer->analyzeClass($type->name);

        $scope = new GlobalScope();

        $modelType = JsonResourceHelper::modelType($scope->index->getClassDefinition($type->name), $scope);

       /** @var \Dedoc\Scramble\Support\Type\ObjectType $type */

        $array = $type->getMethodDefinition('toArray')
        ?->type
        ?->getReturnType();

        if ($array && ! $array instanceof UnknownTypeObject) {
            return $this->openApiTransformer->transform($array);
        }

        $fields = [...$this->getPropertyArray($type, 'allowedFields', $modelType, $scope, true), ...$this->getPropertyArray($type, 'defaultFields', $modelType, $scope, false)];

        $file_url = $this->getModelPropertyType($type, 'file_url', $scope);

        if (blank($fields)) {
            $fields =  $modelType->getMethodReturnType('toArray', [], $scope)->items;
        }

        //@todo -- check the mapResources property and add those fields to the array

        $array = new KeyedArrayType(array_values($fields));

        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);
        $val = $prop->getValue();
        if (! is_array($val)) {
            return [];
        }
        return collect($val)->mapWithKeys(function ($item) use ($modelType, $scope, $isOptional) {
            return [$item => new ArrayItemType_($item, $this->getModelPropertyType($modelType, $item, $scope), $isOptional) ];
        })->toArray();
    }

    private function getModelPropertyType(Type $modeltype, string $name, $scope): Type
    {
        return ReferenceTypeResolver::getInstance()->resolve(
            $scope,
            new PropertyFetchReferenceType(
                $modeltype,
                $name,
            ),
        );
    }
}

[romalytvynenko]

@phpsa this is awesome! Please let me know if you have any feedback about your experience of developing such extensions – I will be happy to improve Scramble's DX!