626da9530ffb8f8067d6d64a49b83721afca561b
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / SpellChecker / class.tx_rtehtmlarea_spellchecker.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2008 Stanislas Rolland <typo3(arobas)sjbr.ca>
6 * All rights reserved
7 *
8 * This script is part of the Typo3 project. The Typo3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 *
17 * This script is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * This copyright notice MUST APPEAR in all copies of the script!
23 ***************************************************************/
24 /**
25 * Spell Checker plugin for htmlArea RTE
26 *
27 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
28 *
29 * TYPO3 SVN ID: $Id$
30 *
31 */
32
33 require_once(t3lib_extMgm::extPath('rtehtmlarea').'class.tx_rtehtmlareaapi.php');
34
35 class tx_rtehtmlarea_spellchecker extends tx_rtehtmlareaapi {
36
37 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
38 protected $pluginName = 'SpellChecker'; // The name of the plugin registered by the extension
39 protected $relativePathToLocallangFile = ''; // Path to this main locallang file of the extension relative to the extension dir.
40 protected $relativePathToSkin = 'extensions/SpellChecker/skin/htmlarea.css'; // Path to the skin (css) file relative to the extension dir.
41 protected $htmlAreaRTE; // Reference to the invoking object
42 protected $thisConfig; // Reference to RTE PageTSConfig
43 protected $toolbar; // Reference to RTE toolbar array
44 protected $LOCAL_LANG; // Frontend language array
45
46 protected $pluginButtons = 'spellcheck';
47 protected $convertToolbarForHtmlAreaArray = array (
48 'spellcheck' => 'SpellCheck',
49 );
50 protected $spellCheckerModes = array( 'ultra', 'fast', 'normal', 'bad-spellers');
51
52 public function main($parentObject) {
53 global $TYPO3_CONF_VARS;
54
55 return parent::main($parentObject)
56 && t3lib_extMgm::isLoaded('static_info_tables')
57 && !in_array($this->htmlAreaRTE->language, t3lib_div::trimExplode(',', $TYPO3_CONF_VARS['EXTCONF'][$this->htmlAreaRTE->ID]['noSpellCheckLanguages']))
58 && ($this->htmlAreaRTE->contentCharset == 'iso-8859-1' || $this->htmlAreaRTE->contentCharset == 'utf-8');
59 }
60
61 /**
62 * Return JS configuration of the htmlArea plugins registered by the extension
63 *
64 * @param integer Relative id of the RTE editing area in the form
65 *
66 * @return string JS configuration for registered plugins
67 *
68 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
69 * Each of the instructions should be of the form:
70 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
71 */
72 public function buildJavascriptConfiguration($RTEcounter) {
73 global $TSFE, $LANG, $TYPO3_CONF_VARS, $BE_USER;
74
75 // Set the SpellChecker mode
76 $spellCheckerMode = isset($BE_USER->userTS['options.']['HTMLAreaPspellMode']) ? trim($BE_USER->userTS['options.']['HTMLAreaPspellMode']) : 'normal';
77 if (!in_array($spellCheckerMode, $this->spellCheckerModes)) {
78 $spellCheckerMode = 'normal';
79 }
80 // Set the use of personal dictionary
81 $enablePersonalDicts = $this->thisConfig['enablePersonalDicts'] ? ((isset($BE_USER->userTS['options.']['enablePersonalDicts']) && $BE_USER->userTS['options.']['enablePersonalDicts']) ? true : false) : false;
82 if (ini_get('safe_mode') || $this->htmlAreaRTE->is_FE()) {
83 $enablePersonalDicts = false;
84 }
85
86 $registerRTEinJavascriptString = '';
87 $button = 'spellcheck';
88 if (in_array($button, $this->toolbar)) {
89 if (!is_array( $this->thisConfig['buttons.']) || !is_array( $this->thisConfig['buttons.'][$button.'.'])) {
90 $registerRTEinJavascriptString .= '
91 RTEarea['.$RTEcounter.'].buttons.'. $button .' = new Object();';
92 }
93 $registerRTEinJavascriptString .= '
94 RTEarea['.$RTEcounter.'].buttons.'. $button .'.contentTypo3Language = "' . $this->htmlAreaRTE->contentTypo3Language .'";
95 RTEarea['.$RTEcounter.'].buttons.'. $button .'.contentISOLanguage = "' . $this->htmlAreaRTE->contentISOLanguage .'";
96 RTEarea['.$RTEcounter.'].buttons.'. $button .'.contentCharset = "' . $this->htmlAreaRTE->contentCharset .'";
97 RTEarea['.$RTEcounter.'].buttons.'. $button .'.spellCheckerMode = "' . $spellCheckerMode .'";
98 RTEarea['.$RTEcounter.'].buttons.'. $button .'.enablePersonalDicts = ' . ($enablePersonalDicts ? 'true' : 'false') .';';
99 }
100 return $registerRTEinJavascriptString;
101 }
102
103 } // end of class
104
105 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/SpellChecker/class.tx_rtehtmlarea_spellchecker.php']) {
106 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/SpellChecker/class.tx_rtehtmlarea_spellchecker.php']);
107 }
108
109 ?>