Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / QuickTag / class.tx_rtehtmlarea_quicktag.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2008-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 * CharacterMap plugin for htmlArea RTE
26 *
27 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
28 *
29 * TYPO3 SVN ID: $Id$
30 *
31 */
32 class tx_rtehtmlarea_quicktag extends tx_rtehtmlarea_api {
33
34 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
35 protected $pluginName = 'QuickTag'; // The name of the plugin registered by the extension
36 protected $relativePathToLocallangFile = ''; // Path to this main locallang file of the extension relative to the extension dir.
37 protected $relativePathToSkin = 'extensions/QuickTag/skin/htmlarea.css'; // Path to the skin (css) file relative to the extension dir.
38 protected $htmlAreaRTE; // Reference to the invoking object
39 protected $thisConfig; // Reference to RTE PageTSConfig
40 protected $toolbar; // Reference to RTE toolbar array
41 protected $LOCAL_LANG; // Frontend language array
42
43 protected $pluginButtons = 'inserttag';
44 protected $convertToolbarForHtmlAreaArray = array (
45 'inserttag' => 'InsertTag',
46 );
47 protected $requiredPlugins = 'TYPO3Color'; // The comma-separated list of names of prerequisite plugins
48
49 public function main($parentObject) {
50 $available = parent::main($parentObject);
51 if ($this->thisConfig['disableSelectColor'] && $this->htmlAreaRTE->client['browser'] != 'gecko') {
52 $this->requiredPlugins = 'DefaultColor';
53 }
54 return $available;
55 }
56
57 /**
58 * Return JS configuration of the htmlArea plugins registered by the extension
59 *
60 * @param integer Relative id of the RTE editing area in the form
61 *
62 * @return string JS configuration for registered plugins
63 *
64 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
65 * Each of the instructions should be of the form:
66 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
67 */
68 public function buildJavascriptConfiguration($RTEcounter) {
69
70 $registerRTEinJavascriptString = '';
71 // Deprecated inserttag button configuration
72 if (in_array('inserttag', $this->toolbar) && trim($this->thisConfig['hideTags'])) {
73 if (!is_array($this->thisConfig['buttons.']['inserttag.'])) {
74 $registerRTEinJavascriptString .= '
75 RTEarea['.$RTEcounter.'].buttons.inserttag = new Object();
76 RTEarea['.$RTEcounter.'].buttons.inserttag.denyTags = "'.implode(',', t3lib_div::trimExplode(',', $this->thisConfig['hideTags'], 1)).'";';
77 } elseif (!$this->thisConfig['buttons.']['inserttag.']['denyTags']) {
78 $registerRTEinJavascriptString .= '
79 RTEarea['.$RTEcounter.'].buttons.inserttag.denyTags = "'.implode(',', t3lib_div::trimExplode(',', $this->thisConfig['hideTags'], 1)).'";';
80 }
81 }
82 return $registerRTEinJavascriptString;
83 }
84
85 } // end of class
86
87 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/QuickTag/class.tx_rtehtmlarea_quicktag.php'])) {
88 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/QuickTag/class.tx_rtehtmlarea_quicktag.php']);
89 }
90
91 ?>