The class CheckJobsCommand has an overall complexity of 55 which is very high. The configured complexity threshold is 50. Wontfix
class CheckJobsCommand extends Command
{
/**
* The name and signature of the console command.
*
- Exclude checks
File CheckJobsCommand.php
has 278 lines of code (exceeds 250 allowed). Consider refactoring. Confirmed
<?php
/*
* MIT License
*
Method handle
has 34 lines of code (exceeds 25 allowed). Consider refactoring. Wontfix
public function handle()
{
$this->getAllJobs()
->map(function ($job) {
$assertions = $this->checkJob($job);
Method getAllJobs
has 31 lines of code (exceeds 25 allowed). Consider refactoring. Wontfix
private function getAllJobs(): Collection
{
$jobs = glob(__DIR__.'/../Jobs/*/*.php');
return collect($jobs)
Function checkIsCheckingCache
has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Wontfix
private function checkIsCheckingCache(EsiBase $job): array
{
$cached_seconds = $this->getEsiPaths()[$job->getEndpoint()][$job->getMethod()]['x-cached-seconds'] ?? null;
$has_cached_seconds = ! is_null($cached_seconds);
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Method checkIsCheckingCache
has 27 lines of code (exceeds 25 allowed). Consider refactoring. Wontfix
private function checkIsCheckingCache(EsiBase $job): array
{
$cached_seconds = $this->getEsiPaths()[$job->getEndpoint()][$job->getMethod()]['x-cached-seconds'] ?? null;
$has_cached_seconds = ! is_null($cached_seconds);
Function checkPathValues
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Wontfix
private function checkPathValues(EsiBase $job): array
{
if (! $job instanceof HasPathValuesInterface) {
// Check if any mustache syntax is used in path
if (str_contains($job->getEndpoint(), '{')) {
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Avoid too many return
statements within this method. Wontfix
return $this->assertionResult('success', 'job checks if response is cached');
Avoid too many return
statements within this method. Wontfix
return $this->assertionResult('success', 'path values all set');
Avoid too many return
statements within this method. Wontfix
return $this->assertionResult('success', 'security scope required');
Avoid too many return
statements within this method. Wontfix
return $this->assertionResult('success', 'all required corporate roles are set');
Function checkCorporationRoles
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Wontfix
private function checkCorporationRoles(EsiBase $job): array
{
$required_roles = $this->getEsiPaths()[$job->getEndpoint()][$job->getMethod()]['x-required-roles'] ?? [];
// if no roles are required, return success
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
The method checkIsCheckingCache() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. Wontfix
private function checkIsCheckingCache(EsiBase $job): array
{
$cached_seconds = $this->getEsiPaths()[$job->getEndpoint()][$job->getMethod()]['x-cached-seconds'] ?? null;
$has_cached_seconds = ! is_null($cached_seconds);
- Read upRead up
- Exclude checks
CyclomaticComplexity
Since: 0.1
Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.
Example
// Cyclomatic Complexity = 11
class Foo {
1 public function example() {
2 if ($a == $b) {
3 if ($a1 == $b1) {
fiddle();
4 } elseif ($a2 == $b2) {
fiddle();
} else {
fiddle();
}
5 } elseif ($c == $d) {
6 while ($c == $d) {
fiddle();
}
7 } elseif ($e == $f) {
8 for ($n = 0; $n < $h; $n++) {
fiddle();
}
} else {
switch ($z) {
9 case 1:
fiddle();
break;
10 case 2:
fiddle();
break;
11 case 3:
fiddle();
break;
default:
fiddle();
break;
}
}
}
}
Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity
The class CheckJobsCommand has a coupling between objects value of 18. Consider to reduce the number of dependencies under 13. Wontfix
class CheckJobsCommand extends Command
{
/**
* The name and signature of the console command.
*
- Read upRead up
- Exclude checks
CouplingBetweenObjects
Since: 1.1.0
A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability
Example
class Foo {
/**
* @var \foo\bar\X
*/
private $x = null;
/**
* @var \foo\bar\Y
*/
private $y = null;
/**
* @var \foo\bar\Z
*/
private $z = null;
public function setFoo(\Foo $foo) {}
public function setBar(\Bar $bar) {}
public function setBaz(\Baz $baz) {}
/**
* @return \SplObjectStorage
* @throws \OutOfRangeException
* @throws \InvalidArgumentException
* @throws \ErrorException
*/
public function process(\Iterator $it) {}
// ...
}
Source https://phpmd.org/rules/design.html#couplingbetweenobjects
The method handle uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Invalid
} else {
$this->writeAssertionHeader($job['class'], 'px-2 bg-green text-black uppercase', 'pass');
}
- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}
Source https://phpmd.org/rules/cleancode.html#elseexpression
Avoid unused local variables such as '$value'. Wontfix
foreach ($path_values as $key => $value) {
- Read upRead up
- Exclude checks
UnusedLocalVariable
Since: 0.2
Detects when a local variable is declared and/or assigned, but not used.
Example
class Foo {
public function doSomething()
{
$i = 5; // Unused
}
}
Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable
Avoid excessively long variable names like $required_roles_string. Keep variable name length under 20. Wontfix
$required_roles_string = implode(', ', $required_roles);
- Read upRead up
- Exclude checks
LongVariable
Since: 0.2
Detects when a field, formal or local variable is declared with a long name.
Example
class Something {
protected $reallyLongIntName = -3; // VIOLATION - Field
public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
$otherReallyLongName = -5; // VIOLATION - Local
for ($interestingIntIndex = 0; // VIOLATION - For
$interestingIntIndex < 10;
$interestingIntIndex++ ) {
}
}
}
Source https://phpmd.org/rules/naming.html#longvariable
Avoid excessively long variable names like $endpoint_required_scope. Keep variable name length under 20. Invalid
$endpoint_required_scope = $security[0]['evesso'][0];
- Read upRead up
- Exclude checks
LongVariable
Since: 0.2
Detects when a field, formal or local variable is declared with a long name.
Example
class Something {
protected $reallyLongIntName = -3; // VIOLATION - Field
public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
$otherReallyLongName = -5; // VIOLATION - Local
for ($interestingIntIndex = 0; // VIOLATION - For
$interestingIntIndex < 10;
$interestingIntIndex++ ) {
}
}
}