xref: /webtrees/app/Module/ModuleCustomTrait.php (revision cbf4b7fa194b4e336add2747abfccb05fbb0f4da)
149a243cbSGreg Roach<?php
249a243cbSGreg Roach/**
349a243cbSGreg Roach * webtrees: online genealogy
449a243cbSGreg Roach * Copyright (C) 2019 webtrees development team
549a243cbSGreg Roach * This program is free software: you can redistribute it and/or modify
649a243cbSGreg Roach * it under the terms of the GNU General Public License as published by
749a243cbSGreg Roach * the Free Software Foundation, either version 3 of the License, or
849a243cbSGreg Roach * (at your option) any later version.
949a243cbSGreg Roach * This program is distributed in the hope that it will be useful,
1049a243cbSGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
1149a243cbSGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1249a243cbSGreg Roach * GNU General Public License for more details.
1349a243cbSGreg Roach * You should have received a copy of the GNU General Public License
1449a243cbSGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
1549a243cbSGreg Roach */
1649a243cbSGreg Roachdeclare(strict_types=1);
1749a243cbSGreg Roach
1849a243cbSGreg Roachnamespace Fisharebest\Webtrees\Module;
1949a243cbSGreg Roach
2049a243cbSGreg Roach/**
2149a243cbSGreg Roach * Trait ModuleCustomTrait - default implementation of ModuleCustomInterface
2249a243cbSGreg Roach */
2349a243cbSGreg Roachtrait ModuleCustomTrait
2449a243cbSGreg Roach{
2549a243cbSGreg Roach    /**
2649a243cbSGreg Roach     * The person or organisation who created this module.
2749a243cbSGreg Roach     *
2849a243cbSGreg Roach     * @return string
2949a243cbSGreg Roach     */
30*cbf4b7faSGreg Roach    public function customModuleAuthorName(): string
31*cbf4b7faSGreg Roach    {
3249a243cbSGreg Roach        return 'Unknown author';
3349a243cbSGreg Roach    }
3449a243cbSGreg Roach
3549a243cbSGreg Roach    /**
3649a243cbSGreg Roach     * The version of this module.
3749a243cbSGreg Roach     *
3849a243cbSGreg Roach     * @return string
3949a243cbSGreg Roach     */
40*cbf4b7faSGreg Roach    public function customModuleVersion(): string
41*cbf4b7faSGreg Roach    {
4249a243cbSGreg Roach        return '0.0.0';
4349a243cbSGreg Roach    }
4449a243cbSGreg Roach
4549a243cbSGreg Roach    /**
4649a243cbSGreg Roach     * A URL that will provide the latest version of this module.
4749a243cbSGreg Roach     *
4849a243cbSGreg Roach     * @return string
4949a243cbSGreg Roach     */
50*cbf4b7faSGreg Roach    public function customModuleLatestVersionUrl(): string
51*cbf4b7faSGreg Roach    {
5249a243cbSGreg Roach        return 'https://www.exmaple.com/latest-version';
5349a243cbSGreg Roach    }
5449a243cbSGreg Roach
5549a243cbSGreg Roach    /**
5649a243cbSGreg Roach     * Where to get support for this module.  Perhaps a github respository?
5749a243cbSGreg Roach     *
5849a243cbSGreg Roach     * @return string
5949a243cbSGreg Roach     */
60*cbf4b7faSGreg Roach    public function customModuleSupportUrl(): string
61*cbf4b7faSGreg Roach    {
6249a243cbSGreg Roach        return 'https://www.exmaple.com/support';
6349a243cbSGreg Roach    }
6449a243cbSGreg Roach}
65