Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / PlainText / class.tx_rtehtmlarea_plaintext.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010-2011 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 * Copy as Plain Text extension for htmlArea RTE
26 *
27 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
28 *
29 * TYPO3 SVN ID: $Id: class.tx_rtehtmlarea_plaintext.php 7838 2010-06-08 16:10:41Z stan $
30 *
31 */
32 class tx_rtehtmlarea_plaintext extends tx_rtehtmlarea_api {
33 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
34 protected $pluginName = 'PlainText'; // The name of the plugin registered by the extension
35 protected $relativePathToLocallangFile = ''; // Path to this main locallang file of the extension relative to the extension dir.
36 protected $relativePathToSkin = 'extensions/PlainText/skin/htmlarea.css'; // Path to the skin (css) file relative to the extension dir
37 protected $htmlAreaRTE; // Reference to the invoking object
38 protected $thisConfig; // Reference to RTE PageTSConfig
39 protected $toolbar; // Reference to RTE toolbar array
40 protected $LOCAL_LANG; // Frontend language array
41 protected $pluginButtons = 'pastetoggle,pastebehaviour';
42 protected $convertToolbarForHtmlAreaArray = array (
43 'pastetoggle' => 'PasteToggle',
44 'pastebehaviour' => 'PasteBehaviour',
45 );
46 public function main ($parentObject) {
47 // Opera has no onPaste event to handle
48 return parent::main($parentObject) && $this->htmlAreaRTE->client['browser'] != 'opera';
49 }
50 /**
51 * Return JS configuration of the htmlArea plugins registered by the extension
52 *
53 * @param integer Relative id of the RTE editing area in the form
54 *
55 * @return string JS configuration for registered plugins
56 *
57 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
58 * Each of the instructions should be of the form:
59 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
60 */
61 public function buildJavascriptConfiguration($RTEcounter) {
62 $registerRTEinJavascriptString = '';
63 $button = 'pastebehaviour';
64 // Get current TYPO3 User Setting, if available
65 if (TYPO3_MODE === 'BE' && t3lib_extMgm::isLoaded('setup') && is_array($GLOBALS['TYPO3_USER_SETTINGS']) && is_object($GLOBALS['BE_USER'])) {
66 if (!is_array($this->thisConfig['buttons.']) || !is_array($this->thisConfig['buttons.'][$button.'.'])) {
67 $registerRTEinJavascriptString .= '
68 RTEarea[' . $RTEcounter . '].buttons.' . $button . ' = new Object();';
69 }
70 $registerRTEinJavascriptString .= '
71 RTEarea[' . $RTEcounter . '].buttons.' . $button . '.current = "' . (isset($GLOBALS['BE_USER']->uc['rteCleanPasteBehaviour']) ? $GLOBALS['BE_USER']->uc['rteCleanPasteBehaviour'] : 'plainText') . '";';
72 }
73 return $registerRTEinJavascriptString;
74 }
75 /**
76 * Return an updated array of toolbar enabled buttons
77 *
78 * @param array $show: array of toolbar elements that will be enabled, unless modified here
79 *
80 * @return array toolbar button array, possibly updated
81 */
82 public function applyToolbarConstraints ($show) {
83 $removeButtons = array();
84 // Remove pastebehaviour button if pastetoggle is not configured
85 if (!in_array('pastetoggle', $show)) {
86 $removeButtons[] = 'pastebehaviour';
87 }
88 // Remove pastebehaviour button if TYPO3 User Settings are available
89 if (TYPO3_MODE === 'BE' && t3lib_extMgm::isLoaded('setup') && is_array($GLOBALS['TYPO3_USER_SETTINGS']) && is_object($GLOBALS['BE_USER'])) {
90 $removeButtons[] = 'pastebehaviour';
91 }
92 return array_diff($show, $removeButtons);
93 }
94 }
95 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/PlainText/class.tx_rtehtmlarea_plaintext.php'])) {
96 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/PlainText/class.tx_rtehtmlarea_plaintext.php']);
97 }
98 ?>