Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / TYPO3Image / class.tx_rtehtmlarea_typo3image.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 * TYPO3 Image 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_typo3image extends tx_rtehtmlarea_api {
33
34 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
35 protected $pluginName = 'TYPO3Image'; // 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/TYPO3Image/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 = 'image';
44 protected $convertToolbarForHtmlAreaArray = array (
45 'image' => 'InsertImage',
46 );
47
48 public function main($parentObject) {
49 // Check if this should be enabled based on Page TSConfig
50 return parent::main($parentObject) && !$this->thisConfig['disableTYPO3Browsers']
51 && !(is_array( $this->thisConfig['buttons.']) && is_array($this->thisConfig['buttons.']['image.']) && is_array($this->thisConfig['buttons.']['image.']['TYPO3Browser.']) && $this->thisConfig['buttons.']['image.']['TYPO3Browser.']['disabled']);
52 }
53
54 /**
55 * Return JS configuration of the htmlArea plugins registered by the extension
56 *
57 * @param integer Relative id of the RTE editing area in the form
58 *
59 * @return string JS configuration for registered plugins, in this case, JS configuration of block elements
60 *
61 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
62 * Each of the instructions should be of the form:
63 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
64 */
65 public function buildJavascriptConfiguration($RTEcounter) {
66
67 $registerRTEinJavascriptString = '';
68 $button = 'image';
69 if (in_array($button, $this->toolbar)) {
70 if (!is_array( $this->thisConfig['buttons.']) || !is_array( $this->thisConfig['buttons.'][$button.'.'])) {
71 $registerRTEinJavascriptString .= '
72 RTEarea['.$RTEcounter.']["buttons"]["'. $button .'"] = new Object();';
73 }
74 $registerRTEinJavascriptString .= '
75 RTEarea['.$RTEcounter.'].buttons.'. $button .'.pathImageModule = "' . $this->htmlAreaRTE->extHttpPath . 'mod4/select_image.php";';
76 }
77 return $registerRTEinJavascriptString;
78 }
79 }
80 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Image/class.tx_rtehtmlarea_typo3image.php'])) {
81 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Image/class.tx_rtehtmlarea_typo3image.php']);
82 }
83 ?>