Controller::respondWithNoContent() - Code Metrics - Inspection of "WIP v2" - NavJobs/transmit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Zach

created 2017-02-22 02:04 UTC

Controller::respondWithNoContent() A

↳ Parent: Controller

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace NavJobs\Transmit;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Input;
use NavJobs\Transmit\Traits\ErrorResponsesTrait;
use NavJobs\Transmit\Traits\QueryHelperTrait;
use Illuminate\Routing\Controller as BaseController;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;

abstract class Controller extends BaseController
{
    use QueryHelperTrait, ErrorResponsesTrait;

    protected $statusCode = 200;
    protected $fractal;

    public function __construct()
    {
        $this->fractal = App::make(Fractal::class);

        $this->parseIncludes();

        $this->resourceKey = null;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Sets the fractal transformer
     *
     * @return mixed
     */
    public function setTransformer($transformer) {
        $this->transformer = $transformer;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        return $this;
    }

    /**
     * Sets model builder
     *
     * @return mixed
     */
    public function setModel($model) {
        $this->model = $model;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        return $this;
    }

    /**
     * Sets resource key for fractal
     *
     * @return mixed
     */
    public function setResourceKey($resourceKey) {
        $this->resourceKey = $resourceKey;
        return $this;
    }

    /**
     * Parses includes from either the header or query string.
     *
     * @return mixed
     */
    protected function parseIncludes()
    {
        if (Input::header('include')) {
            return $this->fractal->parseIncludes(Input::header('include'));
        }

        if (Input::get('include')) {
            return $this->fractal->parseIncludes(Input::get('include'));
        }

        return null;
    }

    /**
     * Returns the current status code.
     *
     * @return int
     */
    protected function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * Sets the current status code.
     *
     * @param $statusCode
     * @return $this
     */
    protected function setStatusCode($statusCode)
    {
        $this->statusCode = $statusCode;

        return $this;
    }

    private function prepareBuilder($builder)
    {
        $model = $builder ?: $this->model;

        $includes = $this->transformer->getEagerLoads($this->fractal->getRequestedIncludes());
        $includedItems = $this->eagerLoadIncludes($model, $includes);
        return $this->applyParameters($includedItems, request()->query);
    }

    /**
     * Returns a json response that contains the specified resource
     * passed through fractal and optionally a transformer.
     *
     * @param $item
     * @param null $callback
     * @return \Illuminate\Http\JsonResponse
     */
    protected function respondWithItem($item, $callback = null)
    {
        if($callback) {
            $builder = $this->prepareBuilder($item);
            $item = $callback($builder);
        }

        $rootScope = $this->fractal->item($item, $this->transformer, is_null($this->resourceKey) ? false : $this->resourceKey);

        return $this->respondWithArray($rootScope->toArray());
    }

    /**
     * Returns a json response that indicates the resource was successfully created also
     * returns the resource passed through fractal and optionally a transformer.
     *
     * @param $item
     * @param null $callback
     * @return \Illuminate\Http\JsonResponse
     */
    protected function respondWithItemCreated($item, $callback = null)
    {
        $this->setStatusCode(201);
        $rootScope = $this->fractal->item($item, $callback, $this->resourceKey);

        return $this->respondWithArray($rootScope->toArray());
    }

    /**
     * Returns a json response that contains the specified collection
     * passed through fractal and optionally a transformer.
     *
     * @param $collection
     * @param $callback
     * @return \Illuminate\Http\JsonResponse
     */
    protected function respondWithCollection($collection, $callback)
    {
        $rootScope = $this->fractal->collection($collection, $callback, $this->resourceKey);

        return $this->respondWithArray($rootScope->toArray());
    }

    /**
     * Returns a json response that contains the specified paginated collection
     * passed through fractal and optionally a transformer.
     *
     * @param $builder
     * @param $callback
     * @param int $perPage
     * @return \Illuminate\Http\JsonResponse
     */
    protected function respondWithPaginatedCollection($builder = null, $perPage = 10)
    {
        $builder = $this->prepareBuilder($builder);

        $paginator = $builder->paginate($perPage);
        $paginator->appends($this->getQueryParameters());

        $rootScope = $this->fractal
            ->collection($paginator->getCollection(), $this->transformer, $this->resourceKey)
            ->paginateWith(new IlluminatePaginatorAdapter($paginator));

        return $this->respondWithArray($rootScope->toArray());
    }

    /**
     * Returns an array of Query Parameters, not including pagination.
     *
     * @return array
     */
    protected function getQueryParameters()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        return array_diff_key($_GET, array_flip(['page']));
    }

    /**
     * Returns a json response that contains the specified array,
     * the current status code and optional headers.
     *
     * @param array $array
     * @param array $headers
     * @return \Illuminate\Http\JsonResponse
     */
    protected function respondWithArray(array $array, array $headers = [])
    {
        return response()->json($array, $this->statusCode, $headers);
    }

    /**
     * Returns a response that indicates success but no content returned.
     *
     * @return \Illuminate\Http\Response
     */
    protected function respondWithNoContent()
    {
        return response()->make('', 204);
    }
}


1			<?php
2
3			namespace NavJobs\Transmit;
4
5			use Illuminate\Database\Eloquent\Builder;
6			use Illuminate\Support\Facades\App;
7			use Illuminate\Support\Facades\Input;
8			use NavJobs\Transmit\Traits\ErrorResponsesTrait;
9			use NavJobs\Transmit\Traits\QueryHelperTrait;
10			use Illuminate\Routing\Controller as BaseController;
11			use League\Fractal\Pagination\IlluminatePaginatorAdapter;
12
13			abstract class Controller extends BaseController
14			{
15			use QueryHelperTrait, ErrorResponsesTrait;
16
17			protected $statusCode = 200;
18			protected $fractal;
19
20			public function __construct()
21			{
22			$this->fractal = App::make(Fractal::class);
23
24			$this->parseIncludes();
25
26			$this->resourceKey = null;
			0 ignored issues – show Bug introduced 2017-02-22 02:06 UTC by Report Bug Copy Issue Report The property `resourceKey` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
27			}
28
29			/**
30			* Sets the fractal transformer
31			*
32			* @return mixed
33			*/
34			public function setTransformer($transformer) {
35			$this->transformer = $transformer;
			0 ignored issues – show Bug introduced 2017-02-22 02:06 UTC by Report Bug Copy Issue Report The property `transformer` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
36			return $this;
37			}
38
39			/**
40			* Sets model builder
41			*
42			* @return mixed
43			*/
44			public function setModel($model) {
45			$this->model = $model;
			0 ignored issues – show Bug introduced 2017-02-22 02:06 UTC by Report Bug Copy Issue Report The property `model` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
46			return $this;
47			}
48
49			/**
50			* Sets resource key for fractal
51			*
52			* @return mixed
53			*/
54			public function setResourceKey($resourceKey) {
55			$this->resourceKey = $resourceKey;
56			return $this;
57			}
58
59			/**
60			* Parses includes from either the header or query string.
61			*
62			* @return mixed
63			*/
64			protected function parseIncludes()
65			{
66			if (Input::header('include')) {
67			return $this->fractal->parseIncludes(Input::header('include'));
68			}
69
70			if (Input::get('include')) {
71			return $this->fractal->parseIncludes(Input::get('include'));
72			}
73
74			return null;
75			}
76
77			/**
78			* Returns the current status code.
79			*
80			* @return int
81			*/
82			protected function getStatusCode()
83			{
84			return $this->statusCode;
85			}
86
87			/**
88			* Sets the current status code.
89			*
90			* @param $statusCode
91			* @return $this
92			*/
93			protected function setStatusCode($statusCode)
94			{
95			$this->statusCode = $statusCode;
96
97			return $this;
98			}
99
100			private function prepareBuilder($builder)
101			{
102			$model = $builder ?: $this->model;
103
104			$includes = $this->transformer->getEagerLoads($this->fractal->getRequestedIncludes());
105			$includedItems = $this->eagerLoadIncludes($model, $includes);
106			return $this->applyParameters($includedItems, request()->query);
107			}
108
109			/**
110			* Returns a json response that contains the specified resource
111			* passed through fractal and optionally a transformer.
112			*
113			* @param $item
114			* @param null $callback
115			* @return \Illuminate\Http\JsonResponse
116			*/
117			protected function respondWithItem($item, $callback = null)
118			{
119			if($callback) {
120			$builder = $this->prepareBuilder($item);
121			$item = $callback($builder);
122			}
123
124			$rootScope = $this->fractal->item($item, $this->transformer, is_null($this->resourceKey) ? false : $this->resourceKey);
125
126			return $this->respondWithArray($rootScope->toArray());
127			}
128
129			/**
130			* Returns a json response that indicates the resource was successfully created also
131			* returns the resource passed through fractal and optionally a transformer.
132			*
133			* @param $item
134			* @param null $callback
135			* @return \Illuminate\Http\JsonResponse
136			*/
137			protected function respondWithItemCreated($item, $callback = null)
138			{
139			$this->setStatusCode(201);
140			$rootScope = $this->fractal->item($item, $callback, $this->resourceKey);
141
142			return $this->respondWithArray($rootScope->toArray());
143			}
144
145			/**
146			* Returns a json response that contains the specified collection
147			* passed through fractal and optionally a transformer.
148			*
149			* @param $collection
150			* @param $callback
151			* @return \Illuminate\Http\JsonResponse
152			*/
153			protected function respondWithCollection($collection, $callback)
154			{
155			$rootScope = $this->fractal->collection($collection, $callback, $this->resourceKey);
156
157			return $this->respondWithArray($rootScope->toArray());
158			}
159
160			/**
161			* Returns a json response that contains the specified paginated collection
162			* passed through fractal and optionally a transformer.
163			*
164			* @param $builder
165			* @param $callback
166			* @param int $perPage
167			* @return \Illuminate\Http\JsonResponse
168			*/
169			protected function respondWithPaginatedCollection($builder = null, $perPage = 10)
170			{
171			$builder = $this->prepareBuilder($builder);
172
173			$paginator = $builder->paginate($perPage);
174			$paginator->appends($this->getQueryParameters());
175
176			$rootScope = $this->fractal
177			->collection($paginator->getCollection(), $this->transformer, $this->resourceKey)
178			->paginateWith(new IlluminatePaginatorAdapter($paginator));
179
180			return $this->respondWithArray($rootScope->toArray());
181			}
182
183			/**
184			* Returns an array of Query Parameters, not including pagination.
185			*
186			* @return array
187			*/
188			protected function getQueryParameters()
			0 ignored issues – show Coding Style introduced 2016-01-14 18:42 UTC by Report Bug Copy Issue Report `getQueryParameters` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
189			{
190			return array_diff_key($_GET, array_flip(['page']));
191			}
192
193			/**
194			* Returns a json response that contains the specified array,
195			* the current status code and optional headers.
196			*
197			* @param array $array
198			* @param array $headers
199			* @return \Illuminate\Http\JsonResponse
200			*/
201			protected function respondWithArray(array $array, array $headers = [])
202			{
203			return response()->json($array, $this->statusCode, $headers);
204			}
205
206			/**
207			* Returns a response that indicates success but no content returned.
208			*
209			* @return \Illuminate\Http\Response
210			*/
211			protected function respondWithNoContent()
212			{
213			return response()->make('', 204);
214			}
215			}
216

NavJobs / transmit

Pull Request — master (#5)

Controller::respondWithNoContent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like