[!!!][FEATURE] Introduce PSR-7-based Routing for Backend AJAX Requests
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Classes / Extension / Spellchecker.php
1 <?php
2 namespace TYPO3\CMS\Rtehtmlarea\Extension;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Backend\Utility\BackendUtility;
18 use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
19 use TYPO3\CMS\Core\Utility\GeneralUtility;
20 use TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi;
21
22 /**
23 * Spell Checker plugin for htmlArea RTE
24 */
25 class Spellchecker extends RteHtmlAreaApi {
26
27 /**
28 * The name of the plugin registered by the extension
29 *
30 * @var string
31 */
32 protected $pluginName = 'SpellChecker';
33
34 /**
35 * The comma-separated list of button names that the registered plugin is adding to the htmlArea RTE toolbar
36 *
37 * @var string
38 */
39 protected $pluginButtons = 'spellcheck';
40
41 /**
42 * The name-converting array, converting the button names used in the RTE PageTSConfing to the button id's used by the JS scripts
43 *
44 * @var array
45 */
46 protected $convertToolbarForHtmlAreaArray = array(
47 'spellcheck' => 'SpellCheck'
48 );
49
50 /**
51 * Spell checker modes
52 *
53 * @var array
54 */
55 protected $spellCheckerModes = array('ultra', 'fast', 'normal', 'bad-spellers');
56
57 /**
58 * Returns TRUE if the plugin is available and correctly initialized
59 *
60 * @param array $configuration Configuration array given from calling object down to the single plugins
61 * @return bool TRUE if this plugin object should be made available in the current environment and is correctly initialized
62 */
63 public function main(array $configuration) {
64 return parent::main($configuration)
65 && ExtensionManagementUtility::isLoaded('static_info_tables')
66 && !in_array(
67 $this->configuration['language'],
68 GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rtehtmlarea']['plugins']['SpellChecker']['noSpellCheckLanguages'])
69 );
70 }
71
72 /**
73 * Return JS configuration of the htmlArea plugins registered by the extension
74 *
75 * @return string JS configuration for registered plugins
76 */
77 public function buildJavascriptConfiguration() {
78 $jsArray = array();
79 $button = 'spellcheck';
80 // Set the SpellChecker mode
81 $spellCheckerMode = isset($GLOBALS['BE_USER']->userTS['options.']['HTMLAreaPspellMode']) ? trim($GLOBALS['BE_USER']->userTS['options.']['HTMLAreaPspellMode']) : 'normal';
82 if (!in_array($spellCheckerMode, $this->spellCheckerModes)) {
83 $spellCheckerMode = 'normal';
84 }
85 // Set the use of personal dictionary
86 $enablePersonalDicts = $this->configuration['thisConfig']['buttons.'][$button . '.']['enablePersonalDictionaries'] && !empty($GLOBALS['BE_USER']->userTS['options.']['enablePersonalDicts']);
87 if (in_array($button, $this->toolbar)) {
88 if (!is_array($this->configuration['thisConfig']['buttons.']) || !is_array($this->configuration['thisConfig']['buttons.'][($button . '.')])) {
89 $jsArray[] = 'RTEarea[editornumber].buttons.' . $button . ' = new Object();';
90 }
91 $jsArray[] = 'RTEarea[editornumber].buttons.' . $button . '.contentTypo3Language = "' . $this->configuration['contentTypo3Language'] . '";';
92 $jsArray[] = 'RTEarea[editornumber].buttons.' . $button . '.contentISOLanguage = "' . $this->configuration['contentISOLanguage'] . '";';
93 $jsArray[] = 'RTEarea[editornumber].buttons.' . $button . '.spellCheckerMode = "' . $spellCheckerMode . '";';
94 $jsArray[] = 'RTEarea[editornumber].buttons.' . $button . '.enablePersonalDicts = ' . ($enablePersonalDicts ? 'true' : 'false') . ';';
95 $jsArray[] = 'RTEarea[editornumber].buttons.' . $button . '.path = "' . ($this->isFrontend() || $this->isFrontendEditActive() ? ($GLOBALS['TSFE']->absRefPrefix ? $GLOBALS['TSFE']->absRefPrefix : '') . 'index.php?eID=rtehtmlarea_spellchecker' : BackendUtility::getAjaxUrl('rtehtmlarea_spellchecker')) . '";';
96 }
97 return implode(LF, $jsArray);
98 }
99
100
101
102 }