Added feature #9201: Integrate support for definition list into htmlArea RTE
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / DefinitionList / class.tx_rtehtmlarea_definitionlist.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2008 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 * Definition List plugin for htmlArea RTE
26 *
27 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
28 *
29 * TYPO3 SVN ID: $Id: class.tx_rtehtmlarea_definitionlist.php $
30 *
31 */
32
33 require_once(t3lib_extMgm::extPath('rtehtmlarea').'class.tx_rtehtmlareaapi.php');
34
35 class tx_rtehtmlarea_definitionlist extends tx_rtehtmlareaapi {
36
37 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
38 protected $pluginName = 'DefinitionList'; // The name of the plugin registered by the extension
39 protected $relativePathToLocallangFile = ''; // Path to this main locallang file of the extension relative to the extension dir.
40 protected $relativePathToSkin = 'extensions/DefinitionList/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 = 'definitionlist, definitionitem';
47
48 protected $convertToolbarForHtmlAreaArray = array (
49 'definitionlist' => 'DefinitionList',
50 'definitionitem' => 'DefinitionItem',
51 );
52
53 public function main($parentObject) {
54 global $TYPO3_CONF_VARS;
55
56 return parent::main($parentObject) && $this->htmlAreaRTE->isPluginEnabled('BlockElements');
57 }
58
59 /**
60 * Return JS configuration of the htmlArea plugins registered by the extension
61 *
62 * @param integer Relative id of the RTE editing area in the form
63 *
64 * @return string JS configuration for registered plugins
65 *
66 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
67 * Each of the instructions should be of the form:
68 * RTEarea['.$RTEcounter.'].buttons.button-id.property = "value";
69 */
70 public function buildJavascriptConfiguration($RTEcounter) {
71 global $TSFE, $LANG;
72
73 $registerRTEinJavascriptString = '';
74 return $registerRTEinJavascriptString;
75 }
76
77 /**
78 * Return an updated array of toolbar enabled buttons
79 *
80 * @param array $show: array of toolbar elements that will be enabled, unless modified here
81 *
82 * @return array toolbar button array, possibly updated
83 */
84 public function applyToolbarConstraints($show) {
85 $blockElementsButtons = 'formatblock, indent, outdent, blockquote, insertparagraphbefore, insertparagraphafter, left, center, right, justifyfull, orderedlist, unorderedlist';
86 $notRemoved = array_intersect(t3lib_div::trimExplode(',', $blockElementsButtons, 1), $show);
87 // DefinitionList plugin requires BlockElements plugin
88 // We will not allow any definition lists operations if all block elements buttons were disabled
89 if (empty($notRemoved)) {
90 return array_diff($show, t3lib_div::trimExplode(',', $this->pluginButtons));
91 } else {
92 return $show;
93 }
94 }
95
96 } // end of class
97
98 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/DefinitionList/class.tx_rtehtmlarea_definitionlist.php']) {
99 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/DefinitionList/class.tx_rtehtmlarea_definitionlist.php']);
100 }
101
102 ?>