JsonApiController::resolvePaginationParameters() - Code Metrics - Inspection of "Update controller to support offset-based paginati..." - huntie/laravel-simple-jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — pagination-options ( 1b40e9...7eb413 )

by Alex

created 2017-04-18 21:52 UTC

JsonApiController::resolvePaginationParameters() A

↳ Parent: JsonApiController

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

<?php

namespace Huntie\JsonApi\Http\Controllers;

use Validator;
use Huntie\JsonApi\Contracts\Model\IncludesRelatedResources;
use Huntie\JsonApi\Exceptions\HttpException;
use Huntie\JsonApi\Exceptions\InvalidRelationPathException;
use Huntie\JsonApi\Http\JsonApiResponse;
use Huntie\JsonApi\Http\Concerns\QueriesResources;
use Huntie\JsonApi\Http\Concerns\UpdatesModelRelations;
use Huntie\JsonApi\Serializers\CollectionSerializer;
use Huntie\JsonApi\Serializers\RelationshipSerializer;
use Huntie\JsonApi\Serializers\ResourceSerializer;
use Huntie\JsonApi\Support\JsonApiErrors;
use Illuminate\Database\QueryException;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Routing\Controller;
use Illuminate\Validation\ValidationException;

abstract class JsonApiController extends Controller
{
    use JsonApiErrors;
    use QueriesResources;
    use UpdatesModelRelations;
    use AuthorizesRequests;
    use ValidatesRequests;

    /**
     * The Eloquent Model for the resource.
     *
     * @var Model|string
     */
    protected $model;

    /**
     * Create a new JsonApiController instance.
     */
    public function __construct()
    {
        if (is_string($this->model)) {
            if (!is_subclass_of($this->model, Model::class)) {
                $this->model = str_finish(config('jsonapi.model_namespace', app()->getNamespace()), '\\')
                    . preg_replace('/Controller$/', '', class_basename($this));
            }

            $this->model = new $this->model;
        }
    }

    /**
     * Return a listing of the resource.
     *
     * @param Request                                    $request
     * @param \Illuminate\Database\Eloquent\Builder|null $query   Custom resource query
     *
     * @return JsonApiResponse
     */
    public function indexAction(Request $request, $query = null)
    {
        $records = $query ?: $this->model->newQuery();
        $params = $this->getRequestParameters($request);
        $this->validateIncludableRelations($params['include']);

        try {
            $records = $this->sortQuery($records, $params['sort']);
            $records = $this->filterQuery($records, $params['filter']);
            $page = $this->resolvePaginationParameters($request);

            $records = $records->paginate($page['size'], null, null, $page['number']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } catch (QueryException $e) {
            return $this->error(Response::HTTP_BAD_REQUEST, 'Invalid query parameters');
        }

        return new JsonApiResponse(new CollectionSerializer($records, $params['fields'], $params['include']));
    }

    /**
     * Store a new record.
     *
     * @param Request $request
     *
     * @return JsonApiResponse
     */
    public function storeAction(Request $request)
    {
        $record = $this->model->create((array) $request->input('data.attributes'));

        if ($relationships = $request->input('data.relationships')) {
            $this->updateResourceRelationships($record, (array) $relationships);
        }

        return new JsonApiResponse(new ResourceSerializer($record), Response::HTTP_CREATED);
    }

    /**
     * Return a specified record.
     *
     * @param Request     $request
     * @param Model|mixed $record
     *
     * @return JsonApiResponse
     */
    public function showAction(Request $request, $record)
    {
        $record = $this->findModelInstance($record);
        $params = $this->getRequestParameters($request);
        $this->validateIncludableRelations($params['include']);

        return new JsonApiResponse(new ResourceSerializer($record, $params['fields'], $params['include']));
    }

    /**
     * Update a specified record.
     *
     * @param Request     $request
     * @param Model|mixed $record
     *
     * @return JsonApiResponse
     */
    public function updateAction(Request $request, $record)
    {
        $record = $this->findModelInstance($record);
        $record->fill((array) $request->input('data.attributes'));
        $record->save();

        if ($relationships = $request->input('data.relationships')) {
            $this->updateResourceRelationships($record, (array) $relationships);
        }

        return new JsonApiResponse(new ResourceSerializer($record));
    }

    /**
     * Destroy a specified record.
     *
     * @param Request     $request
     * @param Model|mixed $record
     *
     * @return JsonApiResponse
     */
    public function destroyAction(Request $request, $record)

    {
        $record = $this->findModelInstance($record);
        $record->delete();

        return new JsonApiResponse(null, Response::HTTP_NO_CONTENT);
    }

    /**
     * Return a specified record relationship.
     *
     * @param Request     $request
     * @param Model|mixed $record
     * @param string      $relation
     *
     * @return JsonApiResponse
     */
    public function showRelationshipAction(Request $request, $record, $relation)

    {
        $record = $this->findModelInstance($record);

        return new JsonApiResponse(new RelationshipSerializer($record, $relation));
    }

    /**
     * Update a named relationship on a specified record.
     *
     * http://jsonapi.org/format/#crud-updating-relationships
     *
     * @param Request     $request
     * @param Model|mixed $record
     * @param string      $relation
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *
     * @return JsonApiResponse
     */
    public function updateRelationshipAction(Request $request, $record, $relation)
    {
        $relationType = $this->getRelationType($relation);
        abort_unless(is_string($relationType) && $this->isFillableRelation($relation), Response::HTTP_NOT_FOUND);

        $record = $this->findModelInstance($record);
        $data = (array) $request->input('data');

        if ($relationType === 'To-One') {
            $this->updateToOneResourceRelationship($record, $relation, $data);
        } else if ($relationType === 'To-Many') {
            $this->updateToManyResourceRelationship($record, $relation, $data, $request->method());
        }

        return new JsonApiResponse(new RelationshipSerializer($record, $relation));
    }

    /**
     * Return existing instance of the resource or find by primary key.
     *
     * @param Model|mixed $record
     *
     * @throws ModelNotFoundException
     *
     * @return Model
     */
    protected function findModelInstance($record)
    {
        if ($record instanceof Model) {
            if (is_null($record->getKey())) {
                throw new ModelNotFoundException();
            }

            return $record;
        }

        return $this->model->findOrFail($record);
    }

    /**
     * Return any JSON API resource parameters from a request.
     *
     * @param Request $request
     *
     * @return array
     */
    protected function getRequestParameters($request)
    {
        $enableIncluded = config('jsonapi.enable_included_resources');

        if ($request->has('include') && is_bool($enableIncluded) && !$enableIncluded) {
            throw new HttpException('Inclusion of related resources is not supported');
        }

        return [
            'fields' => $this->getRequestQuerySet($request, 'fields', '/^([A-Za-z]+.?)+[A-Za-z]+$/'),
            'include' => $this->getRequestQuerySet($request, 'include', '/^([A-Za-z]+.?)+[A-Za-z]+$/'),
            'sort' => $this->getRequestQuerySet($request, 'sort', '/[A-Za-z_]+/'),
            'filter' => (array) $request->input('filter'),
        ];
    }

    /**
     * Return any comma separated values in a request query field as an array.
     *
     * @param Request     $request
     * @param string      $key
     * @param string|null $validate Regular expression to test for each item
     *
     * @throws \Illuminate\Validation\ValidationException
     *
     * @return array
     */
    protected function getRequestQuerySet($request, $key, $validate = null)
    {
        $values = preg_split('/,/', $request->input($key), null, PREG_SPLIT_NO_EMPTY);

        $validator = Validator::make(['param' => $values], [
            'param.*' => 'required' . ($validate ? '|regex:' . $validate : ''),
        ]);

        if ($validator->fails()) {
            throw new ValidationException($validator, $this->error(
                Response::HTTP_BAD_REQUEST,
                sprintf('Invalid values for "%s" parameter', $key))
            );
        }

        return $values;
    }

    /**
     * Validate the requested included relationships against those that are
     * allowed on the requested resource type.
     *
     * @param array|null $relations
     *
     * @throws InvalidRelationPathException
     */
    protected function validateIncludableRelations($relations)
    {
        if (is_null($relations)) {
            return;
        }

        foreach ($relations as $relation) {
            if (!$this->model instanceof IncludesRelatedResources || !in_array($relation, $this->model->getIncludableRelations())) {

                throw new InvalidRelationPathException($relation);
            }
        }
    }

    /**
     * Return the page number and page size to use for paginated results.
     *
     * @param \Illuminate\Http\Request $request
     */
    protected function resolvePaginationParameters($request): array
    {
        return [
            'page' => $request->input('page.number', $request->input('page.offset', 0) / 10 + 1),
            'size' => $request->input('page.size', $request->input('page.limit', $this->model->getPerPage())),
        ];
    }
}


1			<?php
2
3			namespace Huntie\JsonApi\Http\Controllers;
4
5			use Validator;
6			use Huntie\JsonApi\Contracts\Model\IncludesRelatedResources;
7			use Huntie\JsonApi\Exceptions\HttpException;
8			use Huntie\JsonApi\Exceptions\InvalidRelationPathException;
9			use Huntie\JsonApi\Http\JsonApiResponse;
10			use Huntie\JsonApi\Http\Concerns\QueriesResources;
11			use Huntie\JsonApi\Http\Concerns\UpdatesModelRelations;
12			use Huntie\JsonApi\Serializers\CollectionSerializer;
13			use Huntie\JsonApi\Serializers\RelationshipSerializer;
14			use Huntie\JsonApi\Serializers\ResourceSerializer;
15			use Huntie\JsonApi\Support\JsonApiErrors;
16			use Illuminate\Database\QueryException;
17			use Illuminate\Database\Eloquent\Model;
18			use Illuminate\Database\Eloquent\ModelNotFoundException;
19			use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
20			use Illuminate\Foundation\Validation\ValidatesRequests;
21			use Illuminate\Http\Request;
22			use Illuminate\Http\Response;
23			use Illuminate\Routing\Controller;
24			use Illuminate\Validation\ValidationException;
25
26			abstract class JsonApiController extends Controller
27			{
28			use JsonApiErrors;
29			use QueriesResources;
30			use UpdatesModelRelations;
31			use AuthorizesRequests;
32			use ValidatesRequests;
33
34			/**
35			* The Eloquent Model for the resource.
36			*
37			* @var Model\|string
38			*/
39			protected $model;
40
41			/**
42			* Create a new JsonApiController instance.
43			*/
44			public function __construct()
45			{
46			if (is_string($this->model)) {
47			if (!is_subclass_of($this->model, Model::class)) {
48			$this->model = str_finish(config('jsonapi.model_namespace', app()->getNamespace()), '\\')
49			. preg_replace('/Controller$/', '', class_basename($this));
50			}
51
52			$this->model = new $this->model;
53			}
54			}
55
56			/**
57			* Return a listing of the resource.
58			*
59			* @param Request $request
60			* @param \Illuminate\Database\Eloquent\Builder\|null $query Custom resource query
61			*
62			* @return JsonApiResponse
63			*/
64			public function indexAction(Request $request, $query = null)
65			{
66			$records = $query ?: $this->model->newQuery();
67			$params = $this->getRequestParameters($request);
68			$this->validateIncludableRelations($params['include']);
69
70			try {
71			$records = $this->sortQuery($records, $params['sort']);
72			$records = $this->filterQuery($records, $params['filter']);
73			$page = $this->resolvePaginationParameters($request);
74
75			$records = $records->paginate($page['size'], null, null, $page['number']);
			0 ignored issues – show Documentation introduced 2017-04-18 21:55 UTC by Report Bug Copy Issue Report `null` is of type `null`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
76			} catch (QueryException $e) {
77			return $this->error(Response::HTTP_BAD_REQUEST, 'Invalid query parameters');
78			}
79
80			return new JsonApiResponse(new CollectionSerializer($records, $params['fields'], $params['include']));
81			}
82
83			/**
84			* Store a new record.
85			*
86			* @param Request $request
87			*
88			* @return JsonApiResponse
89			*/
90			public function storeAction(Request $request)
91			{
92			$record = $this->model->create((array) $request->input('data.attributes'));
93
94			if ($relationships = $request->input('data.relationships')) {
95			$this->updateResourceRelationships($record, (array) $relationships);
96			}
97
98			return new JsonApiResponse(new ResourceSerializer($record), Response::HTTP_CREATED);
99			}
100
101			/**
102			* Return a specified record.
103			*
104			* @param Request $request
105			* @param Model\|mixed $record
106			*
107			* @return JsonApiResponse
108			*/
109			public function showAction(Request $request, $record)
110			{
111			$record = $this->findModelInstance($record);
112			$params = $this->getRequestParameters($request);
113			$this->validateIncludableRelations($params['include']);
114
115			return new JsonApiResponse(new ResourceSerializer($record, $params['fields'], $params['include']));
116			}
117
118			/**
119			* Update a specified record.
120			*
121			* @param Request $request
122			* @param Model\|mixed $record
123			*
124			* @return JsonApiResponse
125			*/
126			public function updateAction(Request $request, $record)
127			{
128			$record = $this->findModelInstance($record);
129			$record->fill((array) $request->input('data.attributes'));
130			$record->save();
131
132			if ($relationships = $request->input('data.relationships')) {
133			$this->updateResourceRelationships($record, (array) $relationships);
134			}
135
136			return new JsonApiResponse(new ResourceSerializer($record));
137			}
138
139			/**
140			* Destroy a specified record.
141			*
142			* @param Request $request
143			* @param Model\|mixed $record
144			*
145			* @return JsonApiResponse
146			*/
147			public function destroyAction(Request $request, $record)
			0 ignored issues – show Unused Code introduced 2017-04-15 17:25 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
148			{
149			$record = $this->findModelInstance($record);
150			$record->delete();
151
152			return new JsonApiResponse(null, Response::HTTP_NO_CONTENT);
153			}
154
155			/**
156			* Return a specified record relationship.
157			*
158			* @param Request $request
159			* @param Model\|mixed $record
160			* @param string $relation
161			*
162			* @return JsonApiResponse
163			*/
164			public function showRelationshipAction(Request $request, $record, $relation)
			0 ignored issues – show Unused Code introduced 2016-05-08 12:41 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
165			{
166			$record = $this->findModelInstance($record);
167
168			return new JsonApiResponse(new RelationshipSerializer($record, $relation));
169			}
170
171			/**
172			* Update a named relationship on a specified record.
173			*
174			* http://jsonapi.org/format/#crud-updating-relationships
175			*
176			* @param Request $request
177			* @param Model\|mixed $record
178			* @param string $relation
179			*
180			* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
181			*
182			* @return JsonApiResponse
183			*/
184			public function updateRelationshipAction(Request $request, $record, $relation)
185			{
186			$relationType = $this->getRelationType($relation);
187			abort_unless(is_string($relationType) && $this->isFillableRelation($relation), Response::HTTP_NOT_FOUND);
188
189			$record = $this->findModelInstance($record);
190			$data = (array) $request->input('data');
191
192			if ($relationType === 'To-One') {
193			$this->updateToOneResourceRelationship($record, $relation, $data);
194			} else if ($relationType === 'To-Many') {
195			$this->updateToManyResourceRelationship($record, $relation, $data, $request->method());
196			}
197
198			return new JsonApiResponse(new RelationshipSerializer($record, $relation));
199			}
200
201			/**
202			* Return existing instance of the resource or find by primary key.
203			*
204			* @param Model\|mixed $record
205			*
206			* @throws ModelNotFoundException
207			*
208			* @return Model
209			*/
210			protected function findModelInstance($record)
211			{
212			if ($record instanceof Model) {
213			if (is_null($record->getKey())) {
214			throw new ModelNotFoundException();
215			}
216
217			return $record;
218			}
219
220			return $this->model->findOrFail($record);
221			}
222
223			/**
224			* Return any JSON API resource parameters from a request.
225			*
226			* @param Request $request
227			*
228			* @return array
229			*/
230			protected function getRequestParameters($request)
231			{
232			$enableIncluded = config('jsonapi.enable_included_resources');
233
234			if ($request->has('include') && is_bool($enableIncluded) && !$enableIncluded) {
235			throw new HttpException('Inclusion of related resources is not supported');
236			}
237
238			return [
239			'fields' => $this->getRequestQuerySet($request, 'fields', '/^([A-Za-z]+.?)+[A-Za-z]+$/'),
240			'include' => $this->getRequestQuerySet($request, 'include', '/^([A-Za-z]+.?)+[A-Za-z]+$/'),
241			'sort' => $this->getRequestQuerySet($request, 'sort', '/[A-Za-z_]+/'),
242			'filter' => (array) $request->input('filter'),
243			];
244			}
245
246			/**
247			* Return any comma separated values in a request query field as an array.
248			*
249			* @param Request $request
250			* @param string $key
251			* @param string\|null $validate Regular expression to test for each item
252			*
253			* @throws \Illuminate\Validation\ValidationException
254			*
255			* @return array
256			*/
257			protected function getRequestQuerySet($request, $key, $validate = null)
258			{
259			$values = preg_split('/,/', $request->input($key), null, PREG_SPLIT_NO_EMPTY);
260
261			$validator = Validator::make(['param' => $values], [
262			'param.*' => 'required' . ($validate ? '\|regex:' . $validate : ''),
263			]);
264
265			if ($validator->fails()) {
266			throw new ValidationException($validator, $this->error(
267			Response::HTTP_BAD_REQUEST,
268			sprintf('Invalid values for "%s" parameter', $key))
269			);
270			}
271
272			return $values;
273			}
274
275			/**
276			* Validate the requested included relationships against those that are
277			* allowed on the requested resource type.
278			*
279			* @param array\|null $relations
280			*
281			* @throws InvalidRelationPathException
282			*/
283			protected function validateIncludableRelations($relations)
284			{
285			if (is_null($relations)) {
286			return;
287			}
288
289			foreach ($relations as $relation) {
290			if (!$this->model instanceof IncludesRelatedResources \|\| !in_array($relation, $this->model->getIncludableRelations())) {
			0 ignored issues – show Coding Style introduced 2017-03-14 14:50 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 132 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
291			throw new InvalidRelationPathException($relation);
292			}
293			}
294			}
295
296			/**
297			* Return the page number and page size to use for paginated results.
298			*
299			* @param \Illuminate\Http\Request $request
300			*/
301			protected function resolvePaginationParameters($request): array
302			{
303			return [
304			'page' => $request->input('page.number', $request->input('page.offset', 0) / 10 + 1),
305			'size' => $request->input('page.size', $request->input('page.limit', $this->model->getPerPage())),
306			];
307			}
308			}
309

huntie / laravel-simple-jsonapi

Push — pagination-options ( 1b40e9...7eb413 )

JsonApiController::resolvePaginationParameters() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like