skqr/hateoas

View on GitHub
JsonApi/Request/TranslationsParser.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function serializeTransationObject has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    protected function serializeTransationObject(array $resourceTranslations)
    {
        $translations = [];

        foreach (
Severity: Minor
Found in JsonApi/Request/TranslationsParser.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 parse has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    public function parse(Request $request, Params $params, array $body)
    {
        $translations = [];

        if (
Severity: Minor
Found in JsonApi/Request/TranslationsParser.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 parse has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function parse(Request $request, Params $params, array $body)
    {
        $translations = [];

        if (
Severity: Minor
Found in JsonApi/Request/TranslationsParser.php - About 1 hr to fix

    Avoid using undefined variables such as '$locale' which will lead to PHP notices.
    Open

                    $translations[$locale][$field] = $value;

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
    {
        private function bar()
        {
            // $message is undefined
            echo $message;
        }
    }

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

    Avoid using undefined variables such as '$value' which will lead to PHP notices.
    Open

                    $translations[$locale][$field] = $value;

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
    {
        private function bar()
        {
            // $message is undefined
            echo $message;
        }
    }

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

    Avoid using undefined variables such as '$locale' which will lead to PHP notices.
    Open

                    if (empty($locale) || empty($value)) {

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
    {
        private function bar()
        {
            // $message is undefined
            echo $message;
        }
    }

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

    Avoid using undefined variables such as '$value' which will lead to PHP notices.
    Open

                    if (empty($locale) || empty($value)) {

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
    {
        private function bar()
        {
            // $message is undefined
            echo $message;
        }
    }

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

    Avoid using undefined variables such as '$locale' which will lead to PHP notices.
    Open

                    if (!empty($translations[$locale][$field])) {

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
    {
        private function bar()
        {
            // $message is undefined
            echo $message;
        }
    }

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

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

            } else {
                foreach ($bodyTranslations as $resourceTranslations) {
                    if (empty($resourceTranslations['id'])) {
                        throw new ParseException(self::ERROR_MISSING_ID);
                    } elseif (isset($translations[$resourceTranslations['id']])) {

    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 '\GoIntegro\Hateoas\Util\ArrayHelper' in method 'parse'.
    Open

            if (Util\ArrayHelper::isAssociative($bodyTranslations)) {

    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 '\GoIntegro\Hateoas\Util\ArrayHelper' in method 'parse'.
    Open

                || !Util\ArrayHelper::isAssociative($translations)

    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 unused parameters such as '$request'.
    Open

        public function parse(Request $request, Params $params, array $body)

    UnusedFormalParameter

    Since: 0.2

    Avoid passing parameters to methods or constructors and then not using those parameters.

    Example

    class Foo
    {
        private function bar($howdy)
        {
            // $howdy is not used
        }
    }

    Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

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

                $id = reset($params->primaryIds);

    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

    Space found before closing bracket of FOREACH loop
    Open

            foreach (

    Space found after opening bracket of FOREACH loop
    Open

            foreach (

    There must be one USE keyword per declaration
    Open

    use Symfony\Component\HttpFoundation\Request,

    Inline control structures are not allowed
    Open

                if (!is_array($fieldTranslations)) continue;

    Line exceeds 120 characters; contains 130 characters
    Open

            ERROR_DUPLICATED_TRANSLATION = "Two or more translations were provided twice for the same field and locale in an entity.",

    Expected 0 spaces after opening bracket; newline found
    Open

            if (

    Expected 0 spaces after opening bracket; newline found
    Open

            foreach (

    Expected 0 spaces after opening bracket; newline found
    Open

            if (

    There are no issues that match your filters.

    Category
    Status