iranianpep/code-jetter

View on GitHub
components/geolocation/mappers/StateMapper.php

Summary

Maintainability
B
4 hrs
Test Coverage

Method getStatesCities has 47 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getStatesCities(
        array $criteria = [],
        $fromColumns = null,
        $order = null,
        $start = 0,
Severity: Minor
Found in components/geolocation/mappers/StateMapper.php - About 1 hr to fix

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

        public function getStatesCitiesGroupedByStates(
            array $criteria = [],
            $order = null,
            $start = 0,
            $limit = 0,
    Severity: Minor
    Found in components/geolocation/mappers/StateMapper.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 getStatesCities has 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

            array $criteria = [],
            $fromColumns = null,
            $order = null,
            $start = 0,
            $limit = 0,
    Severity: Major
    Found in components/geolocation/mappers/StateMapper.php - About 50 mins to fix

      Method getStatesCitiesGroupedByStates has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

              array $criteria = [],
              $order = null,
              $start = 0,
              $limit = 0,
              $excludeArchived = true
      Severity: Minor
      Found in components/geolocation/mappers/StateMapper.php - About 35 mins to fix

        The method getStatesCities has a boolean flag argument $returnTotalNo, which is a certain sign of a Single Responsibility Principle violation.
        Open

                $returnTotalNo = false,

        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

        The method getStatesCities has a boolean flag argument $excludeArchived, which is a certain sign of a Single Responsibility Principle violation.
        Open

                $excludeArchived = true

        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

        The method getStatesCitiesGroupedByStates has a boolean flag argument $excludeArchived, which is a certain sign of a Single Responsibility Principle violation.
        Open

                $excludeArchived = true

        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

        Missing class import via use statement (line '95', column '18').
        Open

                    (new \CodeJetter\core\ErrorHandler())->logError($e);

        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 getStatesCities uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
        Open

                    } else {
                        return $mappedObjects;
                    }

        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 '$definedInputs'.
        Open

            public function getFieldsValues(array $inputs, array $definedInputs = [], $action = null)

        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 '$inputs'.
        Open

            public function add(array $inputs, array $fieldsValues = [], $extraDefinedInputs = [])

        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 '$action'.
        Open

            public function getDefinedInputs($action = null, array $includingInputs = [], array $excludingInputs = [])

        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 '$extraDefinedInputs'.
        Open

            public function add(array $inputs, array $fieldsValues = [], $extraDefinedInputs = [])

        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 '$excludingInputs'.
        Open

            public function getDefinedInputs($action = null, array $includingInputs = [], array $excludingInputs = [])

        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 '$action'.
        Open

            public function getFieldsValues(array $inputs, array $definedInputs = [], $action = null)

        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 '$inputs'.
        Open

            public function getFieldsValues(array $inputs, array $definedInputs = [], $action = null)

        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 '$includingInputs'.
        Open

            public function getDefinedInputs($action = null, array $includingInputs = [], array $excludingInputs = [])

        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 '$fieldsValues'.
        Open

            public function add(array $inputs, array $fieldsValues = [], $extraDefinedInputs = [])

        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

        There are no issues that match your filters.

        Category
        Status