Sign upLogin

YetiForceCompany/YetiForceCRM

View on GitHub
Star
app/TextParser/TableDiscountSummary.php

Summary

Maintainability
B
4 hrs
Test Coverage
F
0%

Function process has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

    public function process()
    {
        if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {
            return '';
        }
Severity: Minor
Found in app/TextParser/TableDiscountSummary.php - About 1 hr 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 process has 40 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function process()
    {
        if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {
            return '';
        }
Severity: Minor
Found in app/TextParser/TableDiscountSummary.php - About 1 hr to fix

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

        public function process()
    {
        if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {
            return '';
        }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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 static access to class '\App\Language' in method 'process'.
    Open

                            <th style="padding:0px 4px;font-weight:bold;background-color:#ddd;">' . \App\Language::translate('LBL_DISCOUNTS_SUMMARY', $this->textParser->moduleName) . '</th>
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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 process uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
            $currencySymbol = \App\Fields\Currency::getDefault()['currency_symbol'];
        }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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 '\CurrencyField' in method 'process'.
    Open

                                <td style="padding:0px 4px;text-align:right;font-weight:bold;border:1px solid #ddd;">' . \CurrencyField::convertToUserFormatSymbol($discount, true, $currencySymbol) . '</td>
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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 '\App\Fields\Currency' in method 'process'.
    Open

    }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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 '\Vtiger_Util_Helper' in method 'process'.
    Open

            $baseCurrency = \Vtiger_Util_Helper::getBaseCurrency();
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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 process uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                $currency = $baseCurrency['id'];
            }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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 '\App\Fields\Currency' in method 'process'.
    Open

    }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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 '\Vtiger_Inventory_Model' in method 'process'.
    Open

            $inventory = \Vtiger_Inventory_Model::getInstance($this->textParser->moduleName);
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.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

    Define a constant instead of duplicating this literal "currency" 3 times.
    Open

            if ($inventory->isField('currency')) {
    Severity: Critical
    Found in app/TextParser/TableDiscountSummary.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.

    Reference to instance property recordModel from undeclared class \App\TextParser
    Open

            $inventoryRows = $this->textParser->recordModel->getInventoryData();
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phan

    Reference to instance property moduleName from undeclared class \App\TextParser
    Open

            $inventory = \Vtiger_Inventory_Model::getInstance($this->textParser->moduleName);
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phan

    Reference to instance property recordModel from undeclared class \App\TextParser
    Open

            if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phan

    Reference to instance property moduleName from undeclared class \App\TextParser
    Open

                            <th style="padding:0px 4px;font-weight:bold;background-color:#ddd;">' . \App\Language::translate('LBL_DISCOUNTS_SUMMARY', $this->textParser->moduleName) . '</th>
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phan

    Identical blocks of code found in 11 locations. Consider refactoring.
    Open

            if ($inventory->isField('currency')) {
            if (!empty($firstRow) && null !== $firstRow['currency']) {
                $currency = $firstRow['currency'];
            } else {
                $currency = $baseCurrency['id'];
    Severity: Major
    Found in app/TextParser/TableDiscountSummary.php and 10 other locations - About 45 mins to fix
    app/TextParser/ProductsTableCorrectingBefore.php on lines 38..47
    app/TextParser/ProductsTableImages.php on lines 37..46
    app/TextParser/ProductsTableLongVTwoLang.php on lines 37..46
    app/TextParser/ProductsTableLongVersion.php on lines 37..46
    app/TextParser/ProductsTableNew.php on lines 37..46
    app/TextParser/ProductsTableShortVersion.php on lines 37..46
    app/TextParser/TableCorrectTaxSummary.php on lines 46..55
    app/TextParser/TableDiscountSTwoLang.php on lines 38..47
    app/TextParser/TableTaxSTwoLang.php on lines 38..47
    app/TextParser/TableTaxSummary.php on lines 38..47

    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 96.

    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

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public $name = 'LBL_TABLE_DISCOUNT_SUMMARY';
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public $type = 'pdf';
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /** @var string Class name */
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /** @var mixed Parser type */
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $baseCurrency = \Vtiger_Util_Helper::getBaseCurrency();
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /**
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public function process()
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            if ($inventory->isField('currency')) {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            if (!empty($fields[0])) {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Line exceeds 120 characters; contains 185 characters
    Open

                            <th style="padding:0px 4px;font-weight:bold;background-color:#ddd;">' . \App\Language::translate('LBL_DISCOUNTS_SUMMARY', $this->textParser->moduleName) . '</th>
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Line exceeds 120 characters; contains 201 characters
    Open

                                <td style="padding:0px 4px;text-align:right;font-weight:bold;border:1px solid #ddd;">' . \CurrencyField::convertToUserFormatSymbol($discount, true, $currencySymbol) . '</td>
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $html = '';
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $currency = $firstRow['currency'];
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if ($inventory->isField('discount') && $inventory->isField('discountmode')) {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $discount += $inventoryRow['discount'];
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $inventoryRows = $this->textParser->recordModel->getInventoryData();
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            return $html;
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * Process.
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Line exceeds 120 characters; contains 150 characters
    Open

                    $html .= '<table class="table-discount-summary" style="width:100%;vertical-align:top;border-collapse:collapse;border:1px solid #ddd;">
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         */
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $fields = $inventory->getFieldsByBlocks();
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if (!empty($firstRow) && null !== $firstRow['currency']) {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $discount = 0;
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $firstRow = current($inventoryRows);
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $currencySymbol = \App\Fields\Currency::getById($currency)['currency_symbol'];
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            } else {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $currencySymbol = \App\Fields\Currency::getDefault()['currency_symbol'];
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                } else {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $currency = $baseCurrency['id'];
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @return string
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                return '';
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $inventory = \Vtiger_Inventory_Model::getInstance($this->textParser->moduleName);
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    foreach ($inventoryRows as $inventoryRow) {
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $html .= '<table class="table-discount-summary" style="width:100%;vertical-align:top;border-collapse:collapse;border:1px solid #ddd;">
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    }
    Severity: Minor
    Found in app/TextParser/TableDiscountSummary.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status