xref: /webtrees/app/Module/ShareUrlModule.php (revision b0f2796f8c7f9d92d007e1ed61a612ac5595a95e)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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    public function description(): string
45    {
46        return I18N::translate('Copy the URL of the record to the clipboard');
47    }
48
49    /**
50     * HTML to include in the share links page.
51     *
52     * @param GedcomRecord $record
53     *
54     * @return string
55     */
56    public function share(GedcomRecord $record): string
57    {
58        return view('modules/share-url/share', ['record' => $record]);
59    }
60}
61