xref: /webtrees/app/Module/ShareUrlModule.php (revision 5bfc689774bb9a6401271c4ed15a6d50652c991b)
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
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\GedcomRecord;
23use Fisharebest\Webtrees\I18N;
24
25use function view;
26
27/**
28 * Class ShareUrlModule
29 */
30class ShareUrlModule extends AbstractModule implements ModuleShareInterface
31{
32    use ModuleShareTrait;
33
34    /**
35     * How should this module be identified in the control panel, etc.?
36     *
37     * @return string
38     */
39    public function title(): string
40    {
41        return I18N::translate('Share the URL');
42    }
43
44    /**
45     * A sentence describing what this module does.
46     *
47     * @return string
48     */
49    public function description(): string
50    {
51        return I18N::translate('Copy the URL of the record to the clipboard');
52    }
53
54    /**
55     * HTML to include in the share links page.
56     *
57     * @param GedcomRecord $record
58     *
59     * @return string
60     */
61    public function share(GedcomRecord $record): string
62    {
63        return view('modules/share-url/share', ['record' => $record]);
64    }
65}
66