handle accesses the super-global variable $_SERVER. Open
public function handle(
ServerRequestInterface $request,
ResponseInterface $response,
ApiOutputInterface $output
): ?ResponseInterface {
- Read upRead up
- Exclude checks
Superglobals
Since: 0.2
Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.
Example
class Foo {
public function bar() {
$name = $_POST['foo'];
}
}
Source
Function handle
has a Cognitive Complexity of 45 (exceeds 5 allowed). Consider refactoring. Open
public function handle(
ServerRequestInterface $request,
ResponseInterface $response,
ApiOutputInterface $output
): ?ResponseInterface {
- 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 handle
has 334 lines of code (exceeds 200 allowed). Consider refactoring. Open
public function handle(
ServerRequestInterface $request,
ResponseInterface $response,
ApiOutputInterface $output
): ?ResponseInterface {
File ApiHandler.php
has 580 lines of code (exceeds 500 allowed). Consider refactoring. Open
<?php
declare(strict_types=0);
/**
The class ApiHandler has an overall complexity of 79 which is very high. The configured complexity threshold is 50. Open
final class ApiHandler implements ApiHandlerInterface
{
private RequestParserInterface $requestParser;
private StreamFactoryInterface $streamFactory;
- Exclude checks
Method _executeHandler
has 9 arguments (exceeds 4 allowed). Consider refactoring. Open
Gatekeeper $gatekeeper,
int $api_version,
bool $is_public,
string $action,
string $handlerClassName,
Method _executeDebugHandler
has 8 arguments (exceeds 4 allowed). Consider refactoring. Open
Gatekeeper $gatekeeper,
bool $is_public,
string $action,
string $handlerClassName,
array $input,
Function _executeHandler
has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
private function _executeHandler(
Gatekeeper $gatekeeper,
int $api_version,
bool $is_public,
string $action,
- 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 __construct
has 7 arguments (exceeds 4 allowed). Consider refactoring. Open
RequestParserInterface $requestParser,
StreamFactoryInterface $streamFactory,
LoggerInterface $logger,
ConfigContainerInterface $configContainer,
NetworkCheckerInterface $networkChecker,
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error4(
401,
T_('Session Expired')
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error5(
ErrorCodeEnum::FAILED_ACCESS_CHECK,
T_('Unauthorized access attempt to API - ACL Error'),
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error3(
403,
T_('Unauthorized access attempt to API - ACL Error')
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error5(
$e->getCode(),
$e->getMessage(),
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error(
ErrorCodeEnum::GENERIC_ERROR,
'Generic error',
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error(
ErrorCodeEnum::FAILED_ACCESS_CHECK,
T_('Unauthorized access attempt to API - ACL Error'),
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error(
ErrorCodeEnum::ACCESS_CONTROL_NOT_ENABLED,
T_('Access Denied'),
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error4(
405,
T_('Invalid Request')
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error3(
401,
T_('Session Expired')
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error5(
ErrorCodeEnum::MISSING,
T_('Invalid Request'),
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error3(
405,
T_('Invalid Request')
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error(
ErrorCodeEnum::INVALID_HANDSHAKE,
T_('Session Expired'),
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error3(
405,
T_('Invalid Request')
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error(
ErrorCodeEnum::MISSING,
T_('Invalid Request'),
Avoid too many return
statements within this method. Open
return $this->_executeDebugHandler(
$gatekeeper,
$is_public,
$action,
$handlerClassName,
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error5(
ErrorCodeEnum::GENERIC_ERROR,
'Generic error',
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error(
$e->getCode(),
$e->getMessage(),
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error5(
ErrorCodeEnum::INVALID_HANDSHAKE,
T_('Session Expired'),
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error4(
403,
T_('Unauthorized access attempt to API - ACL Error')
Avoid too many return
statements within this method. Open
return $this->_executeHandler(
$gatekeeper,
$api_version,
$is_public,
$action,
Avoid too many return
statements within this method. Open
return $response->withBody(
$this->streamFactory->createStream(
$output->error4(
405,
T_('Invalid Request')
The method handle() has 379 lines of code. Current threshold is set to 100. Avoid really long methods. Open
public function handle(
ServerRequestInterface $request,
ResponseInterface $response,
ApiOutputInterface $output
): ?ResponseInterface {
- Exclude checks
The method handle() has an NPath complexity of 3029529600. The configured NPath complexity threshold is 200. Open
public function handle(
ServerRequestInterface $request,
ResponseInterface $response,
ApiOutputInterface $output
): ?ResponseInterface {
- Read upRead up
- Exclude checks
NPathComplexity
Since: 0.1
The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.
Example
class Foo {
function bar() {
// lots of complicated code
}
}
Source https://phpmd.org/rules/codesize.html#npathcomplexity
The method _executeHandler() has 159 lines of code. Current threshold is set to 100. Avoid really long methods. Open
private function _executeHandler(
Gatekeeper $gatekeeper,
int $api_version,
bool $is_public,
string $action,
- Exclude checks
The method handle() has a Cyclomatic Complexity of 58. The configured cyclomatic complexity threshold is 10. Open
public function handle(
ServerRequestInterface $request,
ResponseInterface $response,
ApiOutputInterface $output
): ?ResponseInterface {
- 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 method _executeHandler() has a Cyclomatic Complexity of 15. The configured cyclomatic complexity threshold is 10. Open
private function _executeHandler(
Gatekeeper $gatekeeper,
int $api_version,
bool $is_public,
string $action,
- 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 ApiHandler has a coupling between objects value of 30. Consider to reduce the number of dependencies under 13. Open
final class ApiHandler implements ApiHandlerInterface
{
private RequestParserInterface $requestParser;
private StreamFactoryInterface $streamFactory;
- 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 _executeDebugHandler uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$params = [$input];
/** @var callable $callback */
$callback = [$handlerClassName, $action];
- 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
The method _executeHandler uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$params = [$input];
/** @var callable $callback */
$callback = [$handlerClassName, $action];
- 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
syntax error, unexpected 'RequestParserInterface' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST)
Open
private RequestParserInterface $requestParser;
- Exclude checks
Similar blocks of code found in 2 locations. Consider refactoring. Open
private function _executeDebugHandler(
Gatekeeper $gatekeeper,
bool $is_public,
string $action,
string $handlerClassName,
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 205.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 2 locations. Consider refactoring. Open
try {
/**
* This condition allows the `new` approach and the legacy one to co-exist.
* After implementing the MethodInterface in all api methods, the condition will be removed
*
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 205.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 3 locations. Consider refactoring. Open
switch ($api_version) {
case 3:
return $response->withBody(
$this->streamFactory->createStream(
$output->error3(
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 172.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 3 locations. Consider refactoring. Open
switch ($api_version) {
case 3:
return $response->withBody(
$this->streamFactory->createStream(
$output->error3(
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 172.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 3 locations. Consider refactoring. Open
switch ($api_version) {
case 3:
return $response->withBody(
$this->streamFactory->createStream(
$output->error3(
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 172.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 8 locations. Consider refactoring. Open
public function __construct(
RequestParserInterface $requestParser,
StreamFactoryInterface $streamFactory,
LoggerInterface $logger,
ConfigContainerInterface $configContainer,
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 116.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
The parameter $is_public is not named in camelCase. Open
private function _executeDebugHandler(
Gatekeeper $gatekeeper,
bool $is_public,
string $action,
string $handlerClassName,
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $api_version is not named in camelCase. Open
private function _executeHandler(
Gatekeeper $gatekeeper,
int $api_version,
bool $is_public,
string $action,
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
The parameter $is_public is not named in camelCase. Open
private function _executeHandler(
Gatekeeper $gatekeeper,
int $api_version,
bool $is_public,
string $action,
- Read upRead up
- Exclude checks
CamelCaseParameterName
Since: 0.2
It is considered best practice to use the camelCase notation to name parameters.
Example
class ClassName {
public function doSomething($user_name) {
}
}
Source
Method name "_executeDebugHandler" should not be prefixed with an underscore to indicate visibility Open
private function _executeDebugHandler(
- Exclude checks
Method name "_executeHandler" should not be prefixed with an underscore to indicate visibility Open
private function _executeHandler(
- Exclude checks
Expected 0 spaces after opening bracket; newline found Open
if (
- Exclude checks
Expected 0 spaces after opening bracket; newline found Open
if (
- Exclude checks
Expected 0 spaces after opening bracket; newline found Open
if (
- Exclude checks
Expected 0 spaces after opening bracket; newline found Open
if (
- Exclude checks
Expected 0 spaces after opening bracket; newline found Open
if (
- Exclude checks