src/Http/Composers/AbstractMenu.php

Summary

Maintainability
C
1 day
Test Coverage

Function validate_menu has a Cognitive Complexity of 44 (exceeds 5 allowed). Consider refactoring.
Open

    public function validate_menu(string $package_name, array $menu_data)
    {

        if (! is_string($package_name))
            throw new PackageMenuBuilderException(
Severity: Minor
Found in src/Http/Composers/AbstractMenu.php - About 6 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 validate_menu has 43 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function validate_menu(string $package_name, array $menu_data)
    {

        if (! is_string($package_name))
            throw new PackageMenuBuilderException(
Severity: Minor
Found in src/Http/Composers/AbstractMenu.php - About 1 hr to fix

    The method validate_menu() has an NPath complexity of 8856. The configured NPath complexity threshold is 200.
    Open

        public function validate_menu(string $package_name, array $menu_data)
        {
    
            if (! is_string($package_name))
                throw new PackageMenuBuilderException(
    Severity: Minor
    Found in src/Http/Composers/AbstractMenu.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 validate_menu() has a Cyclomatic Complexity of 19. The configured cyclomatic complexity threshold is 10.
    Open

        public function validate_menu(string $package_name, array $menu_data)
        {
    
            if (! is_string($package_name))
                throw new PackageMenuBuilderException(
    Severity: Minor
    Found in src/Http/Composers/AbstractMenu.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 load_plugin_menu has a boolean flag argument $require_affiliation, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function load_plugin_menu(string $package_name, array $menu_data, bool $require_affiliation = false): ?array
    Severity: Minor
    Found in src/Http/Composers/AbstractMenu.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
        public function bar($flag = true) {
        }
    }

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

    Avoid unused parameters such as '$require_affiliation'.
    Open

        public function load_plugin_menu(string $package_name, array $menu_data, bool $require_affiliation = false): ?array
    Severity: Minor
    Found in src/Http/Composers/AbstractMenu.php by phpmd

    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

    The method load_plugin_menu is not named in camelCase.
    Open

        public function load_plugin_menu(string $package_name, array $menu_data, bool $require_affiliation = false): ?array
        {
    
            // Validate the package menu
            $this->validate_menu($package_name, $menu_data);
    Severity: Minor
    Found in src/Http/Composers/AbstractMenu.php by phpmd

    CamelCaseMethodName

    Since: 0.2

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

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method validate_menu is not named in camelCase.
    Open

        public function validate_menu(string $package_name, array $menu_data)
        {
    
            if (! is_string($package_name))
                throw new PackageMenuBuilderException(
    Severity: Minor
    Found in src/Http/Composers/AbstractMenu.php by phpmd

    CamelCaseMethodName

    Since: 0.2

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

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    There are no issues that match your filters.

    Category
    Status