jon48/webtrees-lib

View on GitHub
app/Module/Sosa/Services/SosaRecordsService.php

Summary

Maintainability
A
3 hrs
Test Coverage

The class SosaRecordsService has 11 public methods. Consider refactoring SosaRecordsService to keep number of public methods under 10.
Open

class SosaRecordsService
{
    private ?int $max_system_generations = null;

    /**

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

Method insertOrUpdate has 49 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function insertOrUpdate(Tree $tree, UserInterface $user, array $sosa_records): void
    {
        $mass_update = DB::connection()->getDriverName() === 'mysql';

        $bindings_placeholders = $bindings_values = [];
Severity: Minor
Found in app/Module/Sosa/Services/SosaRecordsService.php - About 1 hr to fix

    Method listMissingAncestorsAtGeneration has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function listMissingAncestorsAtGeneration(Tree $tree, UserInterface $user, int $gen): Collection
        {
            if ($gen === 1) {
                return collect();
            }
    Severity: Minor
    Found in app/Module/Sosa/Services/SosaRecordsService.php - About 1 hr to fix

      Function insertOrUpdate has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

          public function insertOrUpdate(Tree $tree, UserInterface $user, array $sosa_records): void
          {
              $mass_update = DB::connection()->getDriverName() === 'mysql';
      
              $bindings_placeholders = $bindings_values = [];
      Severity: Minor
      Found in app/Module/Sosa/Services/SosaRecordsService.php - About 55 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 insertOrUpdate uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

                      } else {
                          DB::table('maj_sosa')->updateOrInsert(
                              [ 'majs_gedcom_id' => $tree->id(), 'majs_user_id' => $user->id(), 'majs_sosa' => $row['sosa']],
                              [
                                  'majs_i_id' => $row['indi'],

      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 excessively long variable names like $bindings_placeholders. Keep variable name length under 20.
      Open

              $bindings_placeholders = $bindings_values = [];

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

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

      Avoid excessively long variable names like $max_system_generations. Keep variable name length under 20.
      Open

          private ?int $max_system_generations = null;

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

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

      There are no issues that match your filters.

      Category
      Status