xref: /webtrees/app/Module/NotesTabModule.php (revision ad7270802ba57a28d195fc58fcc55f26458a779a) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Fact;
21use Fisharebest\Webtrees\Functions\Functions;
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Individual;
24use Fisharebest\Webtrees\Services\ClipboardService;
25use Illuminate\Support\Collection;
26
27/**
28 * Class NotesTabModule
29 */
30class NotesTabModule extends AbstractModule implements ModuleTabInterface
31{
32    use ModuleTabTrait;
33
34    /** @var Fact[] A list facts for this note. */
35    private $facts;
36
37    /** @var ClipboardService */
38    private $clipboard_service;
39
40    /**
41     * NotesTabModule constructor.
42     *
43     * @param ClipboardService $clipboard_service
44     */
45    public function __construct(ClipboardService $clipboard_service)
46    {
47        $this->clipboard_service = $clipboard_service;
48    }
49
50    /**
51     * How should this module be labelled on tabs, menus, etc.?
52     *
53     * @return string
54     */
55    public function title(): string
56    {
57        /* I18N: Name of a module */
58        return I18N::translate('Notes');
59    }
60
61    /**
62     * A sentence describing what this module does.
63     *
64     * @return string
65     */
66    public function description(): string
67    {
68        /* I18N: Description of the “Notes” module */
69        return I18N::translate('A tab showing the notes attached to an individual.');
70    }
71
72    /**
73     * The default position for this tab.  It can be changed in the control panel.
74     *
75     * @return int
76     */
77    public function defaultTabOrder(): int
78    {
79        return 5;
80    }
81
82    /** {@inheritdoc} */
83    public function hasTabContent(Individual $individual): bool
84    {
85        return $individual->canEdit() || $this->getFactsWithNotes($individual);
86    }
87
88    /** {@inheritdoc} */
89    public function isGrayedOut(Individual $individual): bool
90    {
91        return !$this->getFactsWithNotes($individual);
92    }
93
94    /** {@inheritdoc} */
95    public function getTabContent(Individual $individual): string
96    {
97        return view('modules/notes/tab', [
98            'can_edit'        => $individual->canEdit(),
99            'clipboard_facts' => $this->clipboard_service->pastableFactsOfType($individual, $this->supportedFacts()),
100            'individual'      => $individual,
101            'facts'           => $this->getFactsWithNotes($individual),
102        ]);
103    }
104
105    /**
106     * Get all the facts for an individual which contain notes.
107     *
108     * @param Individual $individual
109     *
110     * @return Fact[]
111     */
112    private function getFactsWithNotes(Individual $individual): array
113    {
114        if ($this->facts === null) {
115            $facts = $individual->facts();
116            foreach ($individual->getSpouseFamilies() as $family) {
117                if ($family->canShow()) {
118                    foreach ($family->facts() as $fact) {
119                        $facts[] = $fact;
120                    }
121                }
122            }
123            $this->facts = [];
124            foreach ($facts as $fact) {
125                if (preg_match('/(?:^1|\n\d) NOTE/', $fact->gedcom())) {
126                    $this->facts[] = $fact;
127                }
128            }
129            Functions::sortFacts($this->facts);
130        }
131
132        return $this->facts;
133    }
134
135    /** {@inheritdoc} */
136    public function canLoadAjax(): bool
137    {
138        return false;
139    }
140
141    /**
142     * This module handles the following facts - so don't show them on the "Facts and events" tab.
143     *
144     * @return Collection|string[]
145     */
146    public function supportedFacts(): Collection
147    {
148        return new Collection(['NOTE']);
149    }
150}
151