LeaderboardPlayerEndpointController::players() - 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

LeaderboardPlayerEndpointController::players() C

↳ Parent: LeaderboardPlayerEndpointController

Complexity

Conditions	11
Paths	83

Size

Total Lines	67
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	11
eloc	37
nc	83
nop	0
dl	0
loc	67
rs	5.8904
c	0
b	0
f	0

How to fix Long Method Complexity

<?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\Exception\CensusEmptyException;
use Ps2alerts\Api\Exception\CensusErrorException;
use Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository;
use Ps2alerts\Api\Transformer\Leaderboards\PlayerLeaderboardTransformer;
use Ps2alerts\Api\Controller\Endpoint\Data\DataEndpointController;

class LeaderboardPlayerEndpointController extends AbstractLeaderboardEndpointController
{
    protected $dataEndpoint;
    protected $repository;

    /**
     * Construct
     *
     * @param DataEndpointController
     * @param PlayerTotalRepository
     */
    public function __construct(
        DataEndpointController $dataEndpoint,
        PlayerTotalRepository  $repository
    ) {
        $this->repository = $repository;
        $this->dataEndpoint = $dataEndpoint;
    }

    /**
     * Get Player Leaderboard
     *
     * @return \League\Fractal\Manager
     */
    public function players()
// 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);
    }
}
    {
        $valid = $this->validateRequestVars();

        // If validation didn't pass, chuck 'em out
        if ($valid !== true) {
            return $this->respondWithError($valid->getMessage(), self::CODE_WRONG_ARGS);
        }

        $server = $_GET['server'];
        $limit  = $_GET['limit'];
        $offset = $_GET['offset'];

        // Translate field into table specific columns
        if (isset($_GET['field'])) {
            $field = $this->getField($_GET['field']);
        }

        if (! isset($field)) {
            return $this->respondWithError('Field wasn\'t provided and is required.', self::CODE_WRONG_ARGS);
        }

        // Perform Query
        $query = $this->repository->newQuery();
        $query->cols(['*']);
        $query->orderBy(["{$field} desc"]);

        if (isset($server)) {
            $query->where('playerServer = ?', $server);
        }

        if (isset($limit)) {
            $query->limit($limit);
        } else {
            $query->limit(10); // Set default limit
        }

        if (isset($offset)) {
            $query->offset($offset);
        }

        $players = $this->repository->fireStatementAndReturn($query);

        $count = count($players);

        // Gets outfit details
        for ($i = 0; $i < $count; $i++) {
            if (! empty($players[$i]['playerOutfit'])) {
                // Gets outfit details
                try {
                    $outfit = $this->dataEndpoint->getOutfit($players[$i]['playerOutfit']);
                } catch (CensusErrorException $e) {
                    $outfit = null;
                } catch (CensusEmptyException $e) {
                    $outfit = null;
                }

                $players[$i]['playerOutfit'] = $outfit;
            }
        }

        return $this->respond(
            'collection',
            $players,
            new PlayerLeaderboardTransformer
        );
    }

    /**
     * Gets the appropiate field for the table and handles some table naming oddities
     * @param  string $input Field to look at
     * @return string
     */
    public function getField($input) {

        $field = null;

        switch ($input) {
            case 'kills':
                $field = 'playerKills';
                break;
            case 'deaths':
                $field = 'playerDeaths';
                break;
            case 'teamkills':
                $field = 'playerTeamKills';
                break;
            case 'suicides':
                $field = 'playerSuicides';
                break;
            case 'headshots':
                $field = 'headshots';
                break;
        }

        return $field;
    }
}


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\Exception\CensusEmptyException;
8		use Ps2alerts\Api\Exception\CensusErrorException;
9		use Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository;
10		use Ps2alerts\Api\Transformer\Leaderboards\PlayerLeaderboardTransformer;
11		use Ps2alerts\Api\Controller\Endpoint\Data\DataEndpointController;
12
13		class LeaderboardPlayerEndpointController extends AbstractLeaderboardEndpointController
14		{
15		protected $dataEndpoint;
16		protected $repository;
17
18		/**
19		* Construct
20		*
21		* @param DataEndpointController
22		* @param PlayerTotalRepository
23		*/
24		public function __construct(
25		DataEndpointController $dataEndpoint,
26		PlayerTotalRepository $repository
27		) {
28		$this->repository = $repository;
29		$this->dataEndpoint = $dataEndpoint;
30		}
31
32		/**
33		* Get Player Leaderboard
34		*
35		* @return \League\Fractal\Manager
36		*/
37		public function players()
		0 ignored issues – show Coding Style introduced 2017-08-24 20:58 UTC by Report Bug Copy Issue Report `players` 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...
38		{
39		$valid = $this->validateRequestVars();
40
41		// If validation didn't pass, chuck 'em out
42		if ($valid !== true) {
43		return $this->respondWithError($valid->getMessage(), self::CODE_WRONG_ARGS);
44		}
45
46		$server = $_GET['server'];
47		$limit = $_GET['limit'];
48		$offset = $_GET['offset'];
49
50		// Translate field into table specific columns
51		if (isset($_GET['field'])) {
52		$field = $this->getField($_GET['field']);
53		}
54
55		if (! isset($field)) {
56		return $this->respondWithError('Field wasn\'t provided and is required.', self::CODE_WRONG_ARGS);
57		}
58
59		// Perform Query
60		$query = $this->repository->newQuery();
61		$query->cols(['*']);
62		$query->orderBy(["{$field} desc"]);
63
64		if (isset($server)) {
65		$query->where('playerServer = ?', $server);
66		}
67
68		if (isset($limit)) {
69		$query->limit($limit);
70		} else {
71		$query->limit(10); // Set default limit
72		}
73
74		if (isset($offset)) {
75		$query->offset($offset);
76		}
77
78		$players = $this->repository->fireStatementAndReturn($query);
79
80		$count = count($players);
81
82		// Gets outfit details
83		for ($i = 0; $i < $count; $i++) {
84		if (! empty($players[$i]['playerOutfit'])) {
85		// Gets outfit details
86		try {
87		$outfit = $this->dataEndpoint->getOutfit($players[$i]['playerOutfit']);
88		} catch (CensusErrorException $e) {
89		$outfit = null;
90		} catch (CensusEmptyException $e) {
91		$outfit = null;
92		}
93
94		$players[$i]['playerOutfit'] = $outfit;
95		}
96		}
97
98		return $this->respond(
99		'collection',
100		$players,
101		new PlayerLeaderboardTransformer
102		);
103		}
104
105		/**
106		* Gets the appropiate field for the table and handles some table naming oddities
107		* @param string $input Field to look at
108		* @return string
109		*/
110	View Code Duplication	public function getField($input) {
		0 ignored issues – show Duplication introduced 2017-08-24 20:58 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
111		$field = null;
112
113		switch ($input) {
114		case 'kills':
115		$field = 'playerKills';
116		break;
117		case 'deaths':
118		$field = 'playerDeaths';
119		break;
120		case 'teamkills':
121		$field = 'playerTeamKills';
122		break;
123		case 'suicides':
124		$field = 'playerSuicides';
125		break;
126		case 'headshots':
127		$field = 'headshots';
128		break;
129		}
130
131		return $field;
132		}
133		}
134

Maelstromeous / ps2alerts-api

Pull Request — master (#22)

LeaderboardPlayerEndpointController::players() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like