Alimentalos/Backend

View on GitHub
app/Http/Controllers/Resource/Nested/IndexController.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php

namespace App\Http\Controllers\Resource\Nested;

use App\Contracts\Resource;
use App\Http\Controllers\Controller;
use App\Http\Requests\Resource\Resource\IndexRequest;
use Illuminate\Http\JsonResponse;

class IndexController extends Controller
{
    /**
     * @OA\Get(
     *      path="/{resource}/{uuid}/{nested}",
     *      operationId="getNestedResourcesOfResource",
     *      tags={"Resources", "Nested Resources"},
     *      summary="Get nested resources of resource.",
     *      description="Returns the nested resources of a resource paginated by a default quantity, payload includes pagination links and stats.",
     *      @OA\Parameter(
     *          name="uuid",
     *          description="Unique identifier of resource",
     *          required=true,
     *          in="path",
     *          @OA\Schema(
     *              type="string"
     *          )
     *      ),
     *     @OA\Parameter(
     *         name="resource",
     *         in="path",
     *         description="Resource type that need to be considered",
     *         required=true,
     *         @OA\Schema(
     *         type="string",
     *           @OA\Items(
     *               type="string",
     *               enum={"users", "groups", "alerts", "devices", "geofences", "pets", "actions", "photos"},
     *               default="users"
     *           ),
     *         )
     *     ),
     *     @OA\Parameter(
     *         name="nested",
     *         in="path",
     *         description="Nested type that need to be considered",
     *         required=true,
     *         @OA\Schema(
     *         type="string",
     *           @OA\Items(
     *               type="string",
     *               enum={"users", "groups", "geofences", "devices", "pets", "photos", "places"},
     *               default="users"
     *           ),
     *         )
     *     ),
     *      @OA\Response(
     *          response=200,
     *          description="Nested resources retrieved successfully"
     *       ),
     *      @OA\Response(response=400, description="Bad request")
     * )
     * Get nested resources of resource paginated.
     *
     * @param IndexRequest $request
     * @param Resource $resource
     * @param Resource $nested
     * @return JsonResponse
     */
    public function __invoke(IndexRequest $request, Resource $resource, $nested)
    {
        if ($nested === 'reactions') {
            $nestedInstances = reactions()->index($resource);
        } else {
            $nestedInstances = $resource->{$nested}()->latest()->paginate(20);
            $nestedInstances->load(finder()->findClass($nested)->getLazyRelationshipsAttribute());
        }
        return response()->json($nestedInstances,200);
    }
}