File FallbackUnionTypeVisitor.php
has 411 lines of code (exceeds 250 allowed). Consider refactoring. Open
<?php
declare(strict_types=1);
namespace Phan\AST;
FallbackUnionTypeVisitor
has 29 functions (exceeds 20 allowed). Consider refactoring. Open
class FallbackUnionTypeVisitor extends KindVisitorImplementation
{
/**
* @var CodeBase
* The code base within which we're operating
The class FallbackUnionTypeVisitor has 27 public methods. Consider refactoring FallbackUnionTypeVisitor to keep number of public methods under 10. Open
class FallbackUnionTypeVisitor extends KindVisitorImplementation
{
/**
* @var CodeBase
* The code base within which we're operating
- Read upRead up
- Exclude checks
TooManyPublicMethods
Since: 0.1
A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
By default it ignores methods starting with 'get' or 'set'.
Example
Source https://phpmd.org/rules/codesize.html#toomanypublicmethods
The class FallbackUnionTypeVisitor has an overall complexity of 109 which is very high. The configured complexity threshold is 50. Open
class FallbackUnionTypeVisitor extends KindVisitorImplementation
{
/**
* @var CodeBase
* The code base within which we're operating
- Exclude checks
The class FallbackUnionTypeVisitor has 29 non-getter- and setter-methods. Consider refactoring FallbackUnionTypeVisitor to keep number of methods under 25. Open
class FallbackUnionTypeVisitor extends KindVisitorImplementation
{
/**
* @var CodeBase
* The code base within which we're operating
- Read upRead up
- Exclude checks
TooManyMethods
Since: 0.1
A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
By default it ignores methods starting with 'get' or 'set'.
The default was changed from 10 to 25 in PHPMD 2.3.
Example
Source https://phpmd.org/rules/codesize.html#toomanymethods
Method visitBinaryOp
has 36 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function visitBinaryOp(Node $node): UnionType
{
switch ($node->flags) {
case flags\BINARY_ADD:
return UnionType::fromFullyQualifiedRealString('int|float|array');
Method visitConditional
has 35 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function visitConditional(Node $node): UnionType
{
$cond_node = $node->children['cond'];
$cond_truthiness = UnionTypeVisitor::checkCondUnconditionalTruthiness($cond_node);
// For the shorthand $a ?: $b, the cond node will be the truthy value.
Method visitClassNameNode
has 28 lines of code (exceeds 25 allowed). Consider refactoring. Open
private function visitClassNameNode(Node $node): ?UnionType
{
// Things of the form `new $className()`, `new $obj()`, `new (foo())()`, etc.
if ($node->kind !== \ast\AST_NAME) {
return null;
Function visitStaticCall
has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
public function visitStaticCall(Node $node): UnionType
{
['class' => $class_node, 'method' => $method_name] = $node->children;
if (!\is_string($method_name) || !($class_node instanceof Node) || $class_node->kind !== ast\AST_NAME) {
// Give up on dynamic calls
- 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
Function visitClassConst
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
public function visitClassConst(Node $node): UnionType
{
$class_node = $node->children['class'];
if (!$class_node instanceof Node || $class_node->kind !== ast\AST_NAME) {
// ignore nonsense like (0)::class, and dynamic accesses such as $var::CLASS
- 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
Function visitClassNameNode
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
private function visitClassNameNode(Node $node): ?UnionType
{
// Things of the form `new $className()`, `new $obj()`, `new (foo())()`, etc.
if ($node->kind !== \ast\AST_NAME) {
return null;
- 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
Function visitCall
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
public function visitCall(Node $node): UnionType
{
$expression = $node->children['expr'];
if (!($expression instanceof Node && $expression->kind === ast\AST_NAME)) {
// Give up on closures, callables
- 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. Open
return UnionType::empty();
Avoid too many return
statements within this method. Open
return UnionType::fromFullyQualifiedRealString('int|float');
Avoid too many return
statements within this method. Open
return StringType::instance(false)->asRealUnionType();
Avoid too many return
statements within this method. Open
return Type::fromFullyQualifiedString('\stdClass')->asRealUnionType();
Avoid too many return
statements within this method. Open
return UnionType::empty();
Avoid too many return
statements within this method. Open
return UnionType::fromFullyQualifiedRealString('-1|0|1');
Avoid too many return
statements within this method. Open
return ArrayType::instance(false)->asRealUnionType();
Avoid too many return
statements within this method. Open
return UnionType::fromFullyQualifiedRealString('int');
Avoid too many return
statements within this method. Open
return $this->analyzeCoalesce($node);
Avoid too many return
statements within this method. Open
return $this->context->getClassFQSEN()->asType()->asRealUnionType();
Avoid too many return
statements within this method. Open
return UnionType::empty();
Avoid too many return
statements within this method. Open
return $method->getUnionType();
Avoid too many return
statements within this method. Open
return StaticType::instance(false)->asRealUnionType();
Avoid too many return
statements within this method. Open
return UnionType::empty();
Avoid too many return
statements within this method. Open
return $parent_type_option->get()->asRealUnionType();
Function visitMethodCall
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
public function visitMethodCall(Node $node): UnionType
{
['expr' => $expr_node, 'method' => $method_name] = $node->children;
if (!\is_string($method_name) || !($expr_node instanceof Node) || $expr_node->kind !== ast\AST_VAR) {
// Give up on dynamic calls
- 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 visitBinaryOp() has a Cyclomatic Complexity of 26. The configured cyclomatic complexity threshold is 10. Open
public function visitBinaryOp(Node $node): UnionType
{
switch ($node->flags) {
case flags\BINARY_ADD:
return UnionType::fromFullyQualifiedRealString('int|float|array');
- 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 FallbackUnionTypeVisitor has a coupling between objects value of 21. Consider to reduce the number of dependencies under 13. Open
class FallbackUnionTypeVisitor extends KindVisitorImplementation
{
/**
* @var CodeBase
* The code base within which we're operating
- 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
Identical blocks of code found in 2 locations. Consider refactoring. Open
public function visitClosure(Node $node): UnionType
{
// The type of a closure is the fqsen pointing
// at its definition
$closure_fqsen =
- 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 90.
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