Cleanup: Updated copyright notices
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / TYPO3Image / class.tx_rtehtmlarea_typo3image.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2008-2009 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 * TYPO3 Image plugin for htmlArea RTE
26 *
27 * @author Stanislas Rolland <stanislas.rolland(arobas)fructifor.ca>
28 *
29 * TYPO3 SVN ID: $Id$
30 *
31 */
32
33 require_once(t3lib_extMgm::extPath('rtehtmlarea').'class.tx_rtehtmlareaapi.php');
34
35 class tx_rtehtmlarea_typo3image extends tx_rtehtmlareaapi {
36
37 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
38 protected $pluginName = 'TYPO3Image'; // 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/TYPO3Image/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 = 'image';
47 protected $convertToolbarForHtmlAreaArray = array (
48 'image' => 'InsertImage',
49 );
50
51 public function main($parentObject) {
52 // Check if this should be enabled based on Page TSConfig
53 return parent::main($parentObject) && !$this->thisConfig['disableTYPO3Browsers']
54 && !(is_array( $this->thisConfig['buttons.']) && is_array($this->thisConfig['buttons.']['image.']) && is_array($this->thisConfig['buttons.']['image.']['TYPO3Browser.']) && $this->thisConfig['buttons.']['image.']['TYPO3Browser.']['disabled']);
55 }
56
57 /**
58 * Return JS configuration of the htmlArea plugins registered by the extension
59 *
60 * @param integer Relative id of the RTE editing area in the form
61 *
62 * @return string JS configuration for registered plugins, in this case, JS configuration of block elements
63 *
64 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
65 * Each of the instructions should be of the form:
66 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
67 */
68 public function buildJavascriptConfiguration($RTEcounter) {
69
70 $registerRTEinJavascriptString = '';
71 $button = 'image';
72 if (in_array($button, $this->toolbar)) {
73 if (!is_array( $this->thisConfig['buttons.']) || !is_array( $this->thisConfig['buttons.'][$button.'.'])) {
74 $registerRTEinJavascriptString .= '
75 RTEarea['.$RTEcounter.']["buttons"]["'. $button .'"] = new Object();';
76 }
77 $registerRTEinJavascriptString .= '
78 RTEarea['.$RTEcounter.'].buttons.'. $button .'.pathImageModule = "../../mod4/select_image.php";';
79 }
80
81 return $registerRTEinJavascriptString;
82 }
83
84 } // end of class
85
86 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Image/class.tx_rtehtmlarea_typo3image.php']) {
87 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Image/class.tx_rtehtmlarea_typo3image.php']);
88 }
89
90 ?>