yiisoft/yii2

View on GitHub
framework/filters/ContentNegotiator.php

Summary

Maintainability
B
6 hrs
Test Coverage

Function negotiateLanguage has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    protected function negotiateLanguage($request)
    {
        if (!empty($this->languageParam) && ($language = $request->get($this->languageParam)) !== null) {
            if (is_array($language)) {
                // If an array received, then skip it and use the first of supported languages
Severity: Minor
Found in framework/filters/ContentNegotiator.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

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

    protected function negotiateContentType($request, $response)
    {
        if (!empty($this->formatParam) && ($format = $request->get($this->formatParam)) !== null) {
            if (is_array($format)) {
                throw new BadRequestHttpException("Invalid data received for GET parameter '{$this->formatParam}'.");
Severity: Minor
Found in framework/filters/ContentNegotiator.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

Avoid too many return statements within this method.
Open

                return $this->languages[$language];
Severity: Major
Found in framework/filters/ContentNegotiator.php - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

            return reset($this->languages);
    Severity: Major
    Found in framework/filters/ContentNegotiator.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                          return $supported;
      Severity: Major
      Found in framework/filters/ContentNegotiator.php - About 30 mins to fix

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

            public function negotiate()
            {
                $request = $this->request ?: Yii::$app->getRequest();
                $response = $this->response ?: Yii::$app->getResponse();
                if (!empty($this->formats)) {
        Severity: Minor
        Found in framework/filters/ContentNegotiator.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 negotiateContentType() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
        Open

            protected function negotiateContentType($request, $response)
            {
                if (!empty($this->formatParam) && ($format = $request->get($this->formatParam)) !== null) {
                    if (is_array($format)) {
                        throw new BadRequestHttpException("Invalid data received for GET parameter '{$this->formatParam}'.");

        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 negotiateLanguage() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10.
        Open

            protected function negotiateLanguage($request)
            {
                if (!empty($this->languageParam) && ($language = $request->get($this->languageParam)) !== null) {
                    if (is_array($language)) {
                        // If an array received, then skip it and use the first of supported languages

        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 assigning values to variables in if clauses and the like (line '229', column '46').
        Open

            protected function negotiateLanguage($request)
            {
                if (!empty($this->languageParam) && ($language = $request->get($this->languageParam)) !== null) {
                    if (is_array($language)) {
                        // If an array received, then skip it and use the first of supported languages

        IfStatementAssignment

        Since: 2.7.0

        Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

        Example

        class Foo
        {
            public function bar($flag)
            {
                if ($foo = 'bar') { // possible typo
                    // ...
                }
                if ($baz = 0) { // always false
                    // ...
                }
            }
        }

        Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

        Avoid assigning values to variables in if clauses and the like (line '179', column '44').
        Open

            protected function negotiateContentType($request, $response)
            {
                if (!empty($this->formatParam) && ($format = $request->get($this->formatParam)) !== null) {
                    if (is_array($format)) {
                        throw new BadRequestHttpException("Invalid data received for GET parameter '{$this->formatParam}'.");

        IfStatementAssignment

        Since: 2.7.0

        Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

        Example

        class Foo
        {
            public function bar($flag)
            {
                if ($foo = 'bar') { // possible typo
                    // ...
                }
                if ($baz = 0) { // always false
                    // ...
                }
            }
        }

        Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

        There are no issues that match your filters.

        Category
        Status