xref: /webtrees/app/Module/ModuleCustomTrait.php (revision 49a243cb5fe7c21b24e262552d556b018bfe3f41)
1*49a243cbSGreg Roach<?php
2*49a243cbSGreg Roach/**
3*49a243cbSGreg Roach * webtrees: online genealogy
4*49a243cbSGreg Roach * Copyright (C) 2019 webtrees development team
5*49a243cbSGreg Roach * This program is free software: you can redistribute it and/or modify
6*49a243cbSGreg Roach * it under the terms of the GNU General Public License as published by
7*49a243cbSGreg Roach * the Free Software Foundation, either version 3 of the License, or
8*49a243cbSGreg Roach * (at your option) any later version.
9*49a243cbSGreg Roach * This program is distributed in the hope that it will be useful,
10*49a243cbSGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
11*49a243cbSGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12*49a243cbSGreg Roach * GNU General Public License for more details.
13*49a243cbSGreg Roach * You should have received a copy of the GNU General Public License
14*49a243cbSGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
15*49a243cbSGreg Roach */
16*49a243cbSGreg Roachdeclare(strict_types=1);
17*49a243cbSGreg Roach
18*49a243cbSGreg Roachnamespace Fisharebest\Webtrees\Module;
19*49a243cbSGreg Roach
20*49a243cbSGreg Roach/**
21*49a243cbSGreg Roach * Trait ModuleCustomTrait - default implementation of ModuleCustomInterface
22*49a243cbSGreg Roach */
23*49a243cbSGreg Roachtrait ModuleCustomTrait
24*49a243cbSGreg Roach{
25*49a243cbSGreg Roach    /**
26*49a243cbSGreg Roach     * The person or organisation who created this module.
27*49a243cbSGreg Roach     *
28*49a243cbSGreg Roach     * @return string
29*49a243cbSGreg Roach     */
30*49a243cbSGreg Roach    public function customModuleAuthorName(): string {
31*49a243cbSGreg Roach        return 'Unknown author';
32*49a243cbSGreg Roach    }
33*49a243cbSGreg Roach
34*49a243cbSGreg Roach    /**
35*49a243cbSGreg Roach     * The version of this module.
36*49a243cbSGreg Roach     *
37*49a243cbSGreg Roach     * @return string
38*49a243cbSGreg Roach     */
39*49a243cbSGreg Roach    public function customModuleVersion(): string {
40*49a243cbSGreg Roach        return '0.0.0';
41*49a243cbSGreg Roach    }
42*49a243cbSGreg Roach
43*49a243cbSGreg Roach    /**
44*49a243cbSGreg Roach     * A URL that will provide the latest version of this module.
45*49a243cbSGreg Roach     *
46*49a243cbSGreg Roach     * @return string
47*49a243cbSGreg Roach     */
48*49a243cbSGreg Roach    public function customModuleLatestVersionUrl(): string {
49*49a243cbSGreg Roach        return 'https://www.exmaple.com/latest-version';
50*49a243cbSGreg Roach    }
51*49a243cbSGreg Roach
52*49a243cbSGreg Roach    /**
53*49a243cbSGreg Roach     * Where to get support for this module.  Perhaps a github respository?
54*49a243cbSGreg Roach     *
55*49a243cbSGreg Roach     * @return string
56*49a243cbSGreg Roach     */
57*49a243cbSGreg Roach    public function customModuleSupportUrl(): string {
58*49a243cbSGreg Roach        return 'https://www.exmaple.com/support';
59*49a243cbSGreg Roach    }
60*49a243cbSGreg Roach}
61