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