Huntie\JsonApi\Http\Controllers\JsonApiController

Complexity

Total Complexity

8

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
	getModel()	0	1	?
A	getModelType()	0	4	1
A	indexAction()	0	11	2
A	showAction()	0	7	2
A	findModelInstance()	0	4	1
A	transformRecord()	0	14	2

<?php

namespace Huntie\JsonApi\Http\Controllers;

use DB;
use Huntie\JsonApi\Support\JsonApiErrors;
use Huntie\JsonApi\Http\JsonApiResponse;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
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();
    }

    /**
     * Return a listing of the resource.
     *
     * @param Request $request
     *
     * @return JsonApiResponse
     */
    public function indexAction(Request $request)

The parameter $request is not used and could be removed.

    {
        $data = [];
        $records = $this->getModel()->all();

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

        return new JsonApiResponse(compact('data'));
    }

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

The parameter $request is not used and could be removed.

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

It seems like $record defined by $record instanceof \Illuminate\Database\Eloquent\Model ? $record : $this->findModelInstance($record) on line 62 can also be of type object<Huntie\JsonApi\Http\JsonApiResponse>; however, Huntie\JsonApi\Http\Controllers\JsonApiController::transformRecord() does only seem to accept object<Illuminate\Database\Eloquent\Model>, maybe add an additional type check?

        return new JsonApiResponse(compact('data'));
    }

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

    /**
     * Transform a model instance into a JSON API object.
     *
     * @param Model      $record
     * @param array|null $include Relations to include
     * @param array|null $fields  Field names of attributes to limit to
     *
     * @return array
     */
    protected function transformRecord($record, array $include = [], array $fields = [])

The parameter $include is not used and could be removed.

    {
        $attributes = $record->toArray();

        if ($fields) {

The expression $fields of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $attributes = array_only($attributes, $fields);
        }

        return [
            'type' => $record->getTable(),
            'id' => $record->id,
            'attributes' => array_except($attributes, ['id']),
        ];
    }
}