Dhii/args-list-validation

View on GitHub
src/GetArgsListErrorsCapableTrait.php

Summary

Maintainability
A
3 hrs
Test Coverage

Function _getArgsListErrors has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    protected function _getArgsListErrors($args, $spec)
    {
        $errors = [];

        foreach ($spec as $_idx => $_param) {
Severity: Minor
Found in src/GetArgsListErrorsCapableTrait.php - About 2 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 _getArgsListErrors has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function _getArgsListErrors($args, $spec)
    {
        $errors = [];

        foreach ($spec as $_idx => $_param) {
Severity: Minor
Found in src/GetArgsListErrorsCapableTrait.php - About 1 hr to fix

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

        protected function _getArgsListErrors($args, $spec)
        {
            $errors = [];
    
            foreach ($spec as $_idx => $_param) {
    Severity: Minor
    Found in src/GetArgsListErrorsCapableTrait.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 short method names like GetArgsListErrorsCapableTrait::__(). The configured minimum method name length is 3.
    Open

        abstract protected function __($string, $args = [], $context = null);
    Severity: Minor
    Found in src/GetArgsListErrorsCapableTrait.php by phpmd

    ShortMethodName

    Since: 0.2

    Detects when very short method names are used.

    Example

    class ShortMethod {
        public function a( $index ) { // Violation
        }
    }

    Source https://phpmd.org/rules/naming.html#shortmethodname

    The method __ is not named in camelCase.
    Open

        abstract protected function __($string, $args = [], $context = null);
    Severity: Minor
    Found in src/GetArgsListErrorsCapableTrait.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