File "ApiResourceResponseTools.php"

Full Path: /var/www/html/back/vendor/knuckleswtf/scribe/src/Extracting/Shared/ApiResourceResponseTools.php
File size: 5.19 KB
MIME-type: text/x-php
Charset: utf-8

<?php

namespace Knuckles\Scribe\Extracting\Shared;

use Exception;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Http\Resources\Json\ResourceCollection;
use Illuminate\Pagination\CursorPaginator;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Pagination\Paginator;
use Illuminate\Support\Arr;
use Knuckles\Camel\Extraction\ExtractedEndpointData;
use Knuckles\Scribe\Tools\ConsoleOutputUtils as c;
use Knuckles\Scribe\Tools\ErrorHandlingUtils as e;
use Knuckles\Scribe\Tools\Utils;
use Mpociot\Reflection\DocBlock;
use Mpociot\Reflection\DocBlock\Tag;
use ReflectionClass;

class ApiResourceResponseTools
{
    public static function fetch(
        string $apiResourceClass, bool $isCollection, ?callable $modelInstantiator,
        ExtractedEndpointData $endpointData, array $pagination, array $additionalData
    )
    {
        $resource = static::getApiResourceOrCollectionInstance(
            $apiResourceClass, $isCollection, $modelInstantiator, $pagination, $additionalData
        );
        $response = static::callApiResourceAndGetResponse($resource, $endpointData);
        return $response->getContent();
    }

    public static function callApiResourceAndGetResponse(JsonResource $resource, ExtractedEndpointData $endpointData): JsonResponse
    {
        $uri = Utils::getUrlWithBoundParameters($endpointData->route->uri(), $endpointData->cleanUrlParameters);
        $method = $endpointData->route->methods()[0];
        $request = Request::create($uri, $method);
        $request->headers->add(['Accept' => 'application/json']);
        // Set the route properly, so it works for users who have code that checks for the route.
        $request->setRouteResolver(fn() => $endpointData->route);

        $previousBoundRequest = app('request');
        app()->bind('request', fn() => $request);

        $response = $resource->toResponse($request);

        app()->bind('request', fn() => $previousBoundRequest);

        return $response;
    }

    public static function getApiResourceOrCollectionInstance(
        string $apiResourceClass, bool $isCollection, ?callable $modelInstantiator,
        array $paginationStrategy = [], array $additionalData = []
    ): JsonResource
    {
        // If the API Resource uses an empty $resource (e.g. an empty array), the $modelInstantiator will be null
        // See https://github.com/knuckleswtf/scribe/issues/652
        $modelInstance = is_callable($modelInstantiator) ? $modelInstantiator() : [];
        try {
            $resource = new $apiResourceClass($modelInstance);
        } catch (Exception) {
            // If it is a ResourceCollection class, it might throw an error
            // when trying to instantiate with something other than a collection
            $resource = new $apiResourceClass(collect([$modelInstance]));
        }

        if ($isCollection) {
            // Collections can either use the regular JsonResource class (via `::collection()`,
            // or a ResourceCollection (via `new`)
            // See https://laravel.com/docs/5.8/eloquent-resources
            $models = [$modelInstance, $modelInstantiator()];
            // Pagination can be in two forms:
            // [15] : means ::paginate(15)
            // [15, 'simple'] : means ::simplePaginate(15)
            if (count($paginationStrategy) == 1) {
                $perPage = $paginationStrategy[0];
                $paginator = new LengthAwarePaginator(
                // For some reason, the LengthAware paginator needs only first page items to work correctly
                    collect($models)->slice(0, $perPage), count($models), $perPage
                );
                $list = $paginator;
            } elseif (count($paginationStrategy) == 2 && $paginationStrategy[1] == 'simple') {
                $perPage = $paginationStrategy[0];
                $paginator = new Paginator($models, $perPage);
                $list = $paginator;
            } elseif (count($paginationStrategy) == 2 && $paginationStrategy[1] == 'cursor') {
                $perPage = $paginationStrategy[0];
                $paginator = new CursorPaginator($models, $perPage);
                $list = $paginator;
            } else {
                $list = collect($models);
            }
            /** @var JsonResource $resource */
            $resource = $resource instanceof ResourceCollection
                ? new $apiResourceClass($list) : $apiResourceClass::collection($list);
        }

        return $resource->additional($additionalData);
    }

    /**
     * Check if the ApiResource class has an `@mixin` docblock, and fetch the model from there.
     */
    public static function tryToInferApiResourceModel(string $apiResourceClass): string|null
    {
        $class = new ReflectionClass($apiResourceClass);
        $docBlock = new DocBlock($class->getDocComment() ?: '');
        /** @var Tag|null $mixinTag */
        $mixinTag = Arr::first(Utils::filterDocBlockTags($docBlock->getTags(), 'mixin'));
        if (empty($mixinTag) || empty($modelClass = trim($mixinTag->getContent()))) {
            return null;
        }

        if (class_exists($modelClass)) {
            return $modelClass;
        }

        return null;
    }
}