Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / DefinitionList / class.tx_rtehtmlarea_definitionlist.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 * Definition List 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_definitionlist extends tx_rtehtmlarea_api {
33
34 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
35 protected $pluginName = 'DefinitionList'; // 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/DefinitionList/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 = 'definitionlist, definitionitem';
44
45 protected $convertToolbarForHtmlAreaArray = array (
46 'definitionlist' => 'DefinitionList',
47 'definitionitem' => 'DefinitionItem',
48 );
49 // The comma-separated list of names of prerequisite plugins
50 protected $requiredPlugins = 'BlockElements';
51
52 public function main($parentObject) {
53 $enabled = parent::main($parentObject) && $this->htmlAreaRTE->isPluginEnabled('BlockElements');
54 if ($enabled && is_object($this->htmlAreaRTE->registeredPlugins['BlockElements'])) {
55 $this->htmlAreaRTE->registeredPlugins['BlockElements']->setSynchronousLoad();
56 }
57 return $enabled;
58 }
59
60 /**
61 * Return JS configuration of the htmlArea plugins registered by the extension
62 *
63 * @param integer Relative id of the RTE editing area in the form
64 *
65 * @return string JS configuration for registered plugins
66 *
67 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
68 * Each of the instructions should be of the form:
69 * RTEarea['.$RTEcounter.'].buttons.button-id.property = "value";
70 */
71 public function buildJavascriptConfiguration($RTEcounter) {
72 global $TSFE, $LANG;
73
74 $registerRTEinJavascriptString = '';
75 return $registerRTEinJavascriptString;
76 }
77
78 /**
79 * Return an updated array of toolbar enabled buttons
80 *
81 * @param array $show: array of toolbar elements that will be enabled, unless modified here
82 *
83 * @return array toolbar button array, possibly updated
84 */
85 public function applyToolbarConstraints($show) {
86 $blockElementsButtons = 'formatblock, indent, outdent, blockquote, insertparagraphbefore, insertparagraphafter, left, center, right, justifyfull, orderedlist, unorderedlist';
87 $notRemoved = array_intersect(t3lib_div::trimExplode(',', $blockElementsButtons, 1), $show);
88 // DefinitionList plugin requires BlockElements plugin
89 // We will not allow any definition lists operations if all block elements buttons were disabled
90 if (empty($notRemoved)) {
91 return array_diff($show, t3lib_div::trimExplode(',', $this->pluginButtons));
92 } else {
93 return $show;
94 }
95 }
96
97 } // end of class
98
99 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/DefinitionList/class.tx_rtehtmlarea_definitionlist.php'])) {
100 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/DefinitionList/class.tx_rtehtmlarea_definitionlist.php']);
101 }
102
103 ?>