IndividualFactsTabModule::description() - Code Metrics - Inspection of "Fix: #4417 - bad regex in Fact::attribute()" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( aab1cd...10d6d9 )

by Greg

created 2022-05-21 15:02 UTC

IndividualFactsTabModule::description() A

↳ Parent: IndividualFactsTabModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2022 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Module;

use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Date;
use Fisharebest\Webtrees\Elements\CustomElement;
use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\Family;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Services\ClipboardService;
use Fisharebest\Webtrees\Services\IndividualFactsService;
use Fisharebest\Webtrees\Services\LinkedRecordService;
use Fisharebest\Webtrees\Services\ModuleService;
use Illuminate\Support\Collection;

use function explode;
use function preg_match;
use function preg_replace;
use function str_contains;
use function str_replace;
use function view;

/**
 * Class IndividualFactsTabModule
 */
class IndividualFactsTabModule extends AbstractModule implements ModuleTabInterface
{
    use ModuleTabTrait;

    private ClipboardService $clipboard_service;

    private LinkedRecordService $linked_record_service;

    private ModuleService $module_service;

    /**
     * @param ClipboardService       $clipboard_service
     * @param IndividualFactsService $individual_facts_service
     * @param LinkedRecordService    $linked_record_service
     * @param ModuleService          $module_service
     */
    public function __construct(
        ClipboardService $clipboard_service,
        IndividualFactsService $individual_facts_service,
        LinkedRecordService $linked_record_service,
        ModuleService $module_service
    ) {
        $this->clipboard_service        = $clipboard_service;
        $this->individual_facts_service = $individual_facts_service;

        $this->linked_record_service    = $linked_record_service;
        $this->module_service           = $module_service;
    }

    /**
     * How should this module be identified in the control panel, etc.?
     *
     * @return string
     */
    public function title(): string
    {
        /* I18N: Name of a module/tab on the individual page. */
        return I18N::translate('Facts and events');
    }

    /**
     * A sentence describing what this module does.
     *
     * @return string
     */
    public function description(): string
    {
        /* I18N: Description of the “Facts and events” module */
        return I18N::translate('A tab showing the facts and events of an individual.');
    }

    /**
     * The default position for this tab.  It can be changed in the control panel.
     *
     * @return int
     */
    public function defaultTabOrder(): int
    {
        return 1;
    }

    /**
     * A greyed out tab has no actual content, but may perhaps have
     * options to create content.
     *
     * @param Individual $individual
     *
     * @return bool
     */
    public function isGrayedOut(Individual $individual): bool
    {
        return false;
    }

    /**
     * Generate the HTML content of this tab.
     *
     * @param Individual $individual
     *
     * @return string
     */
    public function getTabContent(Individual $individual): string
    {
        // Which facts and events are handled by other modules?
        $sidebar_facts = $this->module_service
            ->findByComponent(ModuleSidebarInterface::class, $individual->tree(), Auth::user())
            ->map(fn (ModuleSidebarInterface $sidebar): Collection => $sidebar->supportedFacts())
            ->flatten();

        $tab_facts = $this->module_service
            ->findByComponent(ModuleTabInterface::class, $individual->tree(), Auth::user())
            ->map(fn (ModuleTabInterface $tab): Collection => $tab->supportedFacts())
            ->flatten();

        $indi_exclude_facts = $sidebar_facts->merge($tab_facts);
        $fam_exclude_facts  = new Collection(['FAM:CHAN', 'FAM:_UID']);

        $individual_facts = $this->individual_facts_service->individualFacts($individual, $indi_exclude_facts);
        $family_facts     = $this->individual_facts_service->familyFacts($individual, $fam_exclude_facts);
        $relative_facts   = $this->individual_facts_service->relativeFacts($individual);
        $associate_facts  = $this->individual_facts_service->associateFacts($individual);
        $historic_facts   = $this->individual_facts_service->historicFacts($individual);

        $individual_facts = $individual_facts
            ->merge($family_facts)
            ->merge($relative_facts)
            ->merge($associate_facts)
            ->merge($historic_facts);

        $individual_facts = Fact::sortFacts($individual_facts);

        // Facts of relatives take the form 1 EVEN / 2 TYPE Event of Individual
        // Ensure custom tags from there are recognised
        Registry::elementFactory()->registerTags(['INDI:EVEN:CEME' => new CustomElement('Cemetery')]);

        return view('modules/personal_facts/tab', [
            'can_edit'            => $individual->canEdit(),
            'clipboard_facts'     => $this->clipboard_service->pastableFacts($individual),
            'has_associate_facts' => $associate_facts->isNotEmpty(),
            'has_historic_facts'  => $historic_facts->isNotEmpty(),
            'has_relative_facts'  => $relative_facts->isNotEmpty(),
            'individual'          => $individual,
            'facts'               => $individual_facts,
        ]);
    }

    /**
     * Is this tab empty? If so, we don't always need to display it.
     *
     * @param Individual $individual
     *
     * @return bool
     */
    public function hasTabContent(Individual $individual): bool
    {
        return true;
    }

    /**
     * Can this tab load asynchronously?
     *
     * @return bool
     */
    public function canLoadAjax(): bool
    {
        return false;
    }

    /**
     * This module handles the following facts - so don't show them on the "Facts and events" tab.
     *
     * @return Collection<int,string>
     */
    public function supportedFacts(): Collection
    {
        // We don't actually displaye these facts, but they are displayed
        // outside the tabs/sidebar systems. This just forces them to be excluded here.
        return new Collection(['INDI:NAME', 'INDI:SEX', 'INDI:OBJE']);
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2022 webtrees development team
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			* You should have received a copy of the GNU General Public License
15			* along with this program. If not, see <https://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Module;
21
22			use Fisharebest\Webtrees\Auth;
23			use Fisharebest\Webtrees\Date;
24			use Fisharebest\Webtrees\Elements\CustomElement;
25			use Fisharebest\Webtrees\Fact;
26			use Fisharebest\Webtrees\Family;
27			use Fisharebest\Webtrees\I18N;
28			use Fisharebest\Webtrees\Individual;
29			use Fisharebest\Webtrees\Registry;
30			use Fisharebest\Webtrees\Services\ClipboardService;
31			use Fisharebest\Webtrees\Services\IndividualFactsService;
32			use Fisharebest\Webtrees\Services\LinkedRecordService;
33			use Fisharebest\Webtrees\Services\ModuleService;
34			use Illuminate\Support\Collection;
35
36			use function explode;
37			use function preg_match;
38			use function preg_replace;
39			use function str_contains;
40			use function str_replace;
41			use function view;
42
43			/**
44			* Class IndividualFactsTabModule
45			*/
46			class IndividualFactsTabModule extends AbstractModule implements ModuleTabInterface
47			{
48			use ModuleTabTrait;
49
50			private ClipboardService $clipboard_service;
51
52			private LinkedRecordService $linked_record_service;
53
54			private ModuleService $module_service;
55
56			/**
57			* @param ClipboardService $clipboard_service
58			* @param IndividualFactsService $individual_facts_service
59			* @param LinkedRecordService $linked_record_service
60			* @param ModuleService $module_service
61			*/
62			public function __construct(
63			ClipboardService $clipboard_service,
64			IndividualFactsService $individual_facts_service,
65			LinkedRecordService $linked_record_service,
66			ModuleService $module_service
67			) {
68			$this->clipboard_service = $clipboard_service;
69			$this->individual_facts_service = $individual_facts_service;
			0 ignored issues – show Bug Best Practice introduced 2022-05-21 15:08 UTC by Report Bug Copy Issue Report The property `individual_facts_service` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
70			$this->linked_record_service = $linked_record_service;
71			$this->module_service = $module_service;
72			}
73
74			/**
75			* How should this module be identified in the control panel, etc.?
76			*
77			* @return string
78			*/
79			public function title(): string
80			{
81			/* I18N: Name of a module/tab on the individual page. */
82			return I18N::translate('Facts and events');
83			}
84
85			/**
86			* A sentence describing what this module does.
87			*
88			* @return string
89			*/
90			public function description(): string
91			{
92			/* I18N: Description of the “Facts and events” module */
93			return I18N::translate('A tab showing the facts and events of an individual.');
94			}
95
96			/**
97			* The default position for this tab. It can be changed in the control panel.
98			*
99			* @return int
100			*/
101			public function defaultTabOrder(): int
102			{
103			return 1;
104			}
105
106			/**
107			* A greyed out tab has no actual content, but may perhaps have
108			* options to create content.
109			*
110			* @param Individual $individual
111			*
112			* @return bool
113			*/
114			public function isGrayedOut(Individual $individual): bool
115			{
116			return false;
117			}
118
119			/**
120			* Generate the HTML content of this tab.
121			*
122			* @param Individual $individual
123			*
124			* @return string
125			*/
126			public function getTabContent(Individual $individual): string
127			{
128			// Which facts and events are handled by other modules?
129			$sidebar_facts = $this->module_service
130			->findByComponent(ModuleSidebarInterface::class, $individual->tree(), Auth::user())
131			->map(fn (ModuleSidebarInterface $sidebar): Collection => $sidebar->supportedFacts())
132			->flatten();
133
134			$tab_facts = $this->module_service
135			->findByComponent(ModuleTabInterface::class, $individual->tree(), Auth::user())
136			->map(fn (ModuleTabInterface $tab): Collection => $tab->supportedFacts())
137			->flatten();
138
139			$indi_exclude_facts = $sidebar_facts->merge($tab_facts);
140			$fam_exclude_facts = new Collection(['FAM:CHAN', 'FAM:_UID']);
141
142			$individual_facts = $this->individual_facts_service->individualFacts($individual, $indi_exclude_facts);
143			$family_facts = $this->individual_facts_service->familyFacts($individual, $fam_exclude_facts);
144			$relative_facts = $this->individual_facts_service->relativeFacts($individual);
145			$associate_facts = $this->individual_facts_service->associateFacts($individual);
146			$historic_facts = $this->individual_facts_service->historicFacts($individual);
147
148			$individual_facts = $individual_facts
149			->merge($family_facts)
150			->merge($relative_facts)
151			->merge($associate_facts)
152			->merge($historic_facts);
153
154			$individual_facts = Fact::sortFacts($individual_facts);
155
156			// Facts of relatives take the form 1 EVEN / 2 TYPE Event of Individual
157			// Ensure custom tags from there are recognised
158			Registry::elementFactory()->registerTags(['INDI:EVEN:CEME' => new CustomElement('Cemetery')]);
159
160			return view('modules/personal_facts/tab', [
161			'can_edit' => $individual->canEdit(),
162			'clipboard_facts' => $this->clipboard_service->pastableFacts($individual),
163			'has_associate_facts' => $associate_facts->isNotEmpty(),
164			'has_historic_facts' => $historic_facts->isNotEmpty(),
165			'has_relative_facts' => $relative_facts->isNotEmpty(),
166			'individual' => $individual,
167			'facts' => $individual_facts,
168			]);
169			}
170
171			/**
172			* Is this tab empty? If so, we don't always need to display it.
173			*
174			* @param Individual $individual
175			*
176			* @return bool
177			*/
178			public function hasTabContent(Individual $individual): bool
179			{
180			return true;
181			}
182
183			/**
184			* Can this tab load asynchronously?
185			*
186			* @return bool
187			*/
188			public function canLoadAjax(): bool
189			{
190			return false;
191			}
192
193			/**
194			* This module handles the following facts - so don't show them on the "Facts and events" tab.
195			*
196			* @return Collection<int,string>
197			*/
198			public function supportedFacts(): Collection
199			{
200			// We don't actually displaye these facts, but they are displayed
201			// outside the tabs/sidebar systems. This just forces them to be excluded here.
202			return new Collection(['INDI:NAME', 'INDI:SEX', 'INDI:OBJE']);
203			}
204			}
205

fisharebest / webtrees

Push — main ( aab1cd...10d6d9 )

IndividualFactsTabModule::description() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like