Sign upLogin

lovata/oc-toolbox-plugin

View on GitHub
Star
models/CommonProperty.php

Summary

Maintainability
C
1 day
Test Coverage

File CommonProperty.php has 316 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php namespace Lovata\Toolbox\Models;

use Lang;
use Backend\Models\ImportModel;
use October\Rain\Database\Traits\Validation;
Severity: Minor
Found in models/CommonProperty.php - About 3 hrs to fix

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

    class CommonProperty extends ImportModel
{
    const NAME = 'property';

    use Validation;
    Severity: Minor
    Found in models/CommonProperty.php by phpmd

    CommonProperty has 22 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class CommonProperty extends ImportModel
{
    const NAME = 'property';

    use Validation;
    Severity: Minor
    Found in models/CommonProperty.php - About 2 hrs to fix

      Function getWidgetData has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

          public function getWidgetData()
    {
        $arResult = [];

        switch ($this->type) {
      Severity: Minor
      Found in models/CommonProperty.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 getWidgetData has 52 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function getWidgetData()
    {
        $arResult = [];

        switch ($this->type) {
      Severity: Major
      Found in models/CommonProperty.php - About 2 hrs to fix

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

            public function getPropertyVariants()
    {
        $arValueList = [];

        //Get and check settings array
        Severity: Minor
        Found in models/CommonProperty.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

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

            public function getWidgetData()
    {
        $arResult = [];

        switch ($this->type) {
        Severity: Minor
        Found in models/CommonProperty.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

        Class "CommonProperty" has 22 methods, which is greater than 20 authorized. Split it into smaller classes.
        Open

        class CommonProperty extends ImportModel
        Severity: Major
        Found in models/CommonProperty.php by sonar-php

        A class that grows too much tends to aggregate too many responsibilities and inevitably becomes harder to understand and therefore to maintain. Above a specific threshold, it is strongly advised to refactor the class into smaller ones which focus on well defined topics.

        Avoid unused parameters such as '$arElementList'.
        Open

            public function importData($arElementList, $sSessionKey = null)
        Severity: Minor
        Found in models/CommonProperty.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 '$sSessionKey'.
        Open

            public function importData($arElementList, $sSessionKey = null)
        Severity: Minor
        Found in models/CommonProperty.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

        Define a constant instead of duplicating this literal "value" 4 times.
        Open

                    if (!isset($arValue['value']) || empty($arValue['value'])) {
        Severity: Critical
        Found in models/CommonProperty.php by sonar-php

        Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

        On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

        Noncompliant Code Example

        With the default threshold of 3:

        function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

        Compliant Solution

        ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

        Exceptions

        To prevent generating some false-positives, literals having less than 5 characters are excluded.

        Define a constant instead of duplicating this literal "options" 5 times.
        Open

                    'options' => $arValueList,
        Severity: Critical
        Found in models/CommonProperty.php by sonar-php

        Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

        On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

        Noncompliant Code Example

        With the default threshold of 3:

        function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

        Compliant Solution

        ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

        Exceptions

        To prevent generating some false-positives, literals having less than 5 characters are excluded.

        There are no issues that match your filters.

        Category
        Status