api_battles::getDescription() - Code Metrics - EVE-KILL/zKillboard - Measure and Improve Code Quality continuously with Scrutinizer

api_battles::getDescription() A
last analyzed 2016-02-10 18:51 UTC

↳ Parent: api_battles

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	0

<?php
/* zKillboard
 * Copyright (C) 2012-2015 EVE-KILL Team and EVSCO.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

class api_battles implements apiEndpoint
{
	public function getDescription()
	{
		return array("type" => "description", "message" =>
			"Battles lists the battles that has been sorted by users. You can list all the battles that are available, and you can call up data for a single battle."
		);
	}

	public function getAcceptedParameters()
	{
		return array("type" => "parameters", "parameters" =>
			array(
				"list" => "Lists all the battles available to peruse.",
				"battle/#/" => "Lists data for a single battle. Replace # with a battleID."
			)
		);
	}
	public function execute($parameters)
	{
		$command = isset($parameters["battles"]) ? $parameters["battles"] : NULL;
		$battleID = isset($parameters["battle"]) ? $parameters["battle"] : 0;

		if($command == "list")
		{
			$data = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$battles = Db::query("SELECT * FROM zz_battles", array(), 360);
			foreach($battles as $key => $value)
			{
				unset($battles[$key]["teamAJson"]);
				unset($battles[$key]["teamBJson"]);
			}
			return $battles;
		}
		elseif($command == "battle")
		{
			$getData = Db::queryRow("SELECT * FROM zz_battles WHERE battleID = :battleID", array(":battleID" => $battleID), 360);

			foreach($getData as $key => $value)
			{
				switch($key)
				{
					case "teamAinvolved":
					case "teamBinvolved":
						$data[$key] = json_decode($value, true);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
					break;

					case "teamAJson":
					case "teamBJson":
						$subJson = json_decode($value, true);
						foreach($subJson as $d)
							$data[$key][] = json_decode($d, true);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
					break;

					default:
							$data[$key] = $value;
					break;
				}
			}
			return $data;
		}
		else
			return array(
				"type" => "error",
				"message" => "No valid parameter passed."
			);
	}
}


1			<?php
2			/* zKillboard
3			* Copyright (C) 2012-2015 EVE-KILL Team and EVSCO.
4			*
5			* This program is free software: you can redistribute it and/or modify
6			* it under the terms of the GNU Affero General Public License as published by
7			* the Free Software Foundation, either version 3 of the License, or
8			* (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU Affero General Public License for more details.
14			*
15			* You should have received a copy of the GNU Affero General Public License
16			* along with this program. If not, see <http://www.gnu.org/licenses/>.
17			*/
18
19			class api_battles implements apiEndpoint
20			{
21			public function getDescription()
22			{
23			return array("type" => "description", "message" =>
24			"Battles lists the battles that has been sorted by users. You can list all the battles that are available, and you can call up data for a single battle."
25			);
26			}
27
28			public function getAcceptedParameters()
29			{
30			return array("type" => "parameters", "parameters" =>
31			array(
32			"list" => "Lists all the battles available to peruse.",
33			"battle/#/" => "Lists data for a single battle. Replace # with a battleID."
34			)
35			);
36			}
37			public function execute($parameters)
38			{
39			$command = isset($parameters["battles"]) ? $parameters["battles"] : NULL;
40			$battleID = isset($parameters["battle"]) ? $parameters["battle"] : 0;
41
42			if($command == "list")
43			{
44			$data = array();
			0 ignored issues – show Unused Code introduced 2015-12-13 23:29 UTC by Report Bug Copy Issue Report `$data` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
45			$battles = Db::query("SELECT * FROM zz_battles", array(), 360);
46			foreach($battles as $key => $value)
47			{
48			unset($battles[$key]["teamAJson"]);
49			unset($battles[$key]["teamBJson"]);
50			}
51			return $battles;
52			}
53			elseif($command == "battle")
54			{
55			$getData = Db::queryRow("SELECT * FROM zz_battles WHERE battleID = :battleID", array(":battleID" => $battleID), 360);
56
57			foreach($getData as $key => $value)
58			{
59			switch($key)
60			{
61			case "teamAinvolved":
62			case "teamBinvolved":
63			$data[$key] = json_decode($value, true);
			0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-13 23:29 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
64			break;
65
66			case "teamAJson":
67			case "teamBJson":
68			$subJson = json_decode($value, true);
69			foreach($subJson as $d)
70			$data[$key][] = json_decode($d, true);
			0 ignored issues – show Bug introduced 2015-12-13 23:29 UTC by Report Bug Copy Issue Report The variable `$data` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
71			break;
72
73			default:
74			$data[$key] = $value;
75			break;
76			}
77			}
78			return $data;
79			}
80			else
81			return array(
82			"type" => "error",
83			"message" => "No valid parameter passed."
84			);
85			}
86			}
87

EVE-KILL / zKillboard

api_battles::getDescription() A last analyzed 2016-02-10 18:51 UTC

Complexity

Size

Duplication

Available Fixes

Duplication Side-by-Side

Filter issues like

api_battles::getDescription() A
last analyzed 2016-02-10 18:51 UTC