xref: /webtrees/app/Module/CkeditorModule.php (revision 43b1a91c1ee18d33be308adb1f31ec9b5678c6d7)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\I18N;
21
22/**
23 * Class CkeditorModule
24 */
25class CkeditorModule extends AbstractModule implements ModuleExternalUrlInterface
26{
27    use ModuleExternalUrlTrait;
28
29    // Location of our installation of CK editor.
30    public const CKEDITOR_PATH = 'public/ckeditor-4.11.2-custom/';
31
32    /**
33     * How should this module be labelled on tabs, menus, etc.?
34     *
35     * @return string
36     */
37    public function title(): string
38    {
39        /* I18N: Name of a module. CKEditor is a trademark. Do not translate it? http://ckeditor.com */
40        return I18N::translate('CKEditor™');
41    }
42
43    /**
44     * A sentence describing what this module does.
45     *
46     * @return string
47     */
48    public function description(): string
49    {
50        /* I18N: Description of the “CKEditor” module. WYSIWYG = “what you see is what you get” */
51        return I18N::translate('Allow other modules to edit text using a “WYSIWYG” editor, instead of using HTML codes.');
52    }
53
54    /**
55     * Home page for the service.
56     *
57     * @return string
58     */
59    public function externalUrl(): string
60    {
61        return 'https://ckeditor.com';
62    }
63}
64