fisharebest/webtrees

View on GitHub
app/Module/SiteMapModule.php

Summary

Maintainability
C
1 day
Test Coverage

File SiteMapModule.php has 310 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2022 webtrees development team
Severity: Minor
Found in app/Module/SiteMapModule.php - About 3 hrs to fix

    Method siteMapIndex has 71 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function siteMapIndex(/** @scrutinizer ignore-unused */ ServerRequestInterface $request): ResponseInterface
        {
            $content = Registry::cache()->file()->remember('sitemap.xml', function (): string {
                // Which trees have sitemaps enabled?
                $tree_ids = $this->tree_service->all()->filter(static function (Tree $tree): bool {
    Severity: Major
    Found in app/Module/SiteMapModule.php - About 2 hrs to fix

      Method sitemapRecords has 29 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function sitemapRecords(Tree $tree, string $type, int $limit, int $offset): Collection
          {
              switch ($type) {
                  case Family::RECORD_TYPE:
                      $records = $this->sitemapFamilies($tree, $limit, $offset);
      Severity: Minor
      Found in app/Module/SiteMapModule.php - About 1 hr to fix

        Function sitemapRecords has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            private function sitemapRecords(Tree $tree, string $type, int $limit, int $offset): Collection
            {
                switch ($type) {
                    case Family::RECORD_TYPE:
                        $records = $this->sitemapFamilies($tree, $limit, $offset);
        Severity: Minor
        Found in app/Module/SiteMapModule.php - About 45 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

        Similar blocks of code found in 3 locations. Consider refactoring.
        Open

            private function sitemapNotes(Tree $tree, int $limit, int $offset): Collection
            {
                return DB::table('other')
                    ->where('o_file', '=', $tree->id())
                    ->where('o_type', '=', Note::RECORD_TYPE)
        Severity: Major
        Found in app/Module/SiteMapModule.php and 2 other locations - About 55 mins to fix
        app/Module/SiteMapModule.php on lines 456..466
        app/Module/SiteMapModule.php on lines 493..503

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

        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

        Similar blocks of code found in 3 locations. Consider refactoring.
        Open

            private function sitemapRepositories(Tree $tree, int $limit, int $offset): Collection
            {
                return DB::table('other')
                    ->where('o_file', '=', $tree->id())
                    ->where('o_type', '=', Repository::RECORD_TYPE)
        Severity: Major
        Found in app/Module/SiteMapModule.php and 2 other locations - About 55 mins to fix
        app/Module/SiteMapModule.php on lines 437..447
        app/Module/SiteMapModule.php on lines 493..503

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

        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

        Similar blocks of code found in 3 locations. Consider refactoring.
        Open

            private function sitemapSubmitters(Tree $tree, int $limit, int $offset): Collection
            {
                return DB::table('other')
                    ->where('o_file', '=', $tree->id())
                    ->where('o_type', '=', Submitter::RECORD_TYPE)
        Severity: Major
        Found in app/Module/SiteMapModule.php and 2 other locations - About 55 mins to fix
        app/Module/SiteMapModule.php on lines 437..447
        app/Module/SiteMapModule.php on lines 456..466

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

        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

        Similar blocks of code found in 3 locations. Consider refactoring.
        Open

                    $count_notes = DB::table('other')
                        ->join('gedcom', 'o_file', '=', 'gedcom_id')
                        ->whereIn('gedcom_id', $tree_ids)
                        ->where('o_type', '=', Note::RECORD_TYPE)
                        ->groupBy(['gedcom_id'])
        Severity: Minor
        Found in app/Module/SiteMapModule.php and 2 other locations - About 35 mins to fix
        app/Module/SiteMapModule.php on lines 244..250
        app/Module/SiteMapModule.php on lines 259..265

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

        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

        Similar blocks of code found in 3 locations. Consider refactoring.
        Open

                    $count_repositories = DB::table('other')
                        ->join('gedcom', 'o_file', '=', 'gedcom_id')
                        ->whereIn('gedcom_id', $tree_ids)
                        ->where('o_type', '=', Repository::RECORD_TYPE)
                        ->groupBy(['gedcom_id'])
        Severity: Minor
        Found in app/Module/SiteMapModule.php and 2 other locations - About 35 mins to fix
        app/Module/SiteMapModule.php on lines 236..242
        app/Module/SiteMapModule.php on lines 259..265

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

        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

        Similar blocks of code found in 3 locations. Consider refactoring.
        Open

                    $count_submitters = DB::table('other')
                        ->join('gedcom', 'o_file', '=', 'gedcom_id')
                        ->whereIn('gedcom_id', $tree_ids)
                        ->where('o_type', '=', Submitter::RECORD_TYPE)
                        ->groupBy(['gedcom_id'])
        Severity: Minor
        Found in app/Module/SiteMapModule.php and 2 other locations - About 35 mins to fix
        app/Module/SiteMapModule.php on lines 236..242
        app/Module/SiteMapModule.php on lines 244..250

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

        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

        There are no issues that match your filters.

        Category
        Status