DocNavigator.php

Summary

Maintainability
B
6 hrs
Test Coverage

Function dig has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

    private static function dig($raml, $key = NULL)
    {
        $args = array_slice(func_get_args(), 2);

        if (!empty($key)) {
Severity: Minor
Found in DocNavigator.php - About 3 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 dig has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function dig($raml, $key = NULL)
    {
        $args = array_slice(func_get_args(), 2);

        if (!empty($key)) {
Severity: Minor
Found in DocNavigator.php - About 1 hr to fix

    Method findRequestSchema has 32 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function findRequestSchema(
            $method, $resourceUri, $mediaType = RamlSpec::MEDIA_TYPE_JSON
        )
        {
            if (!RamlDoc::isValidMethod($method)) {
    Severity: Minor
    Found in DocNavigator.php - About 1 hr to fix

      Function findRequestSchema has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function findRequestSchema(
              $method, $resourceUri, $mediaType = RamlSpec::MEDIA_TYPE_JSON
          )
          {
              if (!RamlDoc::isValidMethod($method)) {
      Severity: Minor
      Found in DocNavigator.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

      The method dig() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
      Open

          private static function dig($raml, $key = NULL)
          {
              $args = array_slice(func_get_args(), 2);
      
              if (!empty($key)) {
      Severity: Minor
      Found in DocNavigator.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

      Missing class import via use statement (line '128', column '27').
      Open

                      throw new \ErrorException(self::ERROR_INVALID_KEY);
      Severity: Minor
      Found in DocNavigator.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

      Missing class import via use statement (line '60', column '23').
      Open

                  throw new \UnexpectedValueException($message);
      Severity: Minor
      Found in DocNavigator.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

      Missing class import via use statement (line '65', column '23').
      Open

                  throw new \UnexpectedValueException($mediaType);
      Severity: Minor
      Found in DocNavigator.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 using static access to class 'GoIntegro\Raml\RamlDoc' in method 'findRequestSchema'.
      Open

                  if (RamlDoc::isInclude($schema)) {
      Severity: Minor
      Found in DocNavigator.php by phpmd

      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\Raml\RamlDoc' in method 'dig'.
      Open

                  } elseif (RamlDoc::isResource($key)) {
      Severity: Minor
      Found in DocNavigator.php by phpmd

      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\Raml\RamlDoc' in method 'findRequestSchema'.
      Open

              if (!RamlDoc::isValidMethod($method)) {
      Severity: Minor
      Found in DocNavigator.php by phpmd

      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\Raml\RamlDoc' in method 'findRequestSchema'.
      Open

              if (!RamlDoc::isValidMediaType($mediaType)) {
      Severity: Minor
      Found in DocNavigator.php by phpmd

      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

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

              } else {
                  list($resourceType) = explode('/', substr($resourceUri, 1));
      
                  $schema = $this->ramlDoc->schemas->get($resourceType);
              }
      Severity: Minor
      Found in DocNavigator.php by phpmd

      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\Raml\RamlDoc' in method 'dig'.
      Open

                              if (RamlDoc::isParameter($property)) {
      Severity: Minor
      Found in DocNavigator.php by phpmd

      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 private methods such as 'dig'.
      Open

          private static function dig($raml, $key = NULL)
          {
              $args = array_slice(func_get_args(), 2);
      
              if (!empty($key)) {
      Severity: Minor
      Found in DocNavigator.php by phpmd

      UnusedPrivateMethod

      Since: 0.2

      Unused Private Method detects when a private method is declared but is unused.

      Example

      class Something
      {
          private function foo() {} // unused
      }

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

      Each PHP statement must be on a line by itself
      Open

                          $callback = function($part) { return '/' . $part; };
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      Expected 1 space after FUNCTION keyword; 0 found
      Open

                          $callback = function($part) { return '/' . $part; };
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      TRUE, FALSE and NULL must be lowercase; expected "false" but found "FALSE"
      Open

                          $found = FALSE;
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      Multi-line function declarations must define one parameter per line
      Open

              $method, $resourceUri, $mediaType = RamlSpec::MEDIA_TYPE_JSON
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      Multi-line function declarations must define one parameter per line
      Open

              $method, $resourceUri, $mediaType = RamlSpec::MEDIA_TYPE_JSON
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line
      Open

          {
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      TRUE, FALSE and NULL must be lowercase; expected "true" but found "TRUE"
      Open

                                  $found = TRUE;
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL"
      Open

          private static function dig($raml, $key = NULL)
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      Only one argument is allowed per line in a multi-line function call
      Open

                          $schema, $this->ramlDoc->fileDir
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      Line exceeds 120 characters; contains 141 characters
      Open

              ERROR_PARAM_NOT_FOUND = "One of the keys provided \"%s\" was assumed to be an Id or list of Ids, but a matching path was not found.",
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      Closing brace must be on a line by itself
      Open

                          $callback = function($part) { return '/' . $part; };
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      Opening brace must be the last content on the line
      Open

                          $callback = function($part) { return '/' . $part; };
      Severity: Minor
      Found in DocNavigator.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status