[CLEANUP] RTE plugin classes
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Classes / Extension / Plaintext.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\Rtehtmlarea\RteHtmlAreaApi;
18 use TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase;
19
20 /**
21 * Copy as Plain Text extension for htmlArea RTE
22 *
23 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
24 */
25 class Plaintext extends RteHtmlAreaApi {
26
27 /**
28 * The name of the plugin registered by the extension
29 *
30 * @var string
31 */
32 protected $pluginName = 'PlainText';
33
34 /**
35 * Path to the skin file relative to the extension directory
36 *
37 * @var string
38 */
39 protected $relativePathToSkin = 'Resources/Public/Css/Skin/Plugins/plain-text.css';
40
41 /**
42 * The comma-separated list of button names that the registered plugin is adding to the htmlArea RTE toolbar
43 *
44 * @var string
45 */
46 protected $pluginButtons = 'pastetoggle,pastebehaviour';
47
48 /**
49 * The name-converting array, converting the button names used in the RTE PageTSConfing to the button id's used by the JS scripts
50 *
51 * @var array
52 */
53 protected $convertToolbarForHtmlAreaArray = array(
54 'pastetoggle' => 'PasteToggle',
55 'pastebehaviour' => 'PasteBehaviour'
56 );
57
58 /**
59 * Returns TRUE if the plugin is available and correctly initialized
60 *
61 * @param RteHtmlAreaBase $parentObject parent object
62 * @return bool TRUE if this plugin object should be made available in the current environment and is correctly initialized
63 */
64 public function main($parentObject) {
65 // Opera has no onPaste event to handle
66 return parent::main($parentObject) && $this->htmlAreaRTE->client['browser'] != 'opera';
67 }
68
69 /**
70 * Return JS configuration of the htmlArea plugins registered by the extension
71 *
72 * @param string $rteNumberPlaceholder A dummy string for JS arrays
73 * @return string JS configuration for registered plugins
74 */
75 public function buildJavascriptConfiguration($rteNumberPlaceholder) {
76 $registerRTEinJavascriptString = '';
77 $button = 'pastebehaviour';
78 // Get current TYPO3 User Setting, if available
79 if (TYPO3_MODE === 'BE' && \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('setup') && is_array($GLOBALS['TYPO3_USER_SETTINGS']) && is_object($GLOBALS['BE_USER'])) {
80 if (!is_array($this->thisConfig['buttons.']) || !is_array($this->thisConfig['buttons.'][($button . '.')])) {
81 $registerRTEinJavascriptString .= '
82 RTEarea[' . $rteNumberPlaceholder . '].buttons.' . $button . ' = new Object();';
83 }
84 $registerRTEinJavascriptString .= '
85 RTEarea[' . $rteNumberPlaceholder . '].buttons.' . $button . '.current = "' . (isset($GLOBALS['BE_USER']->uc['rteCleanPasteBehaviour']) ? $GLOBALS['BE_USER']->uc['rteCleanPasteBehaviour'] : 'plainText') . '";';
86 }
87 return $registerRTEinJavascriptString;
88 }
89
90 /**
91 * Return an updated array of toolbar enabled buttons
92 *
93 * @param array $show: array of toolbar elements that will be enabled, unless modified here
94 * @return array toolbar button array, possibly updated
95 */
96 public function applyToolbarConstraints($show) {
97 $removeButtons = array();
98 // Remove pastebehaviour button if pastetoggle is not configured
99 if (!in_array('pastetoggle', $show)) {
100 $removeButtons[] = 'pastebehaviour';
101 }
102 // Remove pastebehaviour button if TYPO3 User Settings are available
103 if (TYPO3_MODE === 'BE' && \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('setup') && is_array($GLOBALS['TYPO3_USER_SETTINGS']) && is_object($GLOBALS['BE_USER'])) {
104 $removeButtons[] = 'pastebehaviour';
105 }
106 return array_diff($show, $removeButtons);
107 }
108
109 }