JsonApiController::updateRecordRelationships() - Code Metrics - Inspection of "Add controller action to get model relationships" - huntie/laravel-simple-jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — relationships ( 63580c...d37974 )

by Alex

created 2016-05-08 18:29 UTC

JsonApiController::updateRecordRelationships() A

↳ Parent: JsonApiController

Complexity

Conditions	4
Paths	4

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	15
rs	9.2
cc	4
eloc	9
nc	4
nop	2

<?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\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
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);
    }

    /**
     * Return a specified record relationship.
     *
     * @param Request   $request
     * @param Model|int $record
     * @param string    $relation
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *
     * @return JsonApiResponse
     */
    public function relationshipAction(Request $request, $record, $relation)

    {
        abort_if(!array_key_exists($relation, $this->getModelRelationships()), Reponse::HTTP_NOT_FOUND);

        $record = $record instanceof Model ? $record : $this->findModelInstance($record);
        $modelRelation = $this->getModelRelationships()[$relation];

        if ($modelRelation instanceof BelongsTo) {
            $relatedRecord = $record->{$relation};

            return new JsonApiResponse([
                'type' => $relatedRecord->getTable(),
                'id' => $relatedRecord->id,
            ]);
        } else if ($modelRelation instanceof BelongsToMany) {
            return new JsonApiResponse($this->transformCollectionIds($record->{$relation}));
        }
    }

    /**
     * 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
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *
     * @return JsonApiResponse
     */
    public function updateToOneRelationshipAction(Request $request, $record, $relation, $foreignKey = null)
    {
        abort_if(!array_key_exists($relation, $this->getModelRelationships()), 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
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *
     * @return JsonApiResponse
     */
    public function updateToManyRelationshipAction(Request $request, $record, $relation)
    {
        abort_if(!array_key_exists($relation, $this->getModelRelationships()), 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 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'));
    }

    /**
     * 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 = $records->map(function ($record) use ($fields) {
            return $this->transformRecord($record, $fields)['data'];
        });

        return compact('data');
    }

    /**
     * Transform a set of models into a collection of JSON API resource
     * identifier objects.
     *
     * @param \Illuminate\Support\Collection $records
     *
     * @return array
     */
    protected function transformCollectionIds($records)
    {
        $data = $records->map(function ($record) {
            return [
                'type' => $record->getTable(),
                'id' => $record->id,
            ];
        });

        return compact('data');
    }

    /**
     * Update one or more relationships on a model instance.
     *
     * @param Model $record
     * @param array $relationships
     */
    protected function updateRecordRelationships($record, array $relationships)
    {
        $relationships = array_intersect_key($relationships, $this->getModelRelationships());

        foreach ($relationships as $name => $relationship) {
            $relation = $this->getModelRelationships()[$name];
            $data = $relationship['data'];

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


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\Database\Eloquent\Relations\BelongsTo;
10			use Illuminate\Database\Eloquent\Relations\BelongsToMany;
11			use Illuminate\Http\Request;
12			use Illuminate\Http\Response;
13			use Illuminate\Routing\Controller;
14
15			abstract class JsonApiController extends Controller
16			{
17			use JsonApiErrors;
18
19			/**
20			* Return the Eloquent Model for the resource.
21			*
22			* @return Model
23			*/
24			abstract protected function getModel();
25
26			/**
27			* Return the type name of the resource.
28			*
29			* @return string
30			*/
31			protected function getModelType()
32			{
33			return $this->getModel()->getTable();
34			}
35
36			/**
37			* The model relationships that can be updated.
38			*
39			* @return string
40			*/
41			protected function getModelRelationships()
42			{
43			return [];
44			}
45
46			/**
47			* Return a listing of the resource.
48			*
49			* @param Request $request
50			*
51			* @return JsonApiResponse
52			*/
53			public function indexAction(Request $request)
54			{
55			$records = $this->getModel()->newQuery();
56			$params = $this->getRequestParameters($request);
57
58			foreach ($params['sort'] as $expression) {
59			$direction = substr($expression, 0, 1) === '-' ? 'desc' : 'asc';
60			$column = preg_replace('/^\-/', '', $expression);
61			$records = $records->orderby($column, $direction);
62			}
63
64			foreach ($params['filter'] as $attribute => $value) {
65			if (is_numeric($value)) {
66			// Exact numeric match
67			$records = $records->where($attribute, $value);
68			} else if (in_array(strtolower($value), ['true', 'false'])) {
69			// Boolean match
70			$records = $records->where($attribute, filter_var($value, FILTER_VALIDATE_BOOLEAN));
71			} else {
72			// Partial string match
73			$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...
74			}
75			}
76
77			try {
78			$records = $records->get();
79			} catch (QueryException $e) {
80			return $this->error(Response::HTTP_BAD_REQUEST, 'Invalid query parameters');
81			}
82
83			return new JsonApiResponse($this->transformCollection($records, $params['fields']));
84			}
85
86			/**
87			* Store a new record.
88			*
89			* @param Request $request
90			*
91			* @return JsonApiResponse
92			*/
93			public function storeAction(Request $request)
94			{
95			$record = $this->getModel()->create((array) $request->input('data.attributes'));
96
97			if ($relationships = $request->input('data.relationships')) {
98			$this->updateRecordRelationships($record, (array) $relationships);
99			}
100
101			return new JsonApiResponse($this->transformRecord($record), Response::HTTP_CREATED);
102			}
103
104			/**
105			* Return a specified record.
106			*
107			* @param Request $request
108			* @param Model\|int $record
109			*
110			* @return JsonApiResponse
111			*/
112			public function showAction(Request $request, $record)
113			{
114			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
115			$params = $this->getRequestParameters($request);
116
117			return new JsonApiResponse($this->transformRecord($record, $params['fields'], $params['include']));
118			}
119
120			/**
121			* Update a specified record.
122			*
123			* @param Request $request
124			* @param Model\|int $record
125			*
126			* @return JsonApiResponse
127			*/
128			public function updateAction(Request $request, $record)
129			{
130			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
131			$record->update((array) $request->input('data.attributes'));
132
133			if ($relationships = $request->input('data.relationships')) {
134			$this->updateRecordRelationships($record, (array) $relationships);
135			}
136
137			return $this->showAction($request, $record);
138			}
139
140			/**
141			* Destroy a specified record.
142			*
143			* @param Request $request
144			* @param Model\|int $record
145			*
146			* @return JsonApiResponse
147			*/
148			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...
149			{
150			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
151			$record->delete();
152
153			return new JsonApiResponse(null, Response::HTTP_NO_CONTENT);
154			}
155
156			/**
157			* Return a specified record relationship.
158			*
159			* @param Request $request
160			* @param Model\|int $record
161			* @param string $relation
162			*
163			* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
164			*
165			* @return JsonApiResponse
166			*/
167			public function relationshipAction(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...
168			{
169			abort_if(!array_key_exists($relation, $this->getModelRelationships()), Reponse::HTTP_NOT_FOUND);
170
171			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
172			$modelRelation = $this->getModelRelationships()[$relation];
173
174			if ($modelRelation instanceof BelongsTo) {
175			$relatedRecord = $record->{$relation};
176
177			return new JsonApiResponse([
178			'type' => $relatedRecord->getTable(),
179			'id' => $relatedRecord->id,
180			]);
181			} else if ($modelRelation instanceof BelongsToMany) {
182			return new JsonApiResponse($this->transformCollectionIds($record->{$relation}));
183			}
184			}
185
186			/**
187			* Update a named many-to-one relationship association on a specified record.
188			* http://jsonapi.org/format/#crud-updating-to-one-relationships
189			*
190			* @param Request $request
191			* @param Model\|int $record
192			* @param string $relation
193			* @param string\|null $foreignKey
194			*
195			* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
196			*
197			* @return JsonApiResponse
198			*/
199			public function updateToOneRelationshipAction(Request $request, $record, $relation, $foreignKey = null)
200			{
201			abort_if(!array_key_exists($relation, $this->getModelRelationships()), Reponse::HTTP_NOT_FOUND);
202
203			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
204			$data = (array) $request->input('data');
205
206			$record->update([($foreignKey ?: $relation . '_id') => $data['id']]);
207
208			return new JsonApiResponse();
209			}
210
211			/**
212			* Update named many-to-many relationship entries on a specified record.
213			* http://jsonapi.org/format/#crud-updating-to-many-relationships
214			*
215			* @param Request $request
216			* @param Model\|int $record
217			* @param string $relation
218			*
219			* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
220			*
221			* @return JsonApiResponse
222			*/
223			public function updateToManyRelationshipAction(Request $request, $record, $relation)
224			{
225			abort_if(!array_key_exists($relation, $this->getModelRelationships()), Reponse::HTTP_NOT_FOUND);
226
227			$record = $record instanceof Model ? $record : $this->findModelInstance($record);
228			$relationships = (array) $request->input('data');
229			$items = [];
230
231			foreach ($relationships as $item) {
232			$items[$item['id']] = $item['attributes'];
233			}
234
235			switch ($request->method()) {
236			case 'PATCH':
237			$record->{$relation}()->sync($items);
238			break;
239			case 'POST':
240			$record->{$relation}()->sync($items, false);
241			break;
242			case 'DELETE':
243			$record->{$relation}()->detach(array_keys($items));
244			}
245
246			return new JsonApiResponse();
247			}
248
249			/**
250			* Return an instance of the resource by primary key.
251			*
252			* @param int $key
253			*
254			* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
255			*
256			* @return Model
257			*/
258			protected function findModelInstance($key)
259			{
260			return $this->getModel()->findOrFail($key);
261			}
262
263			/**
264			* Return any JSON API resource parameters from a request.
265			*
266			* @param Request $request
267			*
268			* @return array
269			*/
270			protected function getRequestParameters($request)
271			{
272			return [
273			'fields' => $this->getRequestQuerySet($request, 'fields.' . $this->getModelType()),
274			'include' => $this->getRequestQuerySet($request, 'include'),
275			'sort' => $this->getRequestQuerySet($request, 'sort'),
276			'filter' => (array) $request->input('filter'),
277			];
278			}
279
280			/**
281			* Return any comma separated values in a request query field as an array.
282			*
283			* @param Request $request
284			* @param string $key
285			*
286			* @return array
287			*/
288			protected function getRequestQuerySet($request, $key)
289			{
290			return preg_split('/,/', $request->input($key), null, PREG_SPLIT_NO_EMPTY);
291			}
292
293			/**
294			* Transform a model instance into a JSON API object.
295			*
296			* @param Model $record
297			* @param array\|null $fields Field names of attributes to limit to
298			* @param array\|null $include Relations to include
299			*
300			* @return array
301			*/
302			protected function transformRecord($record, array $fields = [], array $include = [])
303			{
304			$relations = array_unique(array_merge($record->getRelations(), $include));
305			$attributes = $record->load($relations)->toArray();
306			$relationships = [];
307			$included = [];
308
309			foreach ($relations as $relation) {
310			$relationships[$relation] = [
311			'data' => []
312			];
313
314			foreach (array_pull($attributes, $relation) as $relatedRecord) {
315			$relationships[$relation]['data'][] = [
316			'type' => $relation,
317			'id' => $relatedRecord['id'],
318			];
319
320			if (in_array($relation, $include)) {
321			$included[] = [
322			'type' => $relation,
323			'id' => $relatedRecord['id'],
324			'attributes' => array_except($relatedRecord, ['id', 'pivot']),
325			];
326			}
327			}
328			}
329
330			if (!empty($fields)) {
331			$attributes = array_only($attributes, $fields);
332			}
333
334			$data = array_filter([
335			'type' => $record->getTable(),
336			'id' => $record->id,
337			'attributes' => array_except($attributes, ['id']),
338			'relationships' => $relationships,
339			]);
340
341			return array_filter(compact('data', 'included'));
342			}
343
344			/**
345			* Transform a set of models into a JSON API collection.
346			*
347			* @param \Illuminate\Support\Collection $records
348			* @param array $fields
349			*
350			* @return array
351			*/
352			protected function transformCollection($records, array $fields = [])
353			{
354			$data = $records->map(function ($record) use ($fields) {
355			return $this->transformRecord($record, $fields)['data'];
356			});
357
358			return compact('data');
359			}
360
361			/**
362			* Transform a set of models into a collection of JSON API resource
363			* identifier objects.
364			*
365			* @param \Illuminate\Support\Collection $records
366			*
367			* @return array
368			*/
369			protected function transformCollectionIds($records)
370			{
371			$data = $records->map(function ($record) {
372			return [
373			'type' => $record->getTable(),
374			'id' => $record->id,
375			];
376			});
377
378			return compact('data');
379			}
380
381			/**
382			* Update one or more relationships on a model instance.
383			*
384			* @param Model $record
385			* @param array $relationships
386			*/
387			protected function updateRecordRelationships($record, array $relationships)
388			{
389			$relationships = array_intersect_key($relationships, $this->getModelRelationships());
390
391			foreach ($relationships as $name => $relationship) {
392			$relation = $this->getModelRelationships()[$name];
393			$data = $relationship['data'];
394
395			if ($relation instanceof BelongsTo) {
396			$record->update([$relation->getForeignKey() => $data['id']]);
397			} else if ($relation instanceof BelongsToMany) {
398			$record->{$name}()->sync(array_pluck($data, 'id'));
399			}
400			}
401			}
402			}
403

huntie / laravel-simple-jsonapi

Push — relationships ( 63580c...d37974 )

JsonApiController::updateRecordRelationships() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like