Sign upLogin

phpbb-extensions/boardrules

View on GitHub
Star
entity/rule.php

Summary

Maintainability
C
1 day
Test Coverage

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

class rule implements rule_interface
{
    /**
    * Data for this entity
    *
Severity: Minor
Found in entity/rule.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

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

class rule implements rule_interface
{
    /**
    * Data for this entity
    *
Severity: Minor
Found in entity/rule.php by phpmd

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

class rule implements rule_interface
{
    /**
    * Data for this entity
    *
Severity: Minor
Found in entity/rule.php - About 3 hrs to fix

    File rule.php has 280 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
/**
*
* Board Rules extension for the phpBB Forum Software package.
*
    Severity: Minor
    Found in entity/rule.php - About 2 hrs to fix

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

          public function import($data)
    {
        // Clear out any saved data
        $this->data = array();
      Severity: Minor
      Found in entity/rule.php - About 1 hr to fix

        Method set_anchor has 26 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function set_anchor($anchor)
    {
        // Enforce a string
        $anchor = (string) $anchor;
        Severity: Minor
        Found in entity/rule.php - About 1 hr to fix

          Function import has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              public function import($data)
    {
        // Clear out any saved data
        $this->data = array();
          Severity: Minor
          Found in entity/rule.php - About 55 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

          Function set_anchor has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              public function set_anchor($anchor)
    {
        // Enforce a string
        $anchor = (string) $anchor;
          Severity: Minor
          Found in entity/rule.php - About 55 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

          Function set_language has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              public function set_language($language)
    {
        if (!isset($this->data['rule_language']))
        {
            // Validate the requested language ISO is installed
          Severity: Minor
          Found in entity/rule.php - About 25 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

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

              public function set_anchor($anchor)
    {
        // Enforce a string
        $anchor = (string) $anchor;
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '129', column '15').
          Open

                          throw new \phpbb\boardrules\exception\invalid_argument(array($field, 'FIELD_MISSING'));
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '185', column '14').
          Open

                      throw new \phpbb\boardrules\exception\out_of_bounds('rule_id');
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '279', column '14').
          Open

                      throw new \phpbb\boardrules\exception\unexpected_value(array('title', 'TOO_LONG'));
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '492', column '14').
          Open

                      throw new \phpbb\boardrules\exception\unexpected_value(array('anchor', 'TOO_LONG'));
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '163', column '15').
          Open

                          throw new \phpbb\boardrules\exception\out_of_bounds($field);
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '81', column '14').
          Open

                      throw new \phpbb\boardrules\exception\out_of_bounds('rule_id');
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '486', column '14').
          Open

                      throw new \phpbb\boardrules\exception\unexpected_value(array('anchor', 'ILLEGAL_CHARACTERS'));
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '511', column '15').
          Open

                          throw new \phpbb\boardrules\exception\unexpected_value(array('anchor', 'NOT_UNIQUE'));
          Severity: Minor
          Found in entity/rule.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 set_message_option has a boolean flag argument $reparse_message, which is a certain sign of a Single Responsibility Principle violation.
          Open

              protected function set_message_option($option_value, $negate = false, $reparse_message = true)
          Severity: Minor
          Found in entity/rule.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 get_message_for_display has a boolean flag argument $censor_text, which is a certain sign of a Single Responsibility Principle violation.
          Open

              public function get_message_for_display($censor_text = true)
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '225', column '14').
          Open

                      throw new \phpbb\boardrules\exception\out_of_bounds('rule_id');
          Severity: Minor
          Found in entity/rule.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 set_message_option has a boolean flag argument $negate, which is a certain sign of a Single Responsibility Principle violation.
          Open

              protected function set_message_option($option_value, $negate = false, $reparse_message = true)
          Severity: Minor
          Found in entity/rule.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

          Missing class import via use statement (line '556', column '16').
          Open

                              throw new \phpbb\boardrules\exception\unexpected_value(array('rule_language', 'WRONG_DATA_LANG', 'UNEXPECTED_VALUE'));
          Severity: Minor
          Found in entity/rule.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 import uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
          Open

                      {
                // settype passes values by reference
                $value = $data[$field];

                // We're using settype to enforce data types
          Severity: Minor
          Found in entity/rule.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

          There are no issues that match your filters.

          Category
          Status