kai-jacobsen/kontentblocks

View on GitHub
core/Panels/OptionPanel.php

Summary

Maintainability
C
7 hrs
Test Coverage

The class OptionPanel has 12 public methods. Consider refactoring OptionPanel to keep number of public methods under 10.
Open

abstract class OptionPanel extends AbstractPanel
{

    /**
     * @var SerOptionsDataProvider
Severity: Minor
Found in core/Panels/OptionPanel.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

OptionPanel has 23 functions (exceeds 20 allowed). Consider refactoring.
Open

abstract class OptionPanel extends AbstractPanel
{

    /**
     * @var SerOptionsDataProvider
Severity: Minor
Found in core/Panels/OptionPanel.php - About 2 hrs to fix

    Method setupMenu has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function setupMenu()
        {
            if (!$this->menu) {
                return false;
            }
    Severity: Minor
    Found in core/Panels/OptionPanel.php - About 1 hr to fix

      Function prepareModel has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          public function prepareModel()
          {
              $savedData = $this->model->export();
              if ($this->fields) {
                  $data = array();
      Severity: Minor
      Found in core/Panels/OptionPanel.php - About 35 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 using static access to class '\Kontentblocks\Utils\Utilities' in method 'saveCallback'.
      Open

              $postData = Utilities::getRequest();
      Severity: Minor
      Found in core/Panels/OptionPanel.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

      Avoid using static access to class '\Kontentblocks\Utils\Utilities' in method 'observeSaveRequest'.
      Open

              $postData = Utilities::getRequest();
      Severity: Minor
      Found in core/Panels/OptionPanel.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

      Avoid using static access to class '\Kontentblocks\Utils\Utilities' in method 'save'.
      Open

              $merged = Utilities::arrayMergeRecursive($new, $old);
      Severity: Minor
      Found in core/Panels/OptionPanel.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

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

                      } else {
                          $data[$attrs['key']] = $attrs['std'];
                      }
      Severity: Minor
      Found in core/Panels/OptionPanel.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 using static access to class '\Kontentblocks\Utils\Utilities' in method 'form'.
      Open

              Utilities::hiddenEditor();
      Severity: Minor
      Found in core/Panels/OptionPanel.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

      Avoid unused parameters such as '$objectObject'.
      Open

          public function saveCallback($objectId, $objectObject)
      Severity: Minor
      Found in core/Panels/OptionPanel.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 '$objectId'.
      Open

          public function saveCallback($objectId, $objectObject)
      Severity: Minor
      Found in core/Panels/OptionPanel.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 save() contains an exit expression.
      Open

              exit;
      Severity: Minor
      Found in core/Panels/OptionPanel.php by phpmd

      ExitExpression

      Since: 0.2

      An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

      Example

      class Foo {
          public function bar($param)  {
              if ($param === 42) {
                  exit(23);
              }
          }
      }

      Source https://phpmd.org/rules/design.html#exitexpression

      Similar blocks of code found in 4 locations. Consider refactoring.
      Open

          public function prepareModel()
          {
              $savedData = $this->model->export();
              if ($this->fields) {
                  $data = array();
      Severity: Major
      Found in core/Panels/OptionPanel.php and 3 other locations - About 3 hrs to fix
      core/Modules/Module.php on lines 121..138
      core/Panels/PostPanel.php on lines 146..163
      core/Panels/TermPanel.php on lines 112..129

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 143.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      There are no issues that match your filters.

      Category
      Status