nabbar/SwaggerValidator-PHP

View on GitHub
src/DataType/TypeString.php

Summary

Maintainability
D
1 day
Test Coverage

The class TypeString has an overall complexity of 58 which is very high. The configured complexity threshold is 50.
Open

class TypeString extends \SwaggerValidator\DataType\TypeCommon
{

    const PATTERN_BYTE     = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$';
    //const PATTERN_BINARY   = '^(?:([A-Fa-f0-9]{2})*|([01]{4}[ ]?)*)?$'; // Allow Hexa form
Severity: Minor
Found in src/DataType/TypeString.php by phpmd

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

    protected function format(\SwaggerValidator\Common\Context $context, $valueParams)
    {
        if (!$this->__isset('format') || empty($this->format)) {
            return true;
        }
Severity: Minor
Found in src/DataType/TypeString.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 format has 39 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function format(\SwaggerValidator\Common\Context $context, $valueParams)
    {
        if (!$this->__isset('format') || empty($this->format)) {
            return true;
        }
Severity: Minor
Found in src/DataType/TypeString.php - About 1 hr to fix

    Method getExampleFormat has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        protected function getExampleFormat(\SwaggerValidator\Common\Context $context)
        {
            if ($this->format == 'byte') {
                /**
                 * @see RFC 4648 : http://www.ietf.org/rfc/rfc4648.txt
    Severity: Minor
    Found in src/DataType/TypeString.php - About 1 hr to fix

      Function validate has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

          public function validate(\SwaggerValidator\Common\Context $context)
          {
              if (!$this->__isset('type')) {
                  return $context->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_SWAGGER_ERROR, null, __METHOD__, __LINE__);
              }
      Severity: Minor
      Found in src/DataType/TypeString.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 validate has 29 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function validate(\SwaggerValidator\Common\Context $context)
          {
              if (!$this->__isset('type')) {
                  return $context->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_SWAGGER_ERROR, null, __METHOD__, __LINE__);
              }
      Severity: Minor
      Found in src/DataType/TypeString.php - About 1 hr to fix

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

            protected function getExampleFormat(\SwaggerValidator\Common\Context $context)
            {
                if ($this->format == 'byte') {
                    /**
                     * @see RFC 4648 : http://www.ietf.org/rfc/rfc4648.txt
        Severity: Minor
        Found in src/DataType/TypeString.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

        Avoid too many return statements within this method.
        Open

                    return '2001:' . base_convert(random_int(0, pow(2, 16) - 1), 10, 16) . ':' . base_convert(random_int(0, pow(2, 16) - 1), 10, 16) . ':' . base_convert(random_int(0, pow(2, 16) - 1), 10, 16) . ':' . base_convert(random_int(0, pow(2, 16) - 1), 10, 16) . ':' . base_convert(random_int(0, pow(2, 16) - 1), 10, 16) . '::';
        Severity: Major
        Found in src/DataType/TypeString.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                  return true;
          Severity: Major
          Found in src/DataType/TypeString.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                        return $context->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_DATATYPE, 'The format does not match with registred patterns', __METHOD__, __LINE__);
            Severity: Major
            Found in src/DataType/TypeString.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                          return long2ip(random_int(167772161, 4210752250));
              Severity: Major
              Found in src/DataType/TypeString.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                            return $context->setDataCheck('pattern')->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_PATTERN, null, __METHOD__, __LINE__);
                Severity: Major
                Found in src/DataType/TypeString.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                          return (bool) preg_match($pattern, $valueParams);
                  Severity: Major
                  Found in src/DataType/TypeString.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                return false;
                    Severity: Major
                    Found in src/DataType/TypeString.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                              return $this->getExampleType($context);
                      Severity: Major
                      Found in src/DataType/TypeString.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                    return $context->setDataCheck('maxLength')->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_DATASIZE, null, __METHOD__, __LINE__);
                        Severity: Major
                        Found in src/DataType/TypeString.php - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                      return $this->generateRandowSign();
                          Severity: Major
                          Found in src/DataType/TypeString.php - About 30 mins to fix

                            Avoid too many return statements within this method.
                            Open

                                        return $context->setDataCheck('minLength')->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_DATASIZE, null, __METHOD__, __LINE__);
                            Severity: Major
                            Found in src/DataType/TypeString.php - About 30 mins to fix

                              Avoid too many return statements within this method.
                              Open

                                          return 'http://localhost/path/script.php?query#fragment';
                              Severity: Major
                              Found in src/DataType/TypeString.php - About 30 mins to fix

                                Avoid too many return statements within this method.
                                Open

                                            return $context->setDataCheck('enum')->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_DATAVALUE, null, __METHOD__, __LINE__);
                                Severity: Major
                                Found in src/DataType/TypeString.php - About 30 mins to fix

                                  The method validate() has an NPath complexity of 1024. The configured NPath complexity threshold is 200.
                                  Open

                                      public function validate(\SwaggerValidator\Common\Context $context)
                                      {
                                          if (!$this->__isset('type')) {
                                              return $context->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_SWAGGER_ERROR, null, __METHOD__, __LINE__);
                                          }
                                  Severity: Minor
                                  Found in src/DataType/TypeString.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 getExampleFormat() has an NPath complexity of 256. The configured NPath complexity threshold is 200.
                                  Open

                                      protected function getExampleFormat(\SwaggerValidator\Common\Context $context)
                                      {
                                          if ($this->format == 'byte') {
                                              /**
                                               * @see RFC 4648 : http://www.ietf.org/rfc/rfc4648.txt
                                  Severity: Minor
                                  Found in src/DataType/TypeString.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() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
                                  Open

                                      public function validate(\SwaggerValidator\Common\Context $context)
                                      {
                                          if (!$this->__isset('type')) {
                                              return $context->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_SWAGGER_ERROR, null, __METHOD__, __LINE__);
                                          }
                                  Severity: Minor
                                  Found in src/DataType/TypeString.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 format() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10.
                                  Open

                                      protected function format(\SwaggerValidator\Common\Context $context, $valueParams)
                                      {
                                          if (!$this->__isset('format') || empty($this->format)) {
                                              return true;
                                          }
                                  Severity: Minor
                                  Found in src/DataType/TypeString.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 __storeData uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                                  Open

                                          else {
                                              parent::__storeData($key, $value);
                                          }
                                  Severity: Minor
                                  Found in src/DataType/TypeString.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 unused parameters such as '$context'.
                                  Open

                                      protected function type(\SwaggerValidator\Common\Context $context, $valueParams)
                                  Severity: Minor
                                  Found in src/DataType/TypeString.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 __storeData is not named in camelCase.
                                  Open

                                      protected function __storeData($key, $value = null)
                                      {
                                          if (property_exists($this, $key)) {
                                              $this->$key = $value;
                                          }
                                  Severity: Minor
                                  Found in src/DataType/TypeString.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