JsonApiController - Code Metrics - Inspection of "Add relationship updating when modifying a record" - huntie/laravel-simple-jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — relationships ( cfabf1...489f2c )

by Alex

created 2016-05-08 12:33 UTC

JsonApiController B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	340
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	10
Bugs	0	Features	8

Metric	Value
wmc	44
c	10
b	0
f	8
lcom	1
cbo	5
dl	0
loc	340
rs	8.3396

16 Methods

Rating	Name	Size	Complexity
	getModel()	1	?
A	getModelType()	4	1
A	getModelRelationships()	4	1
C	indexAction()	32	7
A	storeAction()	10	2
A	showAction()	7	2
A	updateAction()	11	3
A	destroyAction()	7	2
A	updateToOneRelationshipAction()	13	4
C	updateToManyRelationshipAction()	27	7
A	findModelInstance()	4	1
A	getRequestParameters()	9	1
A	getRequestQuerySet()	4	1
A	transformCollection()	10	2
B	transformRecord()	41	5
B	updateRecordRelationships()	15	5

How to fix Complexity

<?php

namespace Huntie\JsonApi\Http\Controllers;

use Huntie\JsonApi\Http\JsonApiResponse;
use Huntie\JsonApi\Support\JsonApiErrors;
use Illuminate\Database\QueryException;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Routing\Controller;

abstract class JsonApiController extends Controller
{
    use JsonApiErrors;

    /**
     * Return the Eloquent Model for the resource.
     *
     * @return Model
     */
    abstract protected function getModel();

    /**
     * Return the type name of the resource.
     *
     * @return string
     */
    protected function getModelType()
    {
        return $this->getModel()->getTable();
    }

    /**
     * The model relationships that can be updated.
     *
     * @return string
     */
    protected function getModelRelationships()
    {
        return [];
    }

    /**
     * Return a listing of the resource.
     *
     * @param Request $request
     *
     * @return JsonApiResponse
     */
    public function indexAction(Request $request)
    {
        $records = $this->getModel()->newQuery();
        $params = $this->getRequestParameters($request);

        foreach ($params['sort'] as $expression) {
            $direction = substr($expression, 0, 1) === '-' ? 'desc' : 'asc';
            $column = preg_replace('/^\-/', '', $expression);
            $records = $records->orderby($column, $direction);
        }

        foreach ($params['filter'] as $attribute => $value) {
            if (is_numeric($value)) {
                // Exact numeric match
                $records = $records->where($attribute, $value);
            } else if (in_array(strtolower($value), ['true', 'false'])) {
                // Boolean match
                $records = $records->where($attribute, filter_var($value, FILTER_VALIDATE_BOOLEAN));
            } else {
                // Partial string match
                $records = $records->where($attribute, 'like', "%$value%");
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            }
        }

        try {
            $records = $records->get();
        } catch (QueryException $e) {
            return $this->error(Response::HTTP_BAD_REQUEST, 'Invalid query parameters');
        }

        return new JsonApiResponse($this->transformCollection($records, $params['fields']));
    }

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

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

        return new JsonApiResponse($this->transformRecord($record), Response::HTTP_CREATED);
    }

    /**
     * Return a specified record.
     *
     * @param Request   $request
     * @param Model|int $record
     *
     * @return JsonApiResponse
     */
    public function showAction(Request $request, $record)
    {
        $record = $record instanceof Model ? $record : $this->findModelInstance($record);
        $params = $this->getRequestParameters($request);

        return new JsonApiResponse($this->transformRecord($record, $params['fields'], $params['include']));
    }

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

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

        return $this->showAction($request, $record);
    }

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

    {
        $record = $record instanceof Model ? $record : $this->findModelInstance($record);
        $record->delete();

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

    /**
     * Update a named many-to-one relationship association on a specified record.
     * http://jsonapi.org/format/#crud-updating-to-one-relationships
     *
     * @param Request     $request
     * @param Model|int   $record
     * @param string      $relation
     * @param string|null $foreignKey
     *
     * @return JsonApiResponse
     */
    public function updateToOneRelationshipAction(Request $request, $record, $relation, $foreignKey = null)
    {
        if (!in_array($relation, $this->getModelRelationships())) {
            return $this->error(Reponse::HTTP_NOT_FOUND);

        }

        $record = $record instanceof Model ? $record : $this->findModelInstance($record);
        $data = (array) $request->input('data');

        $record->update([($foreignKey ?: $relation . '_id') => $data['id']]);

        return new JsonApiResponse();
    }

    /**
     * Update named many-to-many relationship entries on a specified record.
     * http://jsonapi.org/format/#crud-updating-to-many-relationships
     *
     * @param Request   $request
     * @param Model|int $record
     * @param string    $relation
     *
     * @return JsonApiResponse
     */
    public function updateToManyRelationshipAction(Request $request, $record, $relation)
    {
        if (!in_array($relation, $this->getModelRelationships())) {
            return $this->error(Reponse::HTTP_NOT_FOUND);

        }

        $record = $record instanceof Model ? $record : $this->findModelInstance($record);
        $relationships = (array) $request->input('data');
        $items = [];

        foreach ($relationships as $item) {
            $items[$item['id']] = $item['attributes'];
        }

        switch ($request->method()) {
            case 'PATCH':
                $record->{$relation}()->sync($items);
                break;
            case 'POST':
                $record->{$relation}()->sync($items, false);
                break;
            case 'DELETE':
                $record->{$relation}()->detach(array_keys($items));
        }

        return new JsonApiResponse();
    }

    /**
     * Return an instance of the resource by primary key.
     *
     * @param int $key
     *
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     *
     * @return Model
     */
    protected function findModelInstance($key)
    {
        return $this->getModel()->findOrFail($key);
    }

    /**
     * Return any JSON API resource parameters from a request.
     *
     * @param Request $request
     *
     * @return array
     */
    protected function getRequestParameters($request)
    {
        return [
            'fields' => $this->getRequestQuerySet($request, 'fields.' . $this->getModelType()),
            'include' => $this->getRequestQuerySet($request, 'include'),
            'sort' => $this->getRequestQuerySet($request, 'sort'),
            'filter' => (array) $request->input('filter'),
        ];
    }

    /**
     * Return any comma separated values in a request query field as an array.
     *
     * @param Request $request
     * @param string  $key
     *
     * @return array
     */
    protected function getRequestQuerySet($request, $key)
    {
        return preg_split('/,/', $request->input($key), null, PREG_SPLIT_NO_EMPTY);
    }

    /**
     * Transform a set of models into a JSON API collection.
     *
     * @param \Illuminate\Support\Collection $records
     * @param array                          $fields
     *
     * @return array
     */
    protected function transformCollection($records, array $fields = [])
    {
        $data = [];

        foreach ($records as $record) {
            $data[] = $this->transformRecord($record, $fields)['data'];
        }

        return compact('data');
    }

    /**
     * Transform a model instance into a JSON API object.
     *
     * @param Model      $record
     * @param array|null $fields  Field names of attributes to limit to
     * @param array|null $include Relations to include
     *
     * @return array
     */
    protected function transformRecord($record, array $fields = [], array $include = [])
    {
        $relations = array_unique(array_merge($record->getRelations(), $include));
        $attributes = $record->load($relations)->toArray();
        $relationships = [];
        $included = [];

        foreach ($relations as $relation) {
            $relationships[$relation] = [
                'data' => []
            ];

            foreach (array_pull($attributes, $relation) as $relatedRecord) {
                $relationships[$relation]['data'][] = [
                    'type' => $relation,
                    'id' => $relatedRecord['id'],
                ];

                if (in_array($relation, $include)) {
                    $included[] = [
                        'type' => $relation,
                        'id' => $relatedRecord['id'],
                        'attributes' => array_except($relatedRecord, ['id', 'pivot']),
                    ];
                }
            }
        }

        if (!empty($fields)) {
            $attributes = array_only($attributes, $fields);
        }

        $data = array_filter([
            'type' => $record->getTable(),
            'id' => $record->id,
            'attributes' => array_except($attributes, ['id']),
            'relationships' => $relationships,
        ]);

        return array_filter(compact('data', 'included'));
    }

    /**
     * Update one or more relationships on a model instance.
     *
     * @param Model $record
     * @param array $relationships
     */
    protected function updateRecordRelationships($record, array $relationships)
    {
        foreach ($relationships as $name => $relationship) {
            if (in_array($name, $this->getModelRelationships())) {
                $relation = $this->getModelRelationships()[$name];
                $data = $relationship['data'];

                if ($relation instanceof BelongsTo) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                    $record->update([$relation->getForeignKey() => $data['id']]);
                } else if ($relation instanceof BelongsToMany) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                    $record->{$name}()->sync(array_pluck($data, 'id'));
                }
            }
        }
    }
}


Push — relationships ( cfabf1...489f2c )

JsonApiController B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

How to fix Complexity

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			namespace Huntie\JsonApi\Http\Controllers;
4
5			use Huntie\JsonApi\Http\JsonApiResponse;
6			use Huntie\JsonApi\Support\JsonApiErrors;
7			use Illuminate\Database\QueryException;
8			use Illuminate\Database\Eloquent\Model;
9			use Illuminate\Http\Request;
10			use Illuminate\Http\Response;
11			use Illuminate\Routing\Controller;
12
13			abstract class JsonApiController extends Controller
14			{
15			use JsonApiErrors;
16
17			/**
18			* Return the Eloquent Model for the resource.
19			*
20			* @return Model
21			*/
22			abstract protected function getModel();
23
24			/**
25			* Return the type name of the resource.
26			*
27			* @return string
28			*/
29			protected function getModelType()
30			{
31			return $this->getModel()->getTable();
32			}
33
34			/**
35			* The model relationships that can be updated.
36			*
37			* @return string
38			*/
39			protected function getModelRelationships()
40			{
41			return [];
42			}
43
44			/**
45			* Return a listing of the resource.
46			*
47			* @param Request $request
48			*
49			* @return JsonApiResponse
50			*/
51			public function indexAction(Request $request)
52			{
53			$records = $this->getModel()->newQuery();
54			$params = $this->getRequestParameters($request);
55
56			foreach ($params['sort'] as $expression) {
57			$direction = substr($expression, 0, 1) === '-' ? 'desc' : 'asc';
58			$column = preg_replace('/^\-/', '', $expression);
59			$records = $records->orderby($column, $direction);
60			}
61
62			foreach ($params['filter'] as $attribute => $value) {
63			if (is_numeric($value)) {
64			// Exact numeric match
65			$records = $records->where($attribute, $value);
66			} else if (in_array(strtolower($value), ['true', 'false'])) {
67			// Boolean match
68			$records = $records->where($attribute, filter_var($value, FILTER_VALIDATE_BOOLEAN));
69			} else {
70			// Partial string match
71			$records = $records->where($attribute, 'like', "%$value%");
			0 ignored issues – show Coding Style Best Practice introduced 2016-05-08 10:38 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$value` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
72			}
73			}
74
75			try {
76			$records = $records->get();
77			} catch (QueryException $e) {
78			return $this->error(Response::HTTP_BAD_REQUEST, 'Invalid query parameters');
79			}
80
81			return new JsonApiResponse($this->transformCollection($records, $params['fields']));
82			}
83
84			/**
85			* Store a new record.
86			*
87			* @param Request $request
88			*
89			* @return JsonApiResponse
90			*/
91			public function storeAction(Request $request)
92			{
93			$record = $this->getModel()->create((array) $request->input('data.attributes'));
94
95			if ($relationships = $request->input('data.relationships')) {
96			$this->updateRecordRelationships($record, (array) $relationships);
97			}
98
99			return new JsonApiResponse($this->transformRecord($record), Response::HTTP_CREATED);
100			}
101
102			/**
103			* Return a specified record.
104			*
105			* @param Request $request
106			* @param Model\|int $record
107			*
108			* @return JsonApiResponse
109			*/
110			public function showAction(Request $request, $record)
111			{
112			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
113			$params = $this->getRequestParameters($request);
114
115			return new JsonApiResponse($this->transformRecord($record, $params['fields'], $params['include']));
116			}
117
118			/**
119			* Update a specified record.
120			*
121			* @param Request $request
122			* @param Model\|int $record
123			*
124			* @return JsonApiResponse
125			*/
126			public function updateAction(Request $request, $record)
127			{
128			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
129			$record->update((array) $request->input('data.attributes'));
130
131			if ($relationships = $request->input('data.relationships')) {
132			$this->updateRecordRelationships($record, (array) $relationships);
133			}
134
135			return $this->showAction($request, $record);
136			}
137
138			/**
139			* Destroy a specified record.
140			*
141			* @param Request $request
142			* @param Model\|int $record
143			*
144			* @return JsonApiResponse
145			*/
146			public function destroyAction(Request $request, $record)
			0 ignored issues – show Unused Code introduced 2016-05-03 18:58 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...
147			{
148			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
149			$record->delete();
150
151			return new JsonApiResponse(null, Response::HTTP_NO_CONTENT);
152			}
153
154			/**
155			* Update a named many-to-one relationship association on a specified record.
156			* http://jsonapi.org/format/#crud-updating-to-one-relationships
157			*
158			* @param Request $request
159			* @param Model\|int $record
160			* @param string $relation
161			* @param string\|null $foreignKey
162			*
163			* @return JsonApiResponse
164			*/
165			public function updateToOneRelationshipAction(Request $request, $record, $relation, $foreignKey = null)
166			{
167			if (!in_array($relation, $this->getModelRelationships())) {
168			return $this->error(Reponse::HTTP_NOT_FOUND);
			0 ignored issues – show Bug introduced 2016-05-08 12:35 UTC by Report Bug Copy Issue Report The call to `error()` misses a required argument `$title`. This check looks for function calls that miss required arguments. Loading history...
169			}
170
171			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
172			$data = (array) $request->input('data');
173
174			$record->update([($foreignKey ?: $relation . '_id') => $data['id']]);
175
176			return new JsonApiResponse();
177			}
178
179			/**
180			* Update named many-to-many relationship entries on a specified record.
181			* http://jsonapi.org/format/#crud-updating-to-many-relationships
182			*
183			* @param Request $request
184			* @param Model\|int $record
185			* @param string $relation
186			*
187			* @return JsonApiResponse
188			*/
189			public function updateToManyRelationshipAction(Request $request, $record, $relation)
190			{
191			if (!in_array($relation, $this->getModelRelationships())) {
192			return $this->error(Reponse::HTTP_NOT_FOUND);
			0 ignored issues – show Bug introduced 2016-05-08 12:35 UTC by Report Bug Copy Issue Report The call to `error()` misses a required argument `$title`. This check looks for function calls that miss required arguments. Loading history...
193			}
194
195			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
196			$relationships = (array) $request->input('data');
197			$items = [];
198
199			foreach ($relationships as $item) {
200			$items[$item['id']] = $item['attributes'];
201			}
202
203			switch ($request->method()) {
204			case 'PATCH':
205			$record->{$relation}()->sync($items);
206			break;
207			case 'POST':
208			$record->{$relation}()->sync($items, false);
209			break;
210			case 'DELETE':
211			$record->{$relation}()->detach(array_keys($items));
212			}
213
214			return new JsonApiResponse();
215			}
216
217			/**
218			* Return an instance of the resource by primary key.
219			*
220			* @param int $key
221			*
222			* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
223			*
224			* @return Model
225			*/
226			protected function findModelInstance($key)
227			{
228			return $this->getModel()->findOrFail($key);
229			}
230
231			/**
232			* Return any JSON API resource parameters from a request.
233			*
234			* @param Request $request
235			*
236			* @return array
237			*/
238			protected function getRequestParameters($request)
239			{
240			return [
241			'fields' => $this->getRequestQuerySet($request, 'fields.' . $this->getModelType()),
242			'include' => $this->getRequestQuerySet($request, 'include'),
243			'sort' => $this->getRequestQuerySet($request, 'sort'),
244			'filter' => (array) $request->input('filter'),
245			];
246			}
247
248			/**
249			* Return any comma separated values in a request query field as an array.
250			*
251			* @param Request $request
252			* @param string $key
253			*
254			* @return array
255			*/
256			protected function getRequestQuerySet($request, $key)
257			{
258			return preg_split('/,/', $request->input($key), null, PREG_SPLIT_NO_EMPTY);
259			}
260
261			/**
262			* Transform a set of models into a JSON API collection.
263			*
264			* @param \Illuminate\Support\Collection $records
265			* @param array $fields
266			*
267			* @return array
268			*/
269			protected function transformCollection($records, array $fields = [])
270			{
271			$data = [];
272
273			foreach ($records as $record) {
274			$data[] = $this->transformRecord($record, $fields)['data'];
275			}
276
277			return compact('data');
278			}
279
280			/**
281			* Transform a model instance into a JSON API object.
282			*
283			* @param Model $record
284			* @param array\|null $fields Field names of attributes to limit to
285			* @param array\|null $include Relations to include
286			*
287			* @return array
288			*/
289			protected function transformRecord($record, array $fields = [], array $include = [])
290			{
291			$relations = array_unique(array_merge($record->getRelations(), $include));
292			$attributes = $record->load($relations)->toArray();
293			$relationships = [];
294			$included = [];
295
296			foreach ($relations as $relation) {
297			$relationships[$relation] = [
298			'data' => []
299			];
300
301			foreach (array_pull($attributes, $relation) as $relatedRecord) {
302			$relationships[$relation]['data'][] = [
303			'type' => $relation,
304			'id' => $relatedRecord['id'],
305			];
306
307			if (in_array($relation, $include)) {
308			$included[] = [
309			'type' => $relation,
310			'id' => $relatedRecord['id'],
311			'attributes' => array_except($relatedRecord, ['id', 'pivot']),
312			];
313			}
314			}
315			}
316
317			if (!empty($fields)) {
318			$attributes = array_only($attributes, $fields);
319			}
320
321			$data = array_filter([
322			'type' => $record->getTable(),
323			'id' => $record->id,
324			'attributes' => array_except($attributes, ['id']),
325			'relationships' => $relationships,
326			]);
327
328			return array_filter(compact('data', 'included'));
329			}
330
331			/**
332			* Update one or more relationships on a model instance.
333			*
334			* @param Model $record
335			* @param array $relationships
336			*/
337			protected function updateRecordRelationships($record, array $relationships)
338			{
339			foreach ($relationships as $name => $relationship) {
340			if (in_array($name, $this->getModelRelationships())) {
341			$relation = $this->getModelRelationships()[$name];
342			$data = $relationship['data'];
343
344			if ($relation instanceof BelongsTo) {
			0 ignored issues – show Bug introduced 2016-05-08 12:35 UTC by Report Bug Copy Issue Report The class `Huntie\JsonApi\Http\Controllers\BelongsTo` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
345			$record->update([$relation->getForeignKey() => $data['id']]);
346			} else if ($relation instanceof BelongsToMany) {
			0 ignored issues – show Bug introduced 2016-05-08 12:35 UTC by Report Bug Copy Issue Report The class `Huntie\JsonApi\Http\Controllers\BelongsToMany` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
347			$record->{$name}()->sync(array_pluck($data, 'id'));
348			}
349			}
350			}
351			}
352			}
353

huntie / laravel-simple-jsonapi

Push — relationships ( cfabf1...489f2c )

JsonApiController B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

How to fix Complexity

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like