[CLEANUP] RTE plugin classes
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Classes / Extension / EditorMode.php
1 <?php
2 namespace TYPO3\CMS\Rtehtmlarea\Extension;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi;
18 use TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase;
19
20 /**
21 * EditorMode plugin for htmlArea RTE
22 *
23 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
24 */
25 class EditorMode extends RteHtmlAreaApi {
26
27 /**
28 * The name of the plugin registered by the extension
29 *
30 * @var string
31 */
32 protected $pluginName = 'EditorMode';
33
34 /**
35 * Path to the skin file relative to the extension directory
36 *
37 * @var string
38 */
39 protected $relativePathToSkin = 'Resources/Public/Css/Skin/Plugins/editor-mode.css';
40
41 /**
42 * The comma-separated list of button names that the registered plugin is adding to the htmlArea RTE toolbar
43 *
44 * @var string
45 */
46 protected $pluginButtons = 'chMode';
47
48 /**
49 * The name-converting array, converting the button names used in the RTE PageTSConfing to the button id's used by the JS scripts
50 *
51 * @var array
52 */
53 protected $convertToolbarForHtmlAreaArray = array(
54 'chMode' => 'TextMode'
55 );
56
57 /**
58 * Requiring itself so that it is always loaded.
59 *
60 * @var string
61 */
62 protected $requiredPlugins = 'EditorMode';
63
64 /**
65 * Returns TRUE if the plugin is available and correctly initialized
66 *
67 * @param RteHtmlAreaBase $parentObject parent object
68 * @return bool TRUE if this plugin object should be made available in the current environment and is correctly initialized
69 */
70 public function main($parentObject) {
71 parent::main($parentObject);
72 // Do not disable this plugin even if the chMode button is disabled
73 $this->pluginAddsButtons = FALSE;
74 return TRUE;
75 }
76
77 }