Sign upLogin

YetiForceCompany/YetiForceCRM

View on GitHub
Star
modules/OpenStreetMap/handlers/OpenStreetMapHandler.php

Summary

Maintainability
B
5 hrs
Test Coverage
B
84%

Function entityAfterSave has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
Open

    public function entityAfterSave(App\EventHandler $eventHandler): void
    {
        $typeAddressToUpdate = [];
        $recordModel = $eventHandler->getRecordModel();
        if (!$recordModel->isNew()) {
Severity: Minor
Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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 entityAfterSave has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function entityAfterSave(App\EventHandler $eventHandler): void
    {
        $typeAddressToUpdate = [];
        $recordModel = $eventHandler->getRecordModel();
        if (!$recordModel->isNew()) {
Severity: Minor
Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php - About 1 hr to fix

    Consider simplifying this complex logical expression.
    Open

                if ((!$recordModel->isEmpty('addresslevel5' . $typeAddress) || !$recordModel->isEmpty('addresslevel4' . $typeAddress) || !$recordModel->isEmpty('addresslevel3' . $typeAddress) || !$recordModel->isEmpty('addresslevel2' . $typeAddress)) && ($recordModel->isNew() || \in_array($typeAddress, $typeAddressToUpdate))) {
                $isCoordinateExists = (new App\Db\Query())
                    ->from('u_#__openstreetmap_record_updater')
                    ->where(['type' => $typeAddress, 'crmid' => $recordModel->getId()])
                    ->exists();
    Severity: Major
    Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php - About 40 mins to fix

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

          public function entityAfterSave(App\EventHandler $eventHandler): void
    {
        $typeAddressToUpdate = [];
        $recordModel = $eventHandler->getRecordModel();
        if (!$recordModel->isNew()) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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

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

          public function entityAfterSave(App\EventHandler $eventHandler): void
      Severity: Critical
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by sonar-php

      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

      Missing class import via use statement (line '47', column '32').
      Open

                      $isCoordinateExists = (new App\Db\Query())
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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 entityAfterSave uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                      } else {
                    App\Db::getInstance()->createCommand()
                        ->update('u_#__openstreetmap_record_updater', ['address' => \App\Json::encode($address)], ['crmid' => $recordModel->getId(), 'type' => $typeAddress])
                        ->execute();
                }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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\Map\Coordinates' in method 'entityAfterSave'.
      Open

                      $address = \App\Map\Coordinates::getAddressParams($recordModel, $typeAddress);
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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\Json' in method 'entityAfterSave'.
      Open

                              ->update('u_#__openstreetmap_record_updater', ['address' => \App\Json::encode($address)], ['crmid' => $recordModel->getId(), 'type' => $typeAddress])
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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\Json' in method 'entityAfterSave'.
      Open

                                  'address' => \App\Json::encode($address),
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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 "u_#__openstreetmap_record_updater" 3 times.
      Open

                          ->from('u_#__openstreetmap_record_updater')
      Severity: Critical
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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 "crmid" 3 times.
      Open

                          ->where(['type' => $typeAddress, 'crmid' => $recordModel->getId()])
      Severity: Critical
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.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.

      Call to undeclared method \App\Db::createCommand
      Open

                          App\Db::getInstance()->createCommand()
      Severity: Critical
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phan

      Call to undeclared method \App\Db::createCommand
      Open

                          App\Db::getInstance()->createCommand()
      Severity: Critical
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phan

      Call to undeclared method \App\Db\Query::from
      Open

                      $isCoordinateExists = (new App\Db\Query())
      Severity: Critical
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phan

      Avoid excessively long class names like OpenStreetMap_OpenStreetMapHandler_Handler. Keep class name length under 40.
      Open

      class OpenStreetMap_OpenStreetMapHandler_Handler
{
    /** @var string[] Type of address. */
    const FIELDS_ADDRESS_TYPE = ['addresslevel', 'buildingnumber', 'localnumber', 'pobox'];
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpmd

      LongClassName

      Since: 2.9

      Detects when classes or interfaces are declared with excessively long names.

      Example

      class ATooLongClassNameThatHintsAtADesignProblem {

}

interface ATooLongInterfaceNameThatHintsAtADesignProblem {

}

      Source https://phpmd.org/rules/naming.html#longclassname

      Each class must be in a namespace of at least one level (a top-level vendor name)
      Open

      class OpenStreetMap_OpenStreetMapHandler_Handler
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

      The class OpenStreetMap_OpenStreetMapHandler_Handler is not named in CamelCase.
      Open

      class OpenStreetMap_OpenStreetMapHandler_Handler
{
    /** @var string[] Type of address. */
    const FIELDS_ADDRESS_TYPE = ['addresslevel', 'buildingnumber', 'localnumber', 'pobox'];
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpmd

      CamelCaseClassName

      Since: 0.2

      It is considered best practice to use the CamelCase notation to name classes.

      Example

      class class_name {
}

      Source

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

          /** @var string[] Type of address. */
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

           * @param App\EventHandler $eventHandler
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

      Line exceeds 120 characters; contains 325 characters
      Open

                  if ((!$recordModel->isEmpty('addresslevel5' . $typeAddress) || !$recordModel->isEmpty('addresslevel4' . $typeAddress) || !$recordModel->isEmpty('addresslevel3' . $typeAddress) || !$recordModel->isEmpty('addresslevel2' . $typeAddress)) && ($recordModel->isNew() || \in_array($typeAddress, $typeAddressToUpdate))) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                      $isCoordinateExists = (new App\Db\Query())
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                          ->exists();
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                                  'crmid' => $recordModel->getId(),
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

          }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                      $address = \App\Map\Coordinates::getAddressParams($recordModel, $typeAddress);
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                                  'type' => $typeAddress,
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

          /**
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                  $deltaFields = array_keys($recordModel->getPreviousValue());
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                  if ((!$recordModel->isEmpty('addresslevel5' . $typeAddress) || !$recordModel->isEmpty('addresslevel4' . $typeAddress) || !$recordModel->isEmpty('addresslevel3' . $typeAddress) || !$recordModel->isEmpty('addresslevel2' . $typeAddress)) && ($recordModel->isNew() || \in_array($typeAddress, $typeAddressToUpdate))) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

      Line exceeds 120 characters; contains 173 characters
      Open

                              ->update('u_#__openstreetmap_record_updater', ['address' => \App\Json::encode($address)], ['crmid' => $recordModel->getId(), 'type' => $typeAddress])
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                              ->update('u_#__openstreetmap_record_updater', ['address' => \App\Json::encode($address)], ['crmid' => $recordModel->getId(), 'type' => $typeAddress])
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

           * EntityAfterSave handler function.
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

          public function entityAfterSave(App\EventHandler $eventHandler): void
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                  foreach ($deltaFields as &$deltaField) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                      }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                      if ($recordModel->getPreviousValue($deltaField) !== $recordModel->get($deltaField)) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

           * @return void
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                          foreach (self::FIELDS_ADDRESS_TYPE as $field) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                  }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

              }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

              $typeAddressToUpdate = [];
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                                  $typeAddressToUpdate[] = substr($deltaField, -1);
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                  }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                          ->from('u_#__openstreetmap_record_updater')
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                                  'address' => \App\Json::encode($address),
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                      } else {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

           *
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                              ->insert('u_#__openstreetmap_record_updater', [
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

           */
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

              }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                          App\Db::getInstance()->createCommand()
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                              }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                          App\Db::getInstance()->createCommand()
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                              ->execute();
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                      }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

          const FIELDS_ADDRESS_TYPE = ['addresslevel', 'buildingnumber', 'localnumber', 'pobox'];
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                              if (false !== strpos($deltaField, $field)) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

              foreach (\App\Map\Coordinates::TYPE_ADDRESS as $typeAddress) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                          ->where(['type' => $typeAddress, 'crmid' => $recordModel->getId()])
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

          {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

              $recordModel = $eventHandler->getRecordModel();
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                          }
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                      if (!$isCoordinateExists) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

              if (!$recordModel->isNew()) {
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

           *
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

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

                              ])->execute();
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

      Class name "OpenStreetMap_OpenStreetMapHandler_Handler" is not in camel caps format
      Open

      class OpenStreetMap_OpenStreetMapHandler_Handler
      Severity: Minor
      Found in modules/OpenStreetMap/handlers/OpenStreetMapHandler.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status