YetiForceCompany/YetiForceCRM

View on GitHub
app/TextParser/TableCurrencySummary.php

Summary

Maintainability
B
6 hrs
Test Coverage
F
0%

Function process has a Cognitive Complexity of 24 (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/TableCurrencySummary.php - About 3 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 process has 60 lines of code (exceeds 25 allowed). Consider refactoring.
Open

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

    Consider simplifying this complex logical expression.
    Open

                if (!empty($currency) && !empty($rate) && $baseCurrency['id'] !== $currency && $inventory->isField('tax') && $inventory->isField('taxmode') && $inventory->isField('currency')) {
                    $html .= '<table class="table-currency-summary" style="border-collapse:collapse;width:100%;border:1px solid #ddd;">
                                    <thead>
                                        <tr>
                                            <th colspan="2" style="padding:0px 4px;text-align:center;">
    Severity: Major
    Found in app/TextParser/TableCurrencySummary.php - About 40 mins to fix

      The method process() has an NPath complexity of 990. The configured NPath complexity threshold is 200.
      Open

          public function process()
          {
              if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {
                  return '';
              }

      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 process() has a Cyclomatic Complexity of 19. The configured cyclomatic complexity threshold is 10.
      Open

          public function process()
          {
              if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {
                  return '';
              }

      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

      Refactor this function to reduce its Cognitive Complexity from 26 to the 15 allowed.
      Open

          public function process()

      Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

      See

      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'];
                  }

      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\Language' in method 'process'.
      Open

                                                  <strong>' . \App\Language::translate('LBL_CURRENCIES_SUMMARY', $this->textParser->moduleName) . '</strong>

      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 {
                      $currencyData = \App\Fields\Currency::getById($currency);
                      $rate = $baseCurrency['conversion_rate'] / $currencyData['conversion_rate'];
                  }

      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\Json' in method 'process'.
      Open

                      $currencyParam = \App\Json::decode($firstRow['currencyparam']);

      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();

      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 '\CurrencyField' in method 'process'.
      Open

                                      <td class="value" style="text-align:right;padding:0px 4px;">' . \CurrencyField::convertToUserFormatSymbol($currencyAmount * $rate, true, $baseCurrency['currency_symbol']) . ' </td>

      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 '\CurrencyField' in method 'process'.
      Open

                                          <td class="value" style="text-align:right;padding:0px 4px;">' . \CurrencyField::convertToUserFormatSymbol($tax * $rate, true, $baseCurrency['currency_symbol']) . ' </td>

      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

                      $currencyData = \App\Fields\Currency::getById($currency);

      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\Language' in method 'process'.
      Open

                                      <td class="name" style="padding:0px 4px;font-weight:bold;">' . \App\Language::translate('LBL_AMOUNT', $this->textParser->moduleName) . '</td>

      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);

      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" 4 times.
      Open

              if ($inventory->isField('currency')) {

      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 moduleName from undeclared class \App\TextParser
      Open

                                                  <strong>' . \App\Language::translate('LBL_CURRENCIES_SUMMARY', $this->textParser->moduleName) . '</strong>

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

              $inventory = \Vtiger_Inventory_Model::getInstance($this->textParser->moduleName);

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

              if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {

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

                                      <td class="name" style="padding:0px 4px;font-weight:bold;">' . \App\Language::translate('LBL_AMOUNT', $this->textParser->moduleName) . '</td>

      Call to undeclared method \Vtiger_Basic_InventoryField::getTaxParam
      Open

                          $taxes = $taxField->getTaxParam($inventoryRow['taxparam'], $inventoryRow['net'], $taxes);
      Severity: Critical
      Found in app/TextParser/TableCurrencySummary.php by phan

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

              $inventoryRows = $this->textParser->recordModel->getInventoryData();

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

          public function process()

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

                  }

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

              if (!empty($fields[0])) {

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

                      foreach ($inventoryRows as $key => $inventoryRow) {

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

                      }

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

                          $html .= '<tr>

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

                  if (isset($firstRow['currencyparam'])) {

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

                      }

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

          /** @var string Class name */

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

          public $type = 'pdf';

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

                      if (isset($currencyParam[$currency])) {

      Line exceeds 120 characters; contains 212 characters
      Open

                                      <td class="value" style="text-align:right;padding:0px 4px;">' . \CurrencyField::convertToUserFormatSymbol($currencyAmount * $rate, true, $baseCurrency['currency_symbol']) . ' </td>

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

          /** @var mixed Parser type */

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

                      $currency = $firstRow['currency'];

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

              }

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

                          $rate = $currencyParam[$currency]['value'] ?? 0;

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

                      $currencyData = \App\Fields\Currency::getById($currency);

      Line exceeds 120 characters; contains 131 characters
      Open

                      $html .= '<table class="table-currency-summary" style="border-collapse:collapse;width:100%;border:1px solid #ddd;">

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

                      $html .= '<tr class="summary">

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

           * @return string

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

              if (!$this->textParser->recordModel || !$this->textParser->recordModel->getModule()->isInventory()) {

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

                      $currencyAmount = 0;

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

           * Process.

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

              $html = '';

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

              }

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

              $inventory = \Vtiger_Inventory_Model::getInstance($this->textParser->moduleName);

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

                      $taxField = $inventory->getField('tax');

      Line exceeds 120 characters; contains 189 characters
      Open

                  if (!empty($currency) && !empty($rate) && $baseCurrency['id'] !== $currency && $inventory->isField('tax') && $inventory->isField('taxmode') && $inventory->isField('currency')) {

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

                  } else {

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

                      $rate = $baseCurrency['conversion_rate'] / $currencyData['conversion_rate'];

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

                  }

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

          /**

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

                  if (!empty($firstRow) && null !== $firstRow['currency']) {

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

                      $currencyParam = \App\Json::decode($firstRow['currencyparam']);

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

                  } else {

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

                  $taxes = [];

      Line exceeds 120 characters; contains 150 characters
      Open

                                                  <strong>' . \App\Language::translate('LBL_CURRENCIES_SUMMARY', $this->textParser->moduleName) . '</strong>

      Line exceeds 120 characters; contains 205 characters
      Open

                                          <td class="value" style="text-align:right;padding:0px 4px;">' . \CurrencyField::convertToUserFormatSymbol($tax * $rate, true, $baseCurrency['currency_symbol']) . ' </td>

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

          public $name = 'LBL_TABLE_CURRENCY_SUMMARY';

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

              $baseCurrency = \Vtiger_Util_Helper::getBaseCurrency();

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

                  if ($inventory->isField('tax') && $inventory->isField('net')) {

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

              $firstRow = current($inventoryRows);

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

                      $currency = $baseCurrency['id'];

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

                      $html .= '<table class="table-currency-summary" style="border-collapse:collapse;width:100%;border:1px solid #ddd;">

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

                      foreach ($taxes as $key => &$tax) {

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

           *

      Line exceeds 120 characters; contains 173 characters
      Open

                                      <td class="name" style="padding:0px 4px;font-weight:bold;">' . \App\Language::translate('LBL_AMOUNT', $this->textParser->moduleName) . '</td>

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

          }

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

          {

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

              if ($inventory->isField('currency')) {

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

                  }

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

              }

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

              return $html;

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

              $fields = $inventory->getFieldsByBlocks();

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

              $inventoryRows = $this->textParser->recordModel->getInventoryData();

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

                          $taxes = $taxField->getTaxParam($inventoryRow['taxparam'], $inventoryRow['net'], $taxes);

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

                  if (!empty($currency) && !empty($rate) && $baseCurrency['id'] !== $currency && $inventory->isField('tax') && $inventory->isField('taxmode') && $inventory->isField('currency')) {

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

                  }

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

           */

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

                  return '';

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

                          $currencyAmount += $tax;

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

                      }

      There are no issues that match your filters.

      Category
      Status