mheinzerling/php-meta

View on GitHub

Showing 29 of 29 total issues

The method abstract has a boolean flag argument $abstract, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function abstract ($abstract = true): ClassWriter
Severity: Minor
Found in src/writer/ClassWriter.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

Function create has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    public function create(): string
    {
        $result = '    ' . $this->visibility->value();
        if ($this->static) $result .= ' static';
        $result .= ' function ' . $this->name . '(';
Severity: Minor
Found in src/writer/MethodWriter.php - About 25 mins to fix

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 toPHP has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    public static function toPHP(PHPType $type, ClassWriter $classWriter): string
    {
        $result = '';
        if ($type->isOptional()) $result .= "?";
        if ($type instanceof PrimitivePHPType) {
Severity: Minor
Found in src/writer/TypeConverter.php - About 25 mins to fix

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 toPHPDoc has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    public static function toPHPDoc(PHPType $type, ClassWriter $classWriter): string
    {
        $result = "";
        if ($type instanceof PrimitivePHPType) {
            $result .= $type->getToken();//TODO array of Object
Severity: Minor
Found in src/writer/TypeConverter.php - About 25 mins to fix

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 write() has an NPath complexity of 2560. The configured NPath complexity threshold is 200.
Open

    public function write(): string
    {
        $result = $this->line("<?php");
        $result .= $this->line("declare(strict_types = 1);");
        $result .= $this->line("");
Severity: Minor
Found in src/writer/ClassWriter.php by phpmd

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 write() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
Open

    public function write(): string
    {
        $result = $this->line("<?php");
        $result .= $this->line("declare(strict_types = 1);");
        $result .= $this->line("");
Severity: Minor
Found in src/writer/ClassWriter.php by phpmd

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

TODO found
Open

    public function print(AClass $class): string //TODO relative namespaces
Severity: Minor
Found in src/writer/ClassWriter.php by fixme

TODO found
Open

            //TODO array
Severity: Minor
Found in src/writer/ClassWriter.php by fixme

TODO found
Open

            $result .= $type->getToken();//TODO array of Object
Severity: Minor
Found in src/writer/TypeConverter.php by fixme
Severity
Category
Status
Source
Language