jaroslavtyc/drd-plus-codes

View on GitHub
Codes/Partials/TranslatableCode.php

Summary

Maintainability
B
6 hrs
Test Coverage

Function translateTo has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Open

    public function translateTo(string $languageCode, $amount = 1): string
    {
        $code = $this->getValue();
        $translations = $this->getTranslations($languageCode);
        /** @noinspection ExceptionsAnnotatingAndHandlingInspection */
Severity: Minor
Found in Codes/Partials/TranslatableCode.php - About 1 hr 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 translateTo has 43 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function translateTo(string $languageCode, $amount = 1): string
    {
        $code = $this->getValue();
        $translations = $this->getTranslations($languageCode);
        /** @noinspection ExceptionsAnnotatingAndHandlingInspection */
Severity: Minor
Found in Codes/Partials/TranslatableCode.php - About 1 hr to fix

    Avoid too many return statements within this method.
    Open

                    return $translations[$code][$plural];
    Severity: Major
    Found in Codes/Partials/TranslatableCode.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                  return str_replace('_', ' ', $code); // just replacing underscores by spaces
      Severity: Major
      Found in Codes/Partials/TranslatableCode.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                        return $translations[$plural][$code];
        Severity: Major
        Found in Codes/Partials/TranslatableCode.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                      return $translations[$plural][$code];
          Severity: Major
          Found in Codes/Partials/TranslatableCode.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                    return str_replace('_', ' ', $code); // just replacing underscores by spaces
            Severity: Major
            Found in Codes/Partials/TranslatableCode.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                          return $translations[$code][$plural]; // explicit english translation
              Severity: Major
              Found in Codes/Partials/TranslatableCode.php - About 30 mins to fix

                The method translateTo() has an NPath complexity of 800. The configured NPath complexity threshold is 200.
                Open

                    public function translateTo(string $languageCode, $amount = 1): string
                    {
                        $code = $this->getValue();
                        $translations = $this->getTranslations($languageCode);
                        /** @noinspection ExceptionsAnnotatingAndHandlingInspection */
                Severity: Minor
                Found in Codes/Partials/TranslatableCode.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 translateTo() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
                Open

                    public function translateTo(string $languageCode, $amount = 1): string
                    {
                        $code = $this->getValue();
                        $translations = $this->getTranslations($languageCode);
                        /** @noinspection ExceptionsAnnotatingAndHandlingInspection */
                Severity: Minor
                Found in Codes/Partials/TranslatableCode.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

                Avoid using static access to class '\Granam\Number\Tools\ToNumber' in method 'translateTo'.
                Open

                        $plural = $this->convertAmountToPlural(ToNumber::toNumber($amount));
                Severity: Minor
                Found in Codes/Partials/TranslatableCode.php by phpmd

                StaticAccess

                Since: 1.4.0

                Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

                Example

                class Foo
                {
                    public function bar()
                    {
                        Bar::baz();
                    }
                }

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

                The property $FEW_DECIMAL is not named in camelCase.
                Open

                abstract class TranslatableCode extends AbstractCode implements Translatable
                {
                    // protected static values are more comfortable then protected constants in children classes
                    protected static $ONE = 'one';
                    protected static $FEW = 'few';
                Severity: Minor
                Found in Codes/Partials/TranslatableCode.php by phpmd

                CamelCasePropertyName

                Since: 0.2

                It is considered best practice to use the camelCase notation to name attributes.

                Example

                class ClassName {
                    protected $property_name;
                }

                Source

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

                    protected static $EN = 'en';
                Severity: Minor
                Found in Codes/Partials/TranslatableCode.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 $CS. Configured minimum length is 3.
                Open

                    protected static $CS = 'cs';
                Severity: Minor
                Found in Codes/Partials/TranslatableCode.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