JsonResponseHandler::isAjaxRequest() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - byjg/restserver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a5c9dc...9f0cc8 )

by Joao

created 2016-05-09 18:50 UTC

JsonResponseHandler::isAjaxRequest() A

↳ Parent: JsonResponseHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * Whoops - php errors for cool kids
 * @author Filipe Dobreira <http://github.com/filp>
 */

namespace ByJG\RestServer\Whoops;

use Whoops\Exception\Formatter;
use Whoops\Handler\Handler;
use Whoops\Handler\JsonResponseHandler as OriginalJsonHandler;
use Whoops\Util\Misc;

/**
 * Catches an exception and converts it to a JSON
 * response. Additionally can also return exception
 * frames for consumption by an API.
 */
class JsonResponseHandler extends OriginalJsonHandler
{

    use WhoopsDebugTrait;
    use WhoopsHeaderTrait;

    /**
     * @return int
     */
    public function handle()
    {
        if ($this->onlyForAjaxRequests() && !$this->isAjaxRequest()) {
            return Handler::DONE;
        }

        $response = array(
            'error' => Formatter::formatExceptionAsDataArray(
                $this->getInspector(),
                $this->addTraceToOutput()

            ),
        );

        $debug = $this->getDataTable();
        if (count($debug) > 0) {
            $response["debug"] = $debug;
        }

        if (Misc::canSendHeaders()) {
            header('Content-Type: application/json');
        }

        $this->setProperHeader($this->getException());
        echo json_encode($response);
        return Handler::QUIT;
    }

    public function isAjaxRequest() {
// 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 (
            !empty($_SERVER['HTTP_X_REQUESTED_WITH'])
            && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');

    }

}


1			<?php
2			/**
3			* Whoops - php errors for cool kids
4			* @author Filipe Dobreira <http://github.com/filp>
5			*/
6
7			namespace ByJG\RestServer\Whoops;
8
9			use Whoops\Exception\Formatter;
10			use Whoops\Handler\Handler;
11			use Whoops\Handler\JsonResponseHandler as OriginalJsonHandler;
12			use Whoops\Util\Misc;
13
14			/**
15			* Catches an exception and converts it to a JSON
16			* response. Additionally can also return exception
17			* frames for consumption by an API.
18			*/
19			class JsonResponseHandler extends OriginalJsonHandler
20			{
21
22			use WhoopsDebugTrait;
23			use WhoopsHeaderTrait;
24
25			/**
26			* @return int
27			*/
28			public function handle()
29			{
30			if ($this->onlyForAjaxRequests() && !$this->isAjaxRequest()) {
31			return Handler::DONE;
32			}
33
34			$response = array(
35			'error' => Formatter::formatExceptionAsDataArray(
36			$this->getInspector(),
37			$this->addTraceToOutput()
			0 ignored issues – show Bug introduced 2016-01-19 16:27 UTC by Report Bug Copy Issue Report It seems like `$this->addTraceToOutput()` targeting `Whoops\Handler\JsonRespo...ler::addTraceToOutput()` can also be of type `this<ByJG\RestServer\Whoops\JsonResponseHandler>`; however, `Whoops\Exception\Formatt...tExceptionAsDataArray()` does only seem to accept `boolean`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
38			),
39			);
40
41			$debug = $this->getDataTable();
42			if (count($debug) > 0) {
43			$response["debug"] = $debug;
44			}
45
46			if (Misc::canSendHeaders()) {
47			header('Content-Type: application/json');
48			}
49
50			$this->setProperHeader($this->getException());
51			echo json_encode($response);
52			return Handler::QUIT;
53			}
54
55			public function isAjaxRequest() {
			0 ignored issues – show Coding Style introduced 2016-05-09 18:55 UTC by Report Bug Copy Issue Report `isAjaxRequest` uses the super-global variable `$_SERVER` 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...
56			return (
57			!empty($_SERVER['HTTP_X_REQUESTED_WITH'])
58			&& strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest');
59
60			}
61
62			}
63

byjg / restserver

Push — master ( a5c9dc...9f0cc8 )

JsonResponseHandler::isAjaxRequest() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like