avalanche-development/swagger-validation-middleware

View on GitHub

Showing 14 of 14 total issues

Method checkParamValue has 36 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function checkParamValue(array $param)
    {
        if ($param['type'] === 'array') {
            $this->checkItems($param);

Severity: Minor
Found in src/Parameter/ParameterCheck.php - About 1 hr to fix

    Method check has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function check(array $param)
        {
            if (!is_string($param['value'])) {
                throw new ValidationException('Value is not a string');
            }
    Severity: Minor
    Found in src/Parameter/Format/StringCheck.php - About 1 hr to fix

      Function check has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          public function check(array $param)
          {
              if (!is_string($param['value'])) {
                  throw new ValidationException('Value is not a string');
              }
      Severity: Minor
      Found in src/Parameter/Format/StringCheck.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 check has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function check(array $param)
          {
              if (!filter_var($param['value'], FILTER_VALIDATE_INT)) {
                  throw new ValidationException('Value is not an integer');
              }
      Severity: Minor
      Found in src/Parameter/Format/IntegerCheck.php - About 45 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

      Missing class import via use statement (line '64', column '19').
      Open

              throw new \Exception('OAuth is not yet implemented');
      Severity: Minor
      Found in src/SecurityCheck.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Avoid too many return statements within this method.
      Open

                  return;
      Severity: Major
      Found in src/Parameter/ParameterCheck.php - About 30 mins to fix

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

            protected function checkRange(array $param)
            {
                if (isset($param['maximum']) && $param['value'] > $param['maximum']) {
                    throw new ValidationException('Value exceeds maximum');
                }
        Severity: Minor
        Found in src/Parameter/Format/NumberCheck.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

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

            protected function checkItems(array $param)
            {
                if (isset($param['maxItems']) && $param['maxItems'] < count($param['value'])) {
                    throw new ValidationException('Size of array exceeds maxItems');
                }
        Severity: Minor
        Found in src/Parameter/ParameterCheck.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

        Avoid unused parameters such as '$request'.
        Open

            protected function checkOauthScheme(RequestInterface $request, array $scheme)
        Severity: Minor
        Found in src/SecurityCheck.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 check() has an NPath complexity of 432. The configured NPath complexity threshold is 200.
        Open

            public function check(array $param)
            {
                if (!is_string($param['value'])) {
                    throw new ValidationException('Value is not a string');
                }
        Severity: Minor
        Found in src/Parameter/Format/StringCheck.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

        Avoid unused parameters such as '$scheme'.
        Open

            protected function checkOauthScheme(RequestInterface $request, array $scheme)
        Severity: Minor
        Found in src/SecurityCheck.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 check() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
        Open

            public function check(array $param)
            {
                if (!is_string($param['value'])) {
                    throw new ValidationException('Value is not a string');
                }
        Severity: Minor
        Found in src/Parameter/Format/StringCheck.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

        Expected 0 spaces after opening bracket; newline found
        Open

                if (

        Expected 1 space after FOREACH keyword; 0 found
        Open

                foreach($requiredProperties as $requiredProperty) {
        Severity
        Category
        Status
        Source
        Language