QueryParams::__invoke() - Code Metrics - atukai/AtDataGrid - Measure and Improve Code Quality continuously with Scrutinizer

QueryParams::__invoke() A
last analyzed 2017-12-12 19:16 UTC

↳ Parent: QueryParams

Complexity

Conditions	4
Paths	3

Size

Total Lines	16
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.2
c	0
b	0
f	0
cc	4
eloc	11
nc	3
nop	3

<?php

namespace AtDataGrid\View\Helper;

use Zend\View\Helper\AbstractHelper;

class QueryParams extends AbstractHelper
{
    /**
     * @param array $params
     * @param bool $reuseMatchedParams
     * @param bool $resetCurrentParams
     * @return string
     */
    public function __invoke($params = [], $reuseMatchedParams = true, $resetCurrentParams = false)
// 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);
    }
}
    {
        $currentParams = [];
        if (!$resetCurrentParams) {
            $queryString = $_SERVER['QUERY_STRING'];
            $currentParamPairs = explode('&', $queryString);
            if (!empty($currentParamPairs[0])) {
                foreach ($currentParamPairs as $pair) {
                    $data = explode('=', $pair);
                    $currentParams[$data[0]] = urldecode($data[1]);
                }
            }
        }
        $queryString = http_build_query(array_merge($currentParams, $params));
        return $this->getView()->url(null, [], [], $reuseMatchedParams) . '?' . $queryString;
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}

1			<?php
2
3			namespace AtDataGrid\View\Helper;
4
5			use Zend\View\Helper\AbstractHelper;
6
7			class QueryParams extends AbstractHelper
8			{
9			/**
10			* @param array $params
11			* @param bool $reuseMatchedParams
12			* @param bool $resetCurrentParams
13			* @return string
14			*/
15			public function __invoke($params = [], $reuseMatchedParams = true, $resetCurrentParams = false)
			0 ignored issues – show Coding Style introduced 2017-12-12 19:15 UTC by Report Bug Copy Issue Report `__invoke` 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...
16			{
17			$currentParams = [];
18			if (!$resetCurrentParams) {
19			$queryString = $_SERVER['QUERY_STRING'];
20			$currentParamPairs = explode('&', $queryString);
21			if (!empty($currentParamPairs[0])) {
22			foreach ($currentParamPairs as $pair) {
23			$data = explode('=', $pair);
24			$currentParams[$data[0]] = urldecode($data[1]);
25			}
26			}
27			}
28			$queryString = http_build_query(array_merge($currentParams, $params));
29			return $this->getView()->url(null, [], [], $reuseMatchedParams) . '?' . $queryString;
			0 ignored issues – show Bug introduced 2016-07-21 13:32 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\View\Renderer\RendererInterface` as the method `url()` does only exist in the following implementations of said interface: `Zend\View\Renderer\PhpRenderer`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
30			}
31			}

atukai / AtDataGrid

QueryParams::__invoke() A last analyzed 2017-12-12 19:16 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

QueryParams::__invoke() A
last analyzed 2017-12-12 19:16 UTC