nabbar/SwaggerValidator-PHP

View on GitHub
src/DataType/TypeCommon.php

Summary

Maintainability
C
1 day
Test Coverage

TypeCommon has 28 functions (exceeds 20 allowed). Consider refactoring.
Open

abstract class TypeCommon extends \SwaggerValidator\Common\CollectionSwagger
{

    abstract protected function type(\SwaggerValidator\Common\Context $context, $valueParams);

Severity: Minor
Found in src/DataType/TypeCommon.php - About 3 hrs to fix

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

    abstract class TypeCommon extends \SwaggerValidator\Common\CollectionSwagger
    {
    
        abstract protected function type(\SwaggerValidator\Common\Context $context, $valueParams);
    
    
    Severity: Minor
    Found in src/DataType/TypeCommon.php by phpmd

    The class TypeCommon has 14 public methods. Consider refactoring TypeCommon to keep number of public methods under 10.
    Open

    abstract class TypeCommon extends \SwaggerValidator\Common\CollectionSwagger
    {
    
        abstract protected function type(\SwaggerValidator\Common\Context $context, $valueParams);
    
    
    Severity: Minor
    Found in src/DataType/TypeCommon.php by phpmd

    TooManyPublicMethods

    Since: 0.1

    A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

    By default it ignores methods starting with 'get' or 'set'.

    Example

    Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

    File TypeCommon.php has 261 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    
    /*
     * Copyright 2016 Nicolas JUHEL <swaggervalidator@nabbar.com>.
     *
    Severity: Minor
    Found in src/DataType/TypeCommon.php - About 2 hrs to fix

      Method formatModel has 28 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected function formatModel(\SwaggerValidator\Common\Context $context, $value)
          {
              $keyIn   = \SwaggerValidator\Common\FactorySwagger::KEY_IN;
              $keyType = \SwaggerValidator\Common\FactorySwagger::KEY_IN;
      
      
      Severity: Minor
      Found in src/DataType/TypeCommon.php - About 1 hr to fix

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

            protected function formatModel(\SwaggerValidator\Common\Context $context, $value)
            {
                $keyIn   = \SwaggerValidator\Common\FactorySwagger::KEY_IN;
                $keyType = \SwaggerValidator\Common\FactorySwagger::KEY_IN;
        
        
        Severity: Minor
        Found in src/DataType/TypeCommon.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 $this->formatModel($context, $this->getExampleType($context));
        Severity: Major
        Found in src/DataType/TypeCommon.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                      return $value;
          Severity: Major
          Found in src/DataType/TypeCommon.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                    return $value;
            Severity: Major
            Found in src/DataType/TypeCommon.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

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

                Avoid too many return statements within this method.
                Open

                                return $context->setDataValue(explode(',', $context->getDataValue()));
                Severity: Major
                Found in src/DataType/TypeCommon.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return $context;
                  Severity: Major
                  Found in src/DataType/TypeCommon.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                        return $context->setDataValue(array($context->getDataValue()));
                    Severity: Major
                    Found in src/DataType/TypeCommon.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                  return urlencode($value);
                      Severity: Major
                      Found in src/DataType/TypeCommon.php - About 30 mins to fix

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

                            protected function formatModel(\SwaggerValidator\Common\Context $context, $value)
                            {
                                $keyIn   = \SwaggerValidator\Common\FactorySwagger::KEY_IN;
                                $keyType = \SwaggerValidator\Common\FactorySwagger::KEY_IN;
                        
                        
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid using undefined variables such as '$context' which will lead to PHP notices.
                        Open

                                    return $context->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_SWAGGER_ERROR, null, __METHOD__, __LINE__);
                        Severity: Minor
                        Found in src/DataType/TypeCommon.php by phpmd

                        UndefinedVariable

                        Since: 2.8.0

                        Detects when a variable is used that has not been defined before.

                        Example

                        class Foo
                        {
                            private function bar()
                            {
                                // $message is undefined
                                echo $message;
                            }
                        }

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

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

                                    throw new \Exception('Result is not a scallar !! ' . print_r($this, true));
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

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

                                else {
                                    return $this->formatModel($context, $this->getExampleType($context));
                                }
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        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/TypeCommon.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

                            public function allowEmptyValue(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused local variables such as '$context'.
                        Open

                                    return $context->setValidationError(\SwaggerValidator\Common\Context::VALIDATION_TYPE_SWAGGER_ERROR, null, __METHOD__, __LINE__);
                        Severity: Minor
                        Found in src/DataType/TypeCommon.php by phpmd

                        UnusedLocalVariable

                        Since: 0.2

                        Detects when a local variable is declared and/or assigned, but not used.

                        Example

                        class Foo {
                            public function doSomething()
                            {
                                $i = 5; // Unused
                            }
                        }

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

                        Avoid unused parameters such as '$context'.
                        Open

                            public function enum(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused parameters such as '$context'.
                        Open

                            public function minimum(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused parameters such as '$context'.
                        Open

                            protected function formatModel(\SwaggerValidator\Common\Context $context, $value)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused parameters such as '$context'.
                        Open

                            public function maxItems(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused parameters such as '$context'.
                        Open

                            public function maxLength(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused parameters such as '$context'.
                        Open

                            public function minLength(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused parameters such as '$context'.
                        Open

                            public function maximum(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused parameters such as '$context'.
                        Open

                            public function uniqueItems(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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

                        Avoid unused parameters such as '$context'.
                        Open

                            public function minItems(\SwaggerValidator\Common\Context $context, $valueParams)
                        Severity: Minor
                        Found in src/DataType/TypeCommon.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/TypeCommon.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