xref: /webtrees/app/Module/ModuleConfigTrait.php (revision 1d0e329a1ccba83512c6d387710580e867964d19)
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
22/**
23 * Trait ModuleConfigTrait - default implementation of ModuleConfigInterface
24 */
25trait ModuleConfigTrait
26{
27    /**
28     * A unique internal name for this module (based on the installation folder).
29     *
30     * @return string
31     */
32    abstract public function name(): string;
33
34    /**
35     * The URL to a page where the user can modify the configuration of this module.
36     *
37     * @return string
38     */
39    public function getConfigLink(): string
40    {
41        return route('module', [
42            'module' => $this->name(),
43            'action' => 'Admin',
44        ]);
45    }
46}
47