sysInfo::onMessage() - Code Metrics - Inspection of "Daily Inspection: close #230" - shibdib/Dramiel - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (878382)

unknown

created 2017-05-15 18:59 UTC

sysInfo::onMessage() C

↳ Parent: sysInfo

Complexity

Conditions	9
Paths	12

Size

Total Lines	89
Code Lines	53

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	53
nc	12
nop	2
dl	0
loc	89
rs	5.2228
c	0
b	0
f	0

How to fix Long Method

<?php

use Discord\Discord;

class sysInfo
namespace YourVendor;

class YourClass { }
{
	public $config;
	public $discord;
	public $logger;
	private $excludeChannel;
	private $message;
	private $triggers;

	public function init($config, $discord, $logger)
	{
		$this->config = $config;
		$this->discord = $discord;
		$this->logger = $logger;
		$this->excludeChannel = $this->config['bot']['restrictedChannels'];
		$this->triggers[] = $this->config['bot']['trigger'] . 'sys';
		$this->triggers[] = $this->config['bot']['trigger'] . 'Sys';
		$this->triggers[] = $this->config['bot']['trigger'] . 'sysinfo';
		$this->triggers[] = $this->config['bot']['trigger'] . 'system';
		$this->triggers[] = $this->config['bot']['trigger'] . 'System';
		$this->triggers[] = $this->config['bot']['trigger'] . 'Sysinfo';
	}

	public function onMessage($msgData, $message)
	{
		$channelID = (int) $msgData['message']['channelID'];

		if(in_array($channelID, $this->excludeChannel, true))
		{
			return null;
		}

		$this->message = $message;

		$message = $msgData['message']['message'];
		$user = $msgData['message']['from'];

		$data = command($message, $this->information()['trigger'], $this->config['bot']['trigger']);
		if(isset($data['trigger']))
		{
			$messageString = strstr($data['messageString'], '@') ? str_replace('<@', '', str_replace('>', '', $data['messageString'])) : $data['messageString'];
			if(is_numeric($messageString))
			{
				$messageString = dbQueryField('SELECT name FROM usersSeen WHERE id = :id', 'name', array(':id' => $messageString));
			}
			$cleanString = urlencode($messageString);
			$sysID = urlencode(getSystemID($cleanString));

			//Check if we get a system back, otherwise check for partials
			if(empty($sysID))
			{
                return $this->message->reply('**Error:** no data available');
			}

			$systemDetails = systemDetails($sysID);
			if (null === $systemDetails)
			{
				return $this->message->reply('**Error:** ESI is down. Try again later.');
			}

			$url = "https://zkillboard.com/api/stats/solarSystemID/{$sysID}/";
			$json = json_decode(file_get_contents($url));

			$regionID = $json->info->regionID;
			$regionName = getRegionName($regionID);

			$thisMonth = (string)date('Ym');
            $lastMonth = (string)date('Ym', strtotime('first day of previous month'));

            $thisMonthKill = $json->months->$thisMonth->shipsDestroyed;
            $lastMonthKill = $json->months->$lastMonth->shipsDestroyed;

            $activePVP = $json->activepvp;
            $activeKills = $activePVP->kills->count;
            $activeChars = $activePVP->characters->count;

			$sysName = $systemDetails['name'];
			$secStatus = round($systemDetails['security_status'],2);

			$npc = "https://api.eveonline.com/map/kills.xml.aspx";
			$npc = new SimpleXMLElement(file_get_contents($npc));
			foreach($npc->result->rowset->row as $row){
				if($row->attributes()->solarSystemID == $sysID){
					$npcKills = $row->attributes()->factionKills;
					$podKills = $row->attributes()->podKills;
				}
			}

			$url = "https://zkillboard.com/system/{$sysID}/";

			$msg = "```Systeminfo
Name: {$sysName} 
Region: {$regionName}
Security: {$secStatus}

Kills
This Month: {$thisMonthKill}
Last Month: {$lastMonthKill}

Activity
Characters: {$activeChars}
Kills: {$activeKills}
Pod Kills: {$podKills}
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
NPC Kills: {$npcKills}
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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

More information: $url";
			$this->logger->addInfo("sysInfo: Sending system information to {$user}");
			$this->message->reply($msg);
		}
		return null;
	}

	public function information()
	{
		return array(
			'name' => 'sys',
			'trigger' => $this->triggers,
			'information' => 'Returns information for the given system'
			);
	}
}


1			<?php
2
3			use Discord\Discord;
4
5			class sysInfo
			0 ignored issues – show Coding Style Compatibility introduced 2017-03-22 07:32 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
6			{
7			public $config;
8			public $discord;
9			public $logger;
10			private $excludeChannel;
11			private $message;
12			private $triggers;
13
14			public function init($config, $discord, $logger)
15			{
16			$this->config = $config;
17			$this->discord = $discord;
18			$this->logger = $logger;
19			$this->excludeChannel = $this->config['bot']['restrictedChannels'];
20			$this->triggers[] = $this->config['bot']['trigger'] . 'sys';
21			$this->triggers[] = $this->config['bot']['trigger'] . 'Sys';
22			$this->triggers[] = $this->config['bot']['trigger'] . 'sysinfo';
23			$this->triggers[] = $this->config['bot']['trigger'] . 'system';
24			$this->triggers[] = $this->config['bot']['trigger'] . 'System';
25			$this->triggers[] = $this->config['bot']['trigger'] . 'Sysinfo';
26			}
27
28			public function onMessage($msgData, $message)
29			{
30			$channelID = (int) $msgData['message']['channelID'];
31
32			if(in_array($channelID, $this->excludeChannel, true))
33			{
34			return null;
35			}
36
37			$this->message = $message;
38
39			$message = $msgData['message']['message'];
40			$user = $msgData['message']['from'];
41
42			$data = command($message, $this->information()['trigger'], $this->config['bot']['trigger']);
43			if(isset($data['trigger']))
44			{
45			$messageString = strstr($data['messageString'], '@') ? str_replace('<@', '', str_replace('>', '', $data['messageString'])) : $data['messageString'];
46			if(is_numeric($messageString))
47			{
48			$messageString = dbQueryField('SELECT name FROM usersSeen WHERE id = :id', 'name', array(':id' => $messageString));
49			}
50			$cleanString = urlencode($messageString);
51			$sysID = urlencode(getSystemID($cleanString));
52
53			//Check if we get a system back, otherwise check for partials
54			if(empty($sysID))
55			{
56			return $this->message->reply('Error: no data available');
57			}
58
59			$systemDetails = systemDetails($sysID);
60			if (null === $systemDetails)
61			{
62			return $this->message->reply('Error: ESI is down. Try again later.');
63			}
64
65			$url = "https://zkillboard.com/api/stats/solarSystemID/{$sysID}/";
66			$json = json_decode(file_get_contents($url));
67
68			$regionID = $json->info->regionID;
69			$regionName = getRegionName($regionID);
70
71			$thisMonth = (string)date('Ym');
72			$lastMonth = (string)date('Ym', strtotime('first day of previous month'));
73
74			$thisMonthKill = $json->months->$thisMonth->shipsDestroyed;
75			$lastMonthKill = $json->months->$lastMonth->shipsDestroyed;
76
77			$activePVP = $json->activepvp;
78			$activeKills = $activePVP->kills->count;
79			$activeChars = $activePVP->characters->count;
80
81			$sysName = $systemDetails['name'];
82			$secStatus = round($systemDetails['security_status'],2);
83
84			$npc = "https://api.eveonline.com/map/kills.xml.aspx";
85			$npc = new SimpleXMLElement(file_get_contents($npc));
86			foreach($npc->result->rowset->row as $row){
87			if($row->attributes()->solarSystemID == $sysID){
88			$npcKills = $row->attributes()->factionKills;
89			$podKills = $row->attributes()->podKills;
90			}
91			}
92
93			$url = "https://zkillboard.com/system/{$sysID}/";
94
95			$msg = "```Systeminfo
96			Name: {$sysName}
97			Region: {$regionName}
98			Security: {$secStatus}
99
100			Kills
101			This Month: {$thisMonthKill}
102			Last Month: {$lastMonthKill}
103
104			Activity
105			Characters: {$activeChars}
106			Kills: {$activeKills}
107			Pod Kills: {$podKills}
			0 ignored issues – show Bug introduced 2017-03-22 07:32 UTC by Report Bug Copy Issue Report The variable `$podKills` 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...
108			NPC Kills: {$npcKills}
			0 ignored issues – show Bug introduced 2017-03-22 07:32 UTC by Report Bug Copy Issue Report The variable `$npcKills` 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...
109			```
110
111			More information: $url";
112			$this->logger->addInfo("sysInfo: Sending system information to {$user}");
113			$this->message->reply($msg);
114			}
115			return null;
116			}
117
118			public function information()
119			{
120			return array(
121			'name' => 'sys',
122			'trigger' => $this->triggers,
123			'information' => 'Returns information for the given system'
124			);
125			}
126			}
127

shibdib / Dramiel

Branch — master (878382)

sysInfo::onMessage() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like