* Added feature #6657: Extract inline buttons from htmlArea RTE main scripts.
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / class.tx_rtehtmlareaapi.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2007 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 * API for extending htmlArea RTE
26 *
27 * @author Stanislas Rolland <stanislas.rolland(arobas)fructifor.ca>
28 *
29 * TYPO3 CVS ID: $Id$
30 *
31 */
32
33 require_once(PATH_t3lib.'class.t3lib_div.php');
34
35 abstract class tx_rtehtmlareaapi {
36
37 protected $extensionKey; // The key of the extension that is extending htmlArea RTE
38 protected $relativePathToLocallangFile; // Path to this main locallang file of the extension relative to the extension dir.
39 protected $relativePathToSkin; // Path to the skin (css) file relative to the extension dir.
40 protected $htmlAreaRTE; // Reference to the invoking object
41 protected $thisConfig; // Reference to RTE PageTSConfig
42 protected $toolBar; // Refrence to RTE toolbar array
43 protected $LOCAL_LANG; // Frontend language array
44 protected $pluginButtons = ''; // The comma-seperated list of button names that the extension id adding to the htmlArea RTE tollbar
45 protected $convertToolbarForHtmlAreaArray = array(); // The name-converting array, converting the button names used in the RTE PageTSConfing to the button id's used by the JS scripts
46
47 /**
48 * Returns true if the plugin is available and correctly initialized
49 *
50 * @param object Reference to parent object, which is an instance of the htmlArea RTE
51 *
52 * @return boolean true if this plugin object should be made available in the current environment and is correctly initialized
53 */
54 public function main($parentObject) {
55 global $TYPO3_CONF_VARS, $LANG;
56
57 $this->htmlAreaRTE =& $parentObject;
58 $this->thisConfig =& $this->htmlAreaRTE->thisConfig;
59 $this->toolbar =& $this->htmlAreaRTE->toolbar;
60
61 // Check if the plugin should be disabled in frontend
62 if ($this->htmlAreaRTE->is_FE() && is_array($TYPO3_CONF_VARS['EXTCONF'][$this->extensionKey]) && $TYPO3_CONF_VARS['EXTCONF'][$this->extensionKey]['disableInFE']) {
63 return false;
64 }
65
66 // Localization array must be initialized here
67 if ($this->htmlAreaRTE->is_FE()) {
68 $this->LOCAL_LANG = t3lib_div::readLLfile('EXT:' . $this->extensionKey . '/' . $this->relativePathToLocallangFile, $this->htmlAreaRTE->language);
69 } else {
70 $LANG->includeLLFile('EXT:' . $this->extensionKey . '/' . $this->relativePathToLocallangFile);
71 }
72 return true;
73 }
74
75 /**
76 * Returns a modified toolbar order string
77 *
78 * @return string a modified tollbar order list
79 */
80 public function addButtonsToToolbar() {
81 //Add only buttons not yet in the default toolbar order
82 $addButtons = implode(',', array_diff(t3lib_div::trimExplode(',', $this->pluginButtons, 1), t3lib_div::trimExplode(',', $this->htmlAreaRTE->defaultToolbarOrder, 1)));
83 return (($addButtons ? ('bar,' . $addButtons . ',linebreak,') : '') . $this->htmlAreaRTE->defaultToolbarOrder);
84 }
85
86 /**
87 * Returns the path to the skin component (button icons) that should be added to linked stylesheets
88 *
89 * @return string path to the skin (css) file
90 */
91 public function getPathToSkin() {
92 global $TYPO3_CONF_VARS;
93 if (is_array($TYPO3_CONF_VARS['EXTCONF'][$this->extensionKey]) && $TYPO3_CONF_VARS['EXTCONF'][$this->extensionKey]['addIconsToSkin']) {
94 return $this->relativePathToSkin;
95 } else {
96 return '';
97 }
98 }
99
100 /**
101 * Return JS configuration of the htmlArea plugins registered by the extension
102 *
103 * @param integer Relative id of the RTE editing area in the form
104 *
105 * @return string JS configuration for registered plugins
106 *
107 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
108 * Each of the instructions should be of the form:
109 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
110 */
111 public function buildJavascriptConfiguration($RTEcounter) {
112 global $TSFE, $LANG;
113
114 $registerRTEinJavascriptString = '';
115 foreach($this->pluginButtons as $button) {
116 if (in_array($button, $this->toolBar)) {
117 if (!is_array( $this->thisConfig['buttons.']) || !is_array( $this->thisConfig['buttons.'][$button.'.'])) {
118 $registerRTEinJavascriptString .= '
119 RTEarea['.$RTEcounter.']["buttons"]["'. $button .'"] = new Object();';
120 }
121 }
122 }
123 return $registerRTEinJavascriptString;
124 }
125
126 /**
127 * Returns the extension key
128 *
129 * @return string the extension key
130 */
131 public function getExtensionKey() {
132 return $this->extensionKey;
133 }
134
135 /**
136 * Returns the list of buttons implemented by the plugin
137 *
138 * @return string the list of buttons implemented by the plugin
139 */
140 public function getPluginButtons() {
141 return $this->pluginButtons;
142 }
143
144 /**
145 * Returns the conversion array from TYPO3 button names to htmlArea button names
146 *
147 * @return array the conversion array from TYPO3 button names to htmlArea button names
148 */
149 public function getConvertToolbarForHtmlAreaArray() {
150 return $this->convertToolbarForHtmlAreaArray;
151 }
152
153 } // end of class
154
155 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/class.tx_rtehtmlareaapi.php']) {
156 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/class.tx_rtehtmlareaapi.php']);
157 }
158
159 ?>