Sign upLogin

Fleshgrinder/php-format

View on GitHub
Star
src/Formatter.php

Summary

Maintainability
C
1 day
Test Coverage

The class Formatter has an overall complexity of 50 which is very high. The configured complexity threshold is 50.
Open

final class Formatter {
    use Unconstructable;

    /**
     * Format the given pattern by replacing positional and named placeholders
Severity: Minor
Found in src/Formatter.php by phpmd

Function formatArg has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
Open

    private static function formatArg($arg, bool $sign, int $decimals, string $format, string $conjunction): string {
        if ($conjunction === '?') {
            $type = Value::getType($arg);

            if ($type === Value::TYPE_RESOURCE) {
Severity: Minor
Found in src/Formatter.php - About 2 hrs 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

Method formatArg has 40 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function formatArg($arg, bool $sign, int $decimals, string $format, string $conjunction): string {
        if ($conjunction === '?') {
            $type = Value::getType($arg);

            if ($type === Value::TYPE_RESOURCE) {
Severity: Minor
Found in src/Formatter.php - About 1 hr to fix

    Method format has 37 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function format(string $pattern, array $arguments): string {
        if (\strpos($pattern, '[') !== \false) {
            $pattern = \preg_replace_callback(
            /* @lang RegExp */
                '/(?<!\[)\[((?:[^\[\]]|(?R))+)](?!])/',
    Severity: Minor
    Found in src/Formatter.php - About 1 hr to fix

      Method formatArrayArg has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          private static function formatArrayArg(string $type, array $arg, bool $sign, int $decimals, string $format, string $conjunction): string {
      Severity: Minor
      Found in src/Formatter.php - About 45 mins to fix

        Method formatArg has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            private static function formatArg($arg, bool $sign, int $decimals, string $format, string $conjunction): string {
        Severity: Minor
        Found in src/Formatter.php - About 35 mins to fix

          Avoid too many return statements within this method.
          Open

                      return $arg ? 'TRUE' : 'FALSE';
          Severity: Major
          Found in src/Formatter.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                            return self::formatNumber($arg->toFloat(), $sign, $decimals, $format);
            Severity: Major
            Found in src/Formatter.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                              return self::formatString(\get_class($arg), (string) $arg, $format);
              Severity: Major
              Found in src/Formatter.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                                return self::formatString(\get_class($arg), $arg->toString(), $format);
                Severity: Major
                Found in src/Formatter.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return self::formatNumber($arg->toInt(), $sign, $decimals, $format);
                  Severity: Major
                  Found in src/Formatter.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                        return 'void';
                    Severity: Major
                    Found in src/Formatter.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                      return self::formatArrayArg(\get_class($arg), \iterator_to_array($arg, \false), $sign, $decimals, $format, $conjunction);
                      Severity: Major
                      Found in src/Formatter.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                return \str_replace(['{{', '}}', '[[', ']]'], ['{', '}', '[', ']'], $pattern);
                        Severity: Major
                        Found in src/Formatter.php - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                      return self::formatNumber($arg, $sign, $decimals, $format);
                          Severity: Major
                          Found in src/Formatter.php - About 30 mins to fix

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

                                private static function formatControlChars(string $string, string $del, callable $cc): string {
        $result = '';

        for ($i = 0, $bytes = \strlen($string); $i < $bytes; ++$i) {
            $ord = \ord($string{$i});
                            Severity: Minor
                            Found in src/Formatter.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 formatNumber has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                            Open

                                private static function formatNumber($arg, bool $sign, int $decimals, string $format): string {
        if ($format) {
            if ($format === 'e') {
                $pattern = '%';
                $sign && $pattern .= '+';
                            Severity: Minor
                            Found in src/Formatter.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 formatString has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                            Open

                                private static function formatString(string $type, string $arg, string $format): string {
        if ($arg === '') {
            return "empty {$type}";
        }
                            Severity: Minor
                            Found in src/Formatter.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 formatArg() has an NPath complexity of 7128. The configured NPath complexity threshold is 200.
                            Open

                                private static function formatArg($arg, bool $sign, int $decimals, string $format, string $conjunction): string {
        if ($conjunction === '?') {
            $type = Value::getType($arg);

            if ($type === Value::TYPE_RESOURCE) {
                            Severity: Minor
                            Found in src/Formatter.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 formatArg() has a Cyclomatic Complexity of 16. The configured cyclomatic complexity threshold is 10.
                            Open

                                private static function formatArg($arg, bool $sign, int $decimals, string $format, string $conjunction): string {
        if ($conjunction === '?') {
            $type = Value::getType($arg);

            if ($type === Value::TYPE_RESOURCE) {
                            Severity: Minor
                            Found in src/Formatter.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

                            The method formatControlChars uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                            Open

                                        else {
                $result .= $string{$i};
            }
                            Severity: Minor
                            Found in src/Formatter.php by phpmd

                            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

                            Avoid variables with short names like $c. Configured minimum length is 3.
                            Open

                                    $c = \count($arg);
                            Severity: Minor
                            Found in src/Formatter.php by phpmd

                            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;
        }
    }
}

                            Source https://phpmd.org/rules/naming.html#shortvariable

                            Avoid variables with short names like $cc. Configured minimum length is 3.
                            Open

                                private static function formatControlChars(string $string, string $del, callable $cc): string {
                            Severity: Minor
                            Found in src/Formatter.php by phpmd

                            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;
        }
    }
}

                            Source https://phpmd.org/rules/naming.html#shortvariable

                            There are no issues that match your filters.

                            Category
                            Status