feat: add in support for nested api controllers

Author: athphane

Diff for: src/Concerns/IsApiController.php

@@ -0,0 +1,311 @@
+<?php
+
+namespace Javaabu\QueryBuilder\Concerns;
+
+use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Foundation\Bus\DispatchesJobs;
+use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Http\Request;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
+use Illuminate\Validation\ValidationException;
+use Javaabu\QueryBuilder\QueryBuilder;
+use Spatie\QueryBuilder\QueryBuilderRequest;
+
+trait IsApiController
+{
+    use AuthorizesRequests;
+    use ValidatesRequests;
+    use DispatchesJobs;
+
+    /**
+     * Query builder request
+     *
+     * @var QueryBuilderRequest
+     */
+    protected $query_request;
+
+    protected array $additional_params = [];
+
+    /**
+     * Unlimited per page
+     *
+     * @return bool
+     */
+    protected function allowUnlimitedResultsPerPage(): bool
+    {
+        return property_exists($this, 'allow_unlimited_results') ? $this->allow_unlimited_results : false;
+    }
+
+    /**
+     * Check if the request wants all the results
+     *
+     * @param Request $request
+     * @return bool
+     */
+    protected function wantsAllResults(Request $request): bool
+    {
+        return $request->input('per_page') == -1;
+    }
+
+    /**
+     * Get per page
+     *
+     * @param Request $request
+     * @param int $default
+     * @return int
+     */
+    protected function getPerPage(Request $request, int $default = 0)
+    {
+        return abs($request->input('per_page', $default));
+    }
+
+    /**
+     * Display a listing of the resource.
+     *
+     * @param Request $request
+     * @return QueryBuilder[]|LengthAwarePaginator|\Illuminate\Database\Eloquent\Collection|\Spatie\QueryBuilder\QueryBuilder[]
+     * @throws ValidationException
+     */
+    protected function indexEndpoint(Request $request)
+    {
+
+        $this->validate($request, $this->getIndexValidation());
+
+        $query = QueryBuilder::for($this->getBaseQuery());
+
+        if ($default_sort = $this->getDefaultSort()) {
+            $query->defaultSort($default_sort);
+        }
+
+        $query->allowedSorts($this->getAllowedSorts())
+            ->allowedFilters($this->getAllowedFilters())
+            ->allowedAppends($this->getAllowedAppends())
+            ->fieldsToAlwaysInclude($this->getFieldsToAlwaysInclude())
+            ->allowedFields($this->getAllowedFields())
+            ->allowedIncludes($this->getAllowedIncludes());
+
+        $query = $this->modifyQuery($query);
+
+        if ($this->allowUnlimitedResultsPerPage() && $this->wantsAllResults($request)) {
+            return $query->get();
+        }
+
+        return $query->paginate($this->getPerPage($request, 10))
+            ->appends($request->except(['page']));
+    }
+
+    /**
+     * Display a single resource.
+     *
+     * @param $model_id
+     * @param Request $request
+     * @return \Illuminate\Database\Eloquent\Collection|Model|QueryBuilder|QueryBuilder[]|null
+     * @throws ValidationException
+     */
+    protected function showEndpoint($model_id, Request $request)
+    {
+        $this->validate($request, $this->getShowValidation());
+
+        try {
+            $model = QueryBuilder::for($this->getBaseQuery())
+                ->allowedAppends($this->getAllShowAllowedAppends())
+                ->fieldsToAlwaysInclude($this->getFieldsToAlwaysInclude())
+                ->allowedFields($this->getAllowedFields())
+                ->allowedIncludes($this->getAllowedIncludes());
+
+            $model = $this->modifyQuery($model)->findOrFail($model_id);
+
+            $this->authorizeView($model);
+
+            return $this->modifyModel($model);
+        } catch (ModelNotFoundException $e) {
+            abort(404, 'Not Found');
+        }
+    }
+
+    public function setAdditionalParams(mixed $params): self
+    {
+        $this->additional_params = is_array($params) ? $params : func_get_args();
+
+        return $this;
+    }
+
+    public function getAdditionalParams(string $key = null): mixed
+    {
+        return $key ? $this->additional_params[$key] ?? null : $this->additional_params;
+    }
+
+    /**
+     * Modify the model
+     */
+    public function modifyModel(Model $model): Model
+    {
+        return $model;
+    }
+
+    /**
+     * Check if allowed to view
+     *
+     * @param Model $model
+     */
+    protected function authorizeView(Model $model): void
+    {
+        return;
+    }
+
+    /**
+     * Get the index validation
+     */
+    protected function getIndexValidation(): array
+    {
+        return [
+            'per_page' => "integer|" . ($this->allowUnlimitedResultsPerPage() ? 'min:-1' : 'between:1,50'),
+            'page' => 'integer|min:1',
+        ];
+    }
+
+    /**
+     * Get the fields to always include
+     */
+    protected function getFieldsToAlwaysInclude(): array
+    {
+        return [
+            'id'
+        ];
+    }
+
+    /**
+     * Get the index allowed fields
+     */
+    protected function getIndexAllowedFields(): array
+    {
+        return $this->getAllowedFields();
+    }
+
+    /**
+     * Get the show validation
+     */
+    protected function getShowValidation(): array
+    {
+        return [];
+    }
+
+    /**
+     * Get the query request
+     *
+     * @return QueryBuilderRequest
+     */
+    protected function getQueryRequest(): QueryBuilderRequest
+    {
+        return $this->query_request;
+    }
+
+    /**
+     * Get the query fields
+     *
+     * @return Collection
+     */
+    protected function fields(): Collection
+    {
+        return $this->getQueryRequest()->fields();
+    }
+
+    /**
+     * Get the query appends
+     *
+     * @return Collection
+     */
+    protected function appends(): Collection
+    {
+        return $this->getQueryRequest()->appends();
+    }
+
+    /**
+     * Get the query includes
+     *
+     * @return Collection
+     */
+    protected function includes(): Collection
+    {
+        return $this->getQueryRequest()->includes();
+    }
+
+    /**
+     * Get the query sorts
+     *
+     * @return Collection
+     */
+    protected function sorts(): Collection
+    {
+        return $this->getQueryRequest()->sorts();
+    }
+
+    /**
+     * Get the query filters
+     *
+     * @return Collection
+     */
+    protected function filters(): Collection
+    {
+        return $this->getQueryRequest()->filters();
+    }
+
+    /**
+     * Modify the query after adding query builder params
+     *
+     * @param \Spatie\QueryBuilder\QueryBuilder $query
+     * @return QueryBuilder
+     */
+    protected function modifyQuery(\Spatie\QueryBuilder\QueryBuilder $query): \Spatie\QueryBuilder\QueryBuilder
+    {
+        return $query;
+    }
+
+    /**
+     * Get the allowed append attributes
+     *
+     * @return array
+     */
+    protected function getAllowedAppendAttributes(): array
+    {
+        return Arr::rootKeys($this->getAllowedAppends());
+    }
+
+    /**
+     * Get the allowed append attributes
+     *
+     * @return array
+     */
+    protected function getShowAllowedAppendAttributes(): array
+    {
+        return Arr::rootKeys($this->getAllShowAllowedAppends());
+    }
+
+    /**
+     * Get the show allowed appends
+     */
+    protected function getAllShowAllowedAppends(): array
+    {
+        if (! $this->getShowAllowedAppends()) {
+            return $this->getAllowedAppends();
+        }
+
+        return array_merge(
+            $this->getAllowedAppends(),
+            $this->getShowAllowedAppends()
+        );
+    }
+
+
+    /**
+     * Get the allowed appends for only show endpoint
+     */
+    protected function getShowAllowedAppends(): array
+    {
+        return [];
+    }
+}

Diff for: src/Http/Controllers/ApiBaseController.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Javaabu\QueryBuilder\Http\Controllers;
+
+use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller as BaseController;
+use Illuminate\Validation\ValidationException;
+use Javaabu\QueryBuilder\Concerns\IsApiController;
+use Javaabu\QueryBuilder\QueryBuilder;
+use Spatie\QueryBuilder\QueryBuilderRequest;
+
+abstract class ApiBaseController extends BaseController
+{
+    use IsApiController;
+
+    /**
+     * Constructor
+     *
+     * @param QueryBuilderRequest $request
+     */
+    public function __construct(QueryBuilderRequest $request)
+    {
+        $this->query_request = $request;
+    }
+
+    /**
+     * Get the base query
+     */
+    protected abstract function getBaseQuery(): Builder;
+
+    /**
+     * Get the fields
+     */
+    protected abstract function getAllowedFields(): array;
+
+    /**
+     * Get the includes
+     */
+    protected abstract function getAllowedIncludes(): array;
+
+    /**
+     * Get the allowed appends
+     */
+    protected abstract function getAllowedAppends(): array;
+
+    /**
+     * Get the allowed sorts
+     */
+    protected abstract function getAllowedSorts(): array;
+
+    /**
+     * Get the default sort
+     */
+    protected abstract function getDefaultSort(): string;
+
+    /**
+     * Get the allowed filters
+     */
+    protected abstract function getAllowedFilters(): array;
+}