Group::GetGroupSummary() - Code Metrics - syntaxerrors/Steam - Measure and Improve Code Quality continuously with Scrutinizer

Group::GetGroupSummary() A
last analyzed 2021-01-24 02:09 UTC

↳ Parent: Group

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	26
ccs	10
cts	10
cp	1
rs	9.504
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2

<?php

namespace Syntax\SteamApi\Steam;

use Syntax\SteamApi\Client;
use Syntax\SteamApi\Containers\Group as GroupContainer;

class Group extends Client
{
    public function GetGroupSummary($group)
    {
        // Set up the api details
        $this->method = 'memberslistxml';

        if (is_numeric($group)) {
            $this->url = 'http://steamcommunity.com/gid/';
        } else {
            $this->url = 'http://steamcommunity.com/groups/';
        }

        $this->url = $this->url . $group;

        // Set up the arguments
        $arguments = [
            'xml' => 1,
        ];

        // Get the client
        $client = $this->setUpXml($arguments);

        // Clean up the games
        $group = new GroupContainer($client);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        return $group;
    }
}


1		<?php
2
3		namespace Syntax\SteamApi\Steam;
4
5		use Syntax\SteamApi\Client;
6		use Syntax\SteamApi\Containers\Group as GroupContainer;
7
8		class Group extends Client
9		{
10	2	public function GetGroupSummary($group)
11		{
12		// Set up the api details
13	2	$this->method = 'memberslistxml';
14
15	2	if (is_numeric($group)) {
16	1	$this->url = 'http://steamcommunity.com/gid/';
17		} else {
18	1	$this->url = 'http://steamcommunity.com/groups/';
19		}
20
21	2	$this->url = $this->url . $group;
22
23		// Set up the arguments
24		$arguments = [
25	2	'xml' => 1,
26		];
27
28		// Get the client
29	2	$client = $this->setUpXml($arguments);
30
31		// Clean up the games
32	2	$group = new GroupContainer($client);
		0 ignored issues – show Bug introduced 2019-10-17 02:44 UTC by Report Bug Copy Issue Report It seems like `$client` defined by `$this->setUpXml($arguments)` on line `29` can be `null`; however, `Syntax\SteamApi\Containers\Group::__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
33
34	2	return $group;
35		}
36		}
37

syntaxerrors / Steam

Group::GetGroupSummary() A last analyzed 2021-01-24 02:09 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Group::GetGroupSummary() A
last analyzed 2021-01-24 02:09 UTC