Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / TYPO3Color / class.tx_rtehtmlarea_typo3color.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 * TYPO3 Color 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_typo3color extends tx_rtehtmlarea_api {
33
34 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
35 protected $pluginName = 'TYPO3Color'; // The name of the plugin registered by the extension
36 protected $relativePathToLocallangFile = 'extensions/TYPO3Color/locallang.xml'; // Path to this main locallang file of the extension relative to the extension dir.
37 protected $relativePathToSkin = 'extensions/TYPO3Color/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 = 'textcolor,bgcolor';
44 protected $convertToolbarForHtmlAreaArray = array (
45 'textcolor' => 'ForeColor',
46 'bgcolor' => 'HiliteColor',
47 );
48
49 public function main($parentObject) {
50 return parent::main($parentObject) && $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rtehtmlarea']['allowStyleAttribute'];
51 }
52
53 /**
54 * Return JS configuration of the htmlArea plugins registered by the extension
55 *
56 * @param integer Relative id of the RTE editing area in the form
57 *
58 * @return string JS configuration for registered plugins
59 *
60 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
61 * Each of the instructions should be of the form:
62 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
63 */
64 public function buildJavascriptConfiguration($RTEcounter) {
65
66 // Process colors configuration
67 $registerRTEinJavascriptString = $this->buildJSColorsConfig($RTEcounter);
68
69 return $registerRTEinJavascriptString;
70 }
71
72 /**
73 * Return Javascript configuration of colors
74 *
75 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
76 *
77 * @return string Javascript configuration of colors
78 */
79 function buildJSColorsConfig($RTEcounter) {
80 if ($this->htmlAreaRTE->is_FE()) {
81 $RTEProperties = $this->htmlAreaRTE->RTEsetup;
82 } else {
83 $RTEProperties = $this->htmlAreaRTE->RTEsetup['properties'];
84 }
85 $configureRTEInJavascriptString = '';
86 $configureRTEInJavascriptString .= '
87 RTEarea['.$RTEcounter.'].disableColorPicker = ' . (trim($this->thisConfig['disableColorPicker']) ? 'true' : 'false') . ';';
88 // Building the array of configured colors
89 if (is_array($RTEProperties['colors.']) ) {
90 $HTMLAreaColorname = array();
91 foreach ($RTEProperties['colors.'] as $colorName => $conf) {
92 $colorName = substr($colorName, 0, -1);
93 $colorLabel = $this->htmlAreaRTE->getPageConfigLabel($conf['name'], 0);
94 $HTMLAreaColorname[$colorName] = array($colorLabel, strtoupper(substr($conf['value'], 1, 6)));
95 }
96 }
97 // Setting the list of colors if specified in the RTE config
98 if ($this->thisConfig['colors']) {
99 $HTMLAreaColors = t3lib_div::trimExplode(',' , $this->htmlAreaRTE->cleanList($this->thisConfig['colors']));
100 $HTMLAreaJSColors = array();
101 foreach ($HTMLAreaColors as $colorName) {
102 if ($HTMLAreaColorname[$colorName]) {
103 $HTMLAreaJSColors[] = $HTMLAreaColorname[$colorName];
104 }
105 }
106 if ($this->htmlAreaRTE->is_FE()) {
107 $GLOBALS['TSFE']->csConvObj->convArray($HTMLAreaJSColors, $this->htmlAreaRTE->OutputCharset, 'utf-8');
108 } else {
109 $GLOBALS['LANG']->csConvObj->convArray($HTMLAreaJSColors, $GLOBALS['LANG']->charSet, 'utf-8');
110 }
111 $configureRTEInJavascriptString .= '
112 RTEarea['.$RTEcounter.'].colors = ' . json_encode($HTMLAreaJSColors) . ';';
113 }
114 return $configureRTEInJavascriptString;
115 }
116 }
117 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Color/class.tx_rtehtmlarea_typo3color.php'])) {
118 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Color/class.tx_rtehtmlarea_typo3color.php']);
119 }
120 ?>