jaroslavtyc/drd-plus-codes

View on GitHub
Codes/Partials/TranslatableExtendableCode.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function checkTranslationsFormat has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

    private static function checkTranslationsFormat(array $translations)
    {
        /**
         * @var string $languageCode
         * @var array|string[] $languageTranslations
Severity: Minor
Found in Codes/Partials/TranslatableExtendableCode.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

Function getTranslations has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    protected function getTranslations(string $requiredLanguageCode): array
    {
        if ((self::$translations[static::class] ?? null) === null) {
            $translations = self::$customCodeTranslations[static::class] ?? [];
            if (count($translations) === 0) {
Severity: Minor
Found in Codes/Partials/TranslatableExtendableCode.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 checkTranslationsFormat has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function checkTranslationsFormat(array $translations)
    {
        /**
         * @var string $languageCode
         * @var array|string[] $languageTranslations
Severity: Minor
Found in Codes/Partials/TranslatableExtendableCode.php - About 1 hr to fix

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

                } else {
                    foreach ($this->fetchTranslations() as $currentLanguageCode => $languageTranslations) {
                        /** @var array $languageTranslations */
                        foreach ($languageTranslations as $codeValue => $codeTranslations) {
                            // child translations can overwrite custom translations

    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 using static access to class '\Granam\Tools\ValueDescriber' in method 'checkTranslationsFormat'.
    Open

                            'Expected non-empty string, got ' . ValueDescriber::describe($translation)

    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

    Avoid using static access to class '\Granam\Tools\ValueDescriber' in method 'checkTranslationsFormat'.
    Open

                        . ValueDescriber::describe($languageTranslations) . ' for language ' . $languageCode

    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

    Avoid excessively long variable names like $customCodeTranslations. Keep variable name length under 20.
    Open

        private static $customCodeTranslations = [];

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

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

    There are no issues that match your filters.

    Category
    Status