mheinzerling/php-meta

View on GitHub
src/writer/MethodWriter.php

Summary

Maintainability
A
25 mins
Test Coverage

The class MethodWriter has 16 public methods. Consider refactoring MethodWriter to keep number of public methods under 10.
Open

class MethodWriter
{
    const NODEFAULT = "__NODEFAULT__";
    /**
     * @var string
Severity: Minor
Found in src/writer/MethodWriter.php by phpmd

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

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

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

    public function static (bool $static = true): MethodWriter
Severity: Minor
Found in src/writer/MethodWriter.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

There are no issues that match your filters.

Category
Status