Completed
Push — develop ( cd5e45...778c00 )
by Greg
19:49 queued 10:28
created

ShareUrlModule::share()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 1
eloc 1
c 1
b 0
f 1
nc 1
nop 1
dl 0
loc 3
rs 10
1
<?php
2
3
/**
4
 * webtrees: online genealogy
5
 * Copyright (C) 2021 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\GedcomRecord;
23
use Fisharebest\Webtrees\I18N;
24
25
use function view;
26
27
/**
28
 * Class ShareUrlModule
29
 */
30
class 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