AbstractLeaderboardEndpointController - Code Metrics - Inspection of "Code quality and minor bugfixes" - Maelstromeous/ps2alerts-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#22)

by Matthew

created 2017-08-28 16:19 UTC

AbstractLeaderboardEndpointController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	0
loc	103
rs	10
c	0
b	0
f	0
wmc	19
lcom	1
cbo	2

5 Methods

Rating	Name	Size	Complexity
B	validateRequestVars()	24	6
A	parseField()	17	3
A	parseServer()	15	4
A	parseLimit()	8	3
A	parseOffset()	8	3

<?php

// @todo Go over this ENTIRE file again as there's been major refactors since and it's likely broken!

namespace Ps2alerts\Api\Controller\Endpoint\Leaderboards;

use Ps2alerts\Api\Controller\Endpoint\AbstractEndpointController;
use Ps2alerts\Api\Exception\InvalidArgumentException;

abstract class AbstractLeaderboardEndpointController extends AbstractEndpointController
{
    /**
     * Validates the request variables
     *
     * @throws InvalidArgumentException
     * @return boolean
     */
    public function validateRequestVars()
// 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);
    }
}
    {
        try {
            if (! empty($_GET['field'])) {
                $this->parseField($_GET['field']);
            }

            if (! empty($_GET['server'])) {
                $this->parseServer($_GET['server']);
            }

            if (! empty($_GET['limit'])) {
                $this->parseOffset($_GET['limit']);
            }

            if (! empty($_GET['offset'])) {
                $this->parseOffset($_GET['offset']);
            }
        } catch (InvalidArgumentException $e) {
            return $e;
        }

        return true;
    }

    /**
     * Validate the field requested
     *
     * @return string
     */
    public function parseField($field)
    {
        $validFields = [
            'kills',
            'deaths',
            'teamkills',
            'suicides',
            'headshots',
            'captures'
        ];

        if (! empty($field) && in_array($field, $validFields)) {
            return $field;
        }

        throw new InvalidArgumentException("Field '{$field}' is not supported.");
    }

    /**
     * Validate the server requested
     *
     * @return string
     */
    public function parseServer($server)
    {
        $validServers = $this->getConfigItem('servers');

        // Remove Jaeger
        if (($key = array_search(19, $validServers)) !== false) {
            unset($validServers[$key]);
        }

        if (! empty($server) && in_array($server, $validServers)) {
            return $server;
        }

        throw new InvalidArgumentException("Server '{$server}' is not supported.");
    }

    /**
     * Parses limit, making sure it's numerical and valid
     *
     * @return boolean
     */
    public function parseLimit($limit)
    {
        if (! isset($limit) && ! is_numeric($limit)) {
            throw new InvalidArgumentException("Limit needs to be in numerical format.");
        }

        return $limit;
    }

    /**
     * Parses offset, making sure it's numerical and valid
     */
    public function parseOffset($offset)
    {
        if (! isset($offset) && ! is_numeric($offset)) {
            throw new InvalidArgumentException("Offset needs to be in numerical format.");
        }

        return $offset;
    }
}


1			<?php
2
3			// @todo Go over this ENTIRE file again as there's been major refactors since and it's likely broken!
4
5			namespace Ps2alerts\Api\Controller\Endpoint\Leaderboards;
6
7			use Ps2alerts\Api\Controller\Endpoint\AbstractEndpointController;
8			use Ps2alerts\Api\Exception\InvalidArgumentException;
9
10			abstract class AbstractLeaderboardEndpointController extends AbstractEndpointController
11			{
12			/**
13			* Validates the request variables
14			*
15			* @throws InvalidArgumentException
16			* @return boolean
17			*/
18			public function validateRequestVars()
			0 ignored issues – show Coding Style introduced 2017-08-24 20:58 UTC by Report Bug Copy Issue Report `validateRequestVars` 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...
19			{
20			try {
21			if (! empty($_GET['field'])) {
22			$this->parseField($_GET['field']);
23			}
24
25			if (! empty($_GET['server'])) {
26			$this->parseServer($_GET['server']);
27			}
28
29			if (! empty($_GET['limit'])) {
30			$this->parseOffset($_GET['limit']);
31			}
32
33			if (! empty($_GET['offset'])) {
34			$this->parseOffset($_GET['offset']);
35			}
36			} catch (InvalidArgumentException $e) {
37			return $e;
38			}
39
40			return true;
41			}
42
43			/**
44			* Validate the field requested
45			*
46			* @return string
47			*/
48			public function parseField($field)
49			{
50			$validFields = [
51			'kills',
52			'deaths',
53			'teamkills',
54			'suicides',
55			'headshots',
56			'captures'
57			];
58
59			if (! empty($field) && in_array($field, $validFields)) {
60			return $field;
61			}
62
63			throw new InvalidArgumentException("Field '{$field}' is not supported.");
64			}
65
66			/**
67			* Validate the server requested
68			*
69			* @return string
70			*/
71			public function parseServer($server)
72			{
73			$validServers = $this->getConfigItem('servers');
74
75			// Remove Jaeger
76			if (($key = array_search(19, $validServers)) !== false) {
77			unset($validServers[$key]);
78			}
79
80			if (! empty($server) && in_array($server, $validServers)) {
81			return $server;
82			}
83
84			throw new InvalidArgumentException("Server '{$server}' is not supported.");
85			}
86
87			/**
88			* Parses limit, making sure it's numerical and valid
89			*
90			* @return boolean
91			*/
92			public function parseLimit($limit)
93			{
94			if (! isset($limit) && ! is_numeric($limit)) {
95			throw new InvalidArgumentException("Limit needs to be in numerical format.");
96			}
97
98			return $limit;
99			}
100
101			/**
102			* Parses offset, making sure it's numerical and valid
103			*/
104			public function parseOffset($offset)
105			{
106			if (! isset($offset) && ! is_numeric($offset)) {
107			throw new InvalidArgumentException("Offset needs to be in numerical format.");
108			}
109
110			return $offset;
111			}
112			}
113

Maelstromeous / ps2alerts-api

Pull Request — master (#22)

AbstractLeaderboardEndpointController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like