gdbots/common-php

View on GitHub
src/Common/Util/SlugUtils.php

Summary

Maintainability
F
6 days
Test Coverage

Function create has a Cognitive Complexity of 272 (exceeds 5 allowed). Consider refactoring.
Open

    public static function create($string, $allowSlashes = false)
    {
        $slug = '';
        $string = html_entity_decode($string, ENT_QUOTES);

Severity: Minor
Found in src/Common/Util/SlugUtils.php - About 5 days 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 class SlugUtils has an overall complexity of 71 which is very high. The configured complexity threshold is 50.
Open

final class SlugUtils
{
    const VALID_SLUG_PATTERN = '/^[a-z0-9-]+$/';
    const VALID_DATED_SLUG_PATTERN = '/^([a-z0-9-]|[a-z0-9-][a-z0-9-\/]*[a-z0-9-])$/';

Severity: Minor
Found in src/Common/Util/SlugUtils.php by phpmd

Method create has 79 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function create($string, $allowSlashes = false)
    {
        $slug = '';
        $string = html_entity_decode($string, ENT_QUOTES);

Severity: Major
Found in src/Common/Util/SlugUtils.php - About 3 hrs to fix

    Consider simplifying this complex logical expression.
    Open

                } else if (($c >= 8219 && $c <= 8223) || $c == 8242 || $c == 8243 || $c == 8216 || $c == 8217 || $c == 168 || $c == 180 || $c == 729 || $c == 733) {
                    //all the strange curly single and double quotes
                    // Ignore them
                } else if ($c == 188) {
                    $slug .= '-one-quarter-';
    Severity: Critical
    Found in src/Common/Util/SlugUtils.php - About 2 hrs to fix

      Consider simplifying this complex logical expression.
      Open

                  if (($c >= 224 && $c <= 229) || ($c >= 192 && $c <= 198) || ($c >= 281 && $c <= 286)) {
                      $slug .= 'a';
                  } else if (($c >= 232 && $c <= 235) || ($c >= 200 && $c <= 203)) {
                      $slug .= 'e';
                  } else if (($c >= 236 && $c <= 239) || ($c >= 204 && $c <= 207)) {
      Severity: Major
      Found in src/Common/Util/SlugUtils.php - About 40 mins to fix

        The method create() has an NPath complexity of 460. The configured NPath complexity threshold is 200.
        Open

            public static function create($string, $allowSlashes = false)
            {
                $slug = '';
                $string = html_entity_decode($string, ENT_QUOTES);
        
        
        Severity: Minor
        Found in src/Common/Util/SlugUtils.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 create() has a Cyclomatic Complexity of 61. The configured cyclomatic complexity threshold is 10.
        Open

            public static function create($string, $allowSlashes = false)
            {
                $slug = '';
                $string = html_entity_decode($string, ENT_QUOTES);
        
        
        Severity: Minor
        Found in src/Common/Util/SlugUtils.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 isValid has a boolean flag argument $allowSlashes, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function isValid($string, $allowSlashes = false)
        Severity: Minor
        Found in src/Common/Util/SlugUtils.php by phpmd

        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 createFromCamel has a boolean flag argument $allowSlashes, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function createFromCamel($string, $allowSlashes = false)
        Severity: Minor
        Found in src/Common/Util/SlugUtils.php by phpmd

        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 create has a boolean flag argument $allowSlashes, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public static function create($string, $allowSlashes = false)
        Severity: Minor
        Found in src/Common/Util/SlugUtils.php by phpmd

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

                } else {
                    $slug = preg_replace("/[^a-zA-Z0-9\-\/]+/i", '-', $slug);
                }
        Severity: Minor
        Found in src/Common/Util/SlugUtils.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 variables with short names like $m. Configured minimum length is 3.
        Open

                while (preg_match('/^\d{4}\/\d{2}\/\d{2}\/?(\S+)?/', $slug, $m)) {
        Severity: Minor
        Found in src/Common/Util/SlugUtils.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
            private $q = 15; // VIOLATION - Field
            public static function main( array $as ) { // VIOLATION - Formal
                $r = 20 + $this->q; // VIOLATION - Local
                for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                    $r += $this->q;
                }
            }
        }

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

        Avoid variables with short names like $c. Configured minimum length is 3.
        Open

                    $c = ord(substr($string, $i, 1));
        Severity: Minor
        Found in src/Common/Util/SlugUtils.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
            private $q = 15; // VIOLATION - Field
            public static function main( array $as ) { // VIOLATION - Formal
                $r = 20 + $this->q; // VIOLATION - Local
                for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                    $r += $this->q;
                }
            }
        }

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

        Line exceeds 120 characters; contains 160 characters
        Open

                    } else if (($c >= 8219 && $c <= 8223) || $c == 8242 || $c == 8243 || $c == 8216 || $c == 8217 || $c == 168 || $c == 180 || $c == 729 || $c == 733) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 199 || $c == 231 || $c == 162) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 253 || $c == 255 || $c == 221 || $c == 376) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 188) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if (($c >= 249 && $c <= 252) || ($c >= 217 && $c <= 220)) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if (($c >= 236 && $c <= 239) || ($c >= 204 && $c <= 207)) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if (($c >= 232 && $c <= 235) || ($c >= 200 && $c <= 203)) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 223) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if (($c >= 8219 && $c <= 8223) || $c == 8242 || $c == 8243 || $c == 8216 || $c == 8217 || $c == 168 || $c == 180 || $c == 729 || $c == 733) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 190) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 208 || $c == 240) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 209 || $c == 241) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 352 || $c == 353) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if (($c >= 242 && $c <= 248) || ($c >= 210 && $c <= 216)) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 179) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 189) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 178) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 230 || $c == 198) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c == 338 || $c == 339) {

        Usage of ELSE IF is discouraged; use ELSEIF instead
        Open

                    } else if ($c > 127) {

        There are no issues that match your filters.

        Category
        Status