Function extractDocComment
has a Cognitive Complexity of 47 (exceeds 5 allowed). Consider refactoring. Open
public static function extractDocComment(string $doc_comment, int $comment_category = null, UnionType $element_type = null, bool $remove_type = false): string
{
// Trim the start and the end of the doc comment.
//
// We leave in the second `*` of `/**` so that every single non-empty line
- 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 extractDescriptionFromDocComment
has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring. Open
public static function extractDescriptionFromDocComment(
AddressableElementInterface $element,
CodeBase $code_base = null
): ?string {
$extracted_doc_comment = self::extractDescriptionFromDocCommentRaw($element);
- 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
File MarkupDescription.php
has 347 lines of code (exceeds 250 allowed). Consider refactoring. Open
<?php
declare(strict_types=1);
namespace Phan\Language\Element;
The class MarkupDescription has 12 public methods. Consider refactoring MarkupDescription to keep number of public methods under 10. Open
class MarkupDescription
{
/**
* Generates a markup snippet with a description of the declaration of $element,
* and its doc comment summary and description.
- 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 MarkupDescription has an overall complexity of 98 which is very high. The configured complexity threshold is 50. Open
class MarkupDescription
{
/**
* Generates a markup snippet with a description of the declaration of $element,
* and its doc comment summary and description.
- Exclude checks
Function extractParamTagsFromDocComment
has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring. Open
public static function extractParamTagsFromDocComment(AddressableElementInterface $element, bool $with_param_details = true): array
{
$doc_comment = $element->getDocComment();
if (!\is_string($doc_comment)) {
return [];
- 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 extractDocComment
has 51 lines of code (exceeds 25 allowed). Consider refactoring. Open
public static function extractDocComment(string $doc_comment, int $comment_category = null, UnionType $element_type = null, bool $remove_type = false): string
{
// Trim the start and the end of the doc comment.
//
// We leave in the second `*` of `/**` so that every single non-empty line
Method extractDescriptionFromDocComment
has 45 lines of code (exceeds 25 allowed). Consider refactoring. Open
public static function extractDescriptionFromDocComment(
AddressableElementInterface $element,
CodeBase $code_base = null
): ?string {
$extracted_doc_comment = self::extractDescriptionFromDocCommentRaw($element);
Function trimLeadingWhitespace
has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring. Open
private static function trimLeadingWhitespace(array $lines): array
{
if (count($lines) === 0) {
return [];
}
- 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 extractParamTagsFromDocComment
has 34 lines of code (exceeds 25 allowed). Consider refactoring. Open
public static function extractParamTagsFromDocComment(AddressableElementInterface $element, bool $with_param_details = true): array
{
$doc_comment = $element->getDocComment();
if (!\is_string($doc_comment)) {
return [];
Function extractTagSummary
has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
public static function extractTagSummary(array $lines, int $i): array
{
$summary = [];
$summary[] = self::trimLine($lines[$i]);
for ($j = $i + 1; $j < count($lines); $j++) {
- 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 deeply nested control flow statements. Open
if (StringUtil::isNonZeroLengthString($class_description)) {
return "Construct an instance of `{$class->getFQSEN()}`.\n\n$class_description";
}
Avoid deeply nested control flow statements. Open
if (isset($new_lines[0])) {
// @phan-suppress-next-line PhanAccessClassConstantInternal
$new_lines[0] = \preg_replace(Builder::RETURN_COMMENT_REGEX, $remove_type ? '' : '`\0`', $new_lines[0]);
}
Function extractDescriptionFromDocCommentOfAncestorOfClassElement
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
private static function extractDescriptionFromDocCommentOfAncestorOfClassElement(
ClassElement $element,
CodeBase $code_base,
array &$checked_class_fqsens = []
): ?string {
- 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 deeply nested control flow statements. Open
if (isset($new_lines[0])) {
$did_build_from_phpdoc_tag = true;
// @phan-suppress-next-line PhanAccessClassConstantInternal
$new_lines[0] = \preg_replace(Builder::PARAM_COMMENT_REGEX, $remove_type ? '' : '`\0`', $new_lines[0]);
}
Avoid too many return
statements within this method. Open
return self::loadClassDescriptionMap()[$key] ?? null;
Avoid too many return
statements within this method. Open
return self::loadPropertyDescriptionMap()[$key] ?? null;
Avoid too many return
statements within this method. Open
return null;
Function extractDescriptionFromDocCommentOrAncestor
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
public static function extractDescriptionFromDocCommentOrAncestor(
AddressableElementInterface $element,
CodeBase $code_base,
array &$checked_class_fqsens = []
): ?string {
- 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 extractDocComment() has an NPath complexity of 804. The configured NPath complexity threshold is 200. Open
public static function extractDocComment(string $doc_comment, int $comment_category = null, UnionType $element_type = null, bool $remove_type = false): string
{
// Trim the start and the end of the doc comment.
//
// We leave in the second `*` of `/**` so that every single non-empty line
- 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 extractDescriptionFromDocComment() has a Cyclomatic Complexity of 16. The configured cyclomatic complexity threshold is 10. Open
public static function extractDescriptionFromDocComment(
AddressableElementInterface $element,
CodeBase $code_base = null
): ?string {
$extracted_doc_comment = self::extractDescriptionFromDocCommentRaw($element);
- 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 extractDocComment() has a Cyclomatic Complexity of 21. The configured cyclomatic complexity threshold is 10. Open
public static function extractDocComment(string $doc_comment, int $comment_category = null, UnionType $element_type = null, bool $remove_type = false): string
{
// Trim the start and the end of the doc comment.
//
// We leave in the second `*` of `/**` so that every single non-empty line
- 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 MarkupDescription has a coupling between objects value of 14. Consider to reduce the number of dependencies under 13. Open
class MarkupDescription
{
/**
* Generates a markup snippet with a description of the declaration of $element,
* and its doc comment summary and description.
- 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
Avoid using empty try-catch blocks in extractDescriptionFromDocComment. Open
} catch (Exception $_) {
}
- Read upRead up
- Exclude checks
EmptyCatchBlock
Since: 2.7.0
Usually empty try-catch is a bad idea because you are silently swallowing an error condition and then continuing execution. Occasionally this may be the right thing to do, but often it's a sign that a developer saw an exception, didn't know what to do about it, and so used an empty catch to silence the problem.
Example
class Foo {
public function bar()
{
try {
// ...
} catch (Exception $e) {} // empty catch block
}
}
Source https://phpmd.org/rules/design.html#emptycatchblock
Avoid variables with short names like $i. Configured minimum length is 3. Open
public static function extractTagSummary(array $lines, int $i): array
- Read upRead up
- Exclude checks
ShortVariable
Since: 0.2
Detects when a field, local, or parameter has a very short name.
Example
class Something {
private $q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal
$r = 20 + $this->q; // VIOLATION - Local
for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
$r += $this->q;
}
}
}