xref: /webtrees/app/Module/CkeditorModule.php (revision e873f434551745f888937263ff89e80db3b0f785)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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
22use Fisharebest\Webtrees\I18N;
23
24/**
25 * Class CkeditorModule
26 */
27class CkeditorModule extends AbstractModule implements ModuleExternalUrlInterface, ModuleGlobalInterface
28{
29    use ModuleExternalUrlTrait;
30    use ModuleGlobalTrait;
31
32    // Location of our installation of CK editor.
33    public const string CKEDITOR_PATH = 'ckeditor-4.15.1-custom/';
34
35    /**
36     * How should this module be identified in the control panel, etc.?
37     *
38     * @return string
39     */
40    public function title(): string
41    {
42        /* I18N: Name of a module. CKEditor is a trademark. Do not translate it? https://ckeditor.com */
43        return I18N::translate('CKEditor™');
44    }
45
46    public function description(): string
47    {
48        /* I18N: Description of the “CKEditor” module. WYSIWYG = “what you see is what you get” */
49        return I18N::translate('Allow other modules to edit text using a “WYSIWYG” editor, instead of using HTML codes.');
50    }
51
52    /**
53     * Home page for the service.
54     *
55     * @return string
56     */
57    public function externalUrl(): string
58    {
59        return 'https://ckeditor.com';
60    }
61
62    /**
63     * Raw content, to be added at the end of the <body> element.
64     * Typically, this will be <script> elements.
65     *
66     * @return string
67     */
68    public function bodyContent(): string
69    {
70        return view('modules/ckeditor/ckeditor-js', [
71            'ckeditor_path' => asset(self::CKEDITOR_PATH),
72            'language'      => I18N::locale()->language()->code(),
73        ]);
74    }
75}
76