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