19032934bcdf37638561d28673ee2d71db0a7c12
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / TYPO3Color / class.tx_rtehtmlarea_typo3color.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2008 Stanislas Rolland <stanislas.rolland(arobas)fructifor.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 <stanislas.rolland(arobas)fructifor.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_typo3color extends tx_rtehtmlareaapi {
36
37 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
38 protected $pluginName = 'TYPO3Color'; // The name of the plugin registered by the extension
39 protected $relativePathToLocallangFile = 'extensions/TYPO3Color/locallang.xml'; // Path to this main locallang file of the extension relative to the extension dir.
40 protected $relativePathToSkin = 'extensions/TYPO3Color/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 = 'textcolor,bgcolor';
47 protected $convertToolbarForHtmlAreaArray = array (
48 'textcolor' => 'ForeColor',
49 'bgcolor' => 'HiliteColor',
50 );
51
52 public function main($parentObject) {
53 return parent::main($parentObject) && !$this->thisConfig['disableSelectColor'];
54 }
55
56 /**
57 * Return JS configuration of the htmlArea plugins registered by the extension
58 *
59 * @param integer Relative id of the RTE editing area in the form
60 *
61 * @return string JS configuration for registered plugins
62 *
63 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
64 * Each of the instructions should be of the form:
65 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
66 */
67 public function buildJavascriptConfiguration($RTEcounter) {
68
69 // Process colors configuration
70 $registerRTEinJavascriptString = $this->buildJSColorsConfig($RTEcounter);
71
72 return $registerRTEinJavascriptString;
73 }
74
75 /**
76 * Return Javascript configuration of colors
77 *
78 * @param integer $RTEcounter: The index number of the current RTE editing area within the form.
79 *
80 * @return string Javascript configuration of colors
81 */
82 function buildJSColorsConfig($RTEcounter) {
83
84 if ($this->htmlAreaRTE->is_FE()) {
85 $RTEProperties = $this->htmlAreaRTE->RTEsetup;
86 } else {
87 $RTEProperties = $this->htmlAreaRTE->RTEsetup['properties'];
88 }
89
90 $configureRTEInJavascriptString = '';
91
92 $configureRTEInJavascriptString .= '
93 RTEarea['.$RTEcounter.'].disableColorPicker = ' . (trim($this->thisConfig['disableColorPicker']) ? 'true' : 'false') . ';';
94
95 // Building JS array of configured colors
96 if (is_array($RTEProperties['colors.']) ) {
97 $HTMLAreaColorname = array();
98 foreach ($RTEProperties['colors.'] as $colorName => $conf) {
99 $colorName=substr($colorName,0,-1);
100 $colorLabel = $this->htmlAreaRTE->getPageConfigLabel($conf['name']);
101 $HTMLAreaColorname[$colorName] = '
102 [' . $colorLabel . ' , "' . $conf['value'] . '"]';
103 }
104 }
105
106 // Setting the list of colors if specified in the RTE config
107 if ($this->thisConfig['colors'] ) {
108 $HTMLAreaJSColors = '[';
109 $HTMLAreaColors = t3lib_div::trimExplode(',' , $this->htmlAreaRTE->cleanList($this->thisConfig['colors']));
110 $HTMLAreaColorsIndex = 0;
111 foreach ($HTMLAreaColors as $colorName) {
112 if($HTMLAreaColorsIndex && $HTMLAreaColorname[$colorName]) {
113 $HTMLAreaJSColors .= ',';
114 }
115 $HTMLAreaJSColors .= $HTMLAreaColorname[$colorName];
116 $HTMLAreaColorsIndex++;
117 }
118 $HTMLAreaJSColors .= '];';
119 $configureRTEInJavascriptString .= '
120 RTEarea['.$RTEcounter.'].colors = '. $HTMLAreaJSColors;
121 }
122
123 return $configureRTEInJavascriptString;
124 }
125
126 } // end of class
127
128 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Color/class.tx_rtehtmlarea_typo3color.php']) {
129 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Color/class.tx_rtehtmlarea_typo3color.php']);
130 }
131
132 ?>