Response::withPaginator() - Code Metrics - Inspection of "IMPROVEMENT Add existing query params to pagingati..." - ellipsesynergie/api-response - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#30)

by Steven

created 2016-07-08 10:22 UTC

Response::withPaginator() A

↳ Parent: Response

Complexity

Conditions	2
Paths	2

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	3.372

Importance

Changes	4
Bugs	0	Features	3

Metric	Value
c	4
b	0
f	3
dl	0
loc	16
ccs	3
cts	10
cp	0.3
rs	9.4285
cc	2
eloc	9
nc	2
nop	4
crap	3.372

<?php

namespace EllipseSynergie\ApiResponse\Laravel;

use EllipseSynergie\ApiResponse\AbstractResponse;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use Illuminate\Contracts\Routing\ResponseFactory;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Contracts\Validation\Validator;
use League\Fractal\Resource\Collection;

/**
 * Class Response
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package EllipseSynergie\ApiResponse\Laravel
 * @author Maxime Beaudoin <[email protected]>
 */
class Response extends AbstractResponse
{
    /**
     * @param array $array
     * @param array $headers
     * @return ResponseFactory
     */
    public function withArray(array $array, array $headers = [])
    {
        return response()->json($array, $this->statusCode, $headers);
    }

    /**
     * Respond with a paginator, and a transformer.
     *
     * @param LengthAwarePaginator $paginator
     * @param callable|\League\Fractal\TransformerAbstract $transformer
     * @param string $resourceKey
     * @param array $meta
     * @return ResponseFactory
     */
    public function withPaginator(LengthAwarePaginator $paginator, $transformer, $resourceKey = null, $meta = [])
// 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);
    }
}
    {
        $queryParams = array_diff_key($_GET, array_flip(['page']));
        $paginator->appends($queryParams);
        
        $resource = new Collection($paginator->items(), $transformer, $resourceKey);
        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));

        foreach ($meta as $metaKey => $metaValue) {
            $resource->setMetaValue($metaKey, $metaValue);
        }

        $rootScope = $this->manager->createData($resource);

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

    /**
     * Generates a Response with a 400 HTTP header and a given message from validator
     *
     * @param Validator $validator
     * @return ResponseFactory
     */
    public function errorWrongArgsValidator(Validator $validator)
    {
        return $this->errorWrongArgs($validator->getMessageBag()->toArray());
    }
}


1		<?php
2
3		namespace EllipseSynergie\ApiResponse\Laravel;
4
5		use EllipseSynergie\ApiResponse\AbstractResponse;
6		use League\Fractal\Pagination\IlluminatePaginatorAdapter;
7		use Illuminate\Contracts\Routing\ResponseFactory;
8		use Illuminate\Contracts\Pagination\LengthAwarePaginator;
9		use Illuminate\Contracts\Validation\Validator;
10		use League\Fractal\Resource\Collection;
11
12		/**
13		* Class Response
14		*
15		* For the full copyright and license information, please view the LICENSE
16		* file that was distributed with this source code.
17		*
18		* @package EllipseSynergie\ApiResponse\Laravel
19		* @author Maxime Beaudoin <[email protected]>
20		*/
21		class Response extends AbstractResponse
22		{
23		/**
24		* @param array $array
25		* @param array $headers
26		* @return ResponseFactory
27		*/
28		public function withArray(array $array, array $headers = [])
29		{
30		return response()->json($array, $this->statusCode, $headers);
31		}
32
33		/**
34		* Respond with a paginator, and a transformer.
35		*
36		* @param LengthAwarePaginator $paginator
37		* @param callable\|\League\Fractal\TransformerAbstract $transformer
38		* @param string $resourceKey
39		* @param array $meta
40		* @return ResponseFactory
41		*/
42	1	public function withPaginator(LengthAwarePaginator $paginator, $transformer, $resourceKey = null, $meta = [])
		0 ignored issues – show Coding Style introduced 2016-07-08 10:26 UTC by Report Bug Copy Issue Report `withPaginator` 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...
43		{
44	1	$queryParams = array_diff_key($_GET, array_flip(['page']));
45	1	$paginator->appends($queryParams);
46
47		$resource = new Collection($paginator->items(), $transformer, $resourceKey);
48		$resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
49
50		foreach ($meta as $metaKey => $metaValue) {
51		$resource->setMetaValue($metaKey, $metaValue);
52		}
53
54		$rootScope = $this->manager->createData($resource);
55
56		return $this->withArray($rootScope->toArray());
57		}
58
59		/**
60		* Generates a Response with a 400 HTTP header and a given message from validator
61		*
62		* @param Validator $validator
63		* @return ResponseFactory
64		*/
65	1	public function errorWrongArgsValidator(Validator $validator)
66		{
67	1	return $this->errorWrongArgs($validator->getMessageBag()->toArray());
68		}
69		}
70

ellipsesynergie / api-response

GitHub Access Token became invalid

Pull Request — master (#30)

Response::withPaginator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like