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