TYPO3 API  SVNRelease
class.tx_rtehtmlarea_typo3image.php
Go to the documentation of this file.
00001 <?php
00002 /***************************************************************
00003 *  Copyright notice
00004 *
00005 *  (c) 2008-2011 Stanislas Rolland <typo3(arobas)sjbr.ca>
00006 *  All rights reserved
00007 *
00008 *  This script is part of the Typo3 project. The Typo3 project is
00009 *  free software; you can redistribute it and/or modify
00010 *  it under the terms of the GNU General Public License as published by
00011 *  the Free Software Foundation; either version 2 of the License, or
00012 *  (at your option) any later version.
00013 *
00014 *  The GNU General Public License can be found at
00015 *  http://www.gnu.org/copyleft/gpl.html.
00016 *
00017 *  This script is distributed in the hope that it will be useful,
00018 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00019 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00020 *  GNU General Public License for more details.
00021 *
00022 *  This copyright notice MUST APPEAR in all copies of the script!
00023 ***************************************************************/
00024 /**
00025  * TYPO3 Image plugin for htmlArea RTE
00026  *
00027  * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
00028  *
00029  * TYPO3 SVN ID: $Id: class.tx_rtehtmlarea_typo3image.php 10240 2011-01-22 05:23:59Z stan $
00030  *
00031  */
00032 class tx_rtehtmlarea_typo3image extends tx_rtehtmlarea_api {
00033 
00034     protected $extensionKey = 'rtehtmlarea';    // The key of the extension that is extending htmlArea RTE
00035     protected $pluginName = 'TYPO3Image';       // The name of the plugin registered by the extension
00036     protected $relativePathToLocallangFile = '';    // Path to this main locallang file of the extension relative to the extension dir.
00037     protected $relativePathToSkin  = 'extensions/TYPO3Image/skin/htmlarea.css'; // Path to the skin (css) file relative to the extension dir.
00038     protected $htmlAreaRTE;             // Reference to the invoking object
00039     protected $thisConfig;              // Reference to RTE PageTSConfig
00040     protected $toolbar;             // Reference to RTE toolbar array
00041     protected $LOCAL_LANG;              // Frontend language array
00042 
00043     protected $pluginButtons = 'image';
00044     protected $convertToolbarForHtmlAreaArray = array (
00045         'image' => 'InsertImage',
00046         );
00047 
00048     public function main($parentObject) {
00049             // Check if this should be enabled based on extension configuration and Page TSConfig
00050             // The 'Minimal' and 'Typical' default configurations include Page TSConfig that removes images on the way to the database
00051         return parent::main($parentObject)
00052             && !($this->thisConfig['proc.']['entryHTMLparser_db.']['tags.']['img.']['allowedAttribs'] == '0' && $this->thisConfig['proc.']['entryHTMLparser_db.']['tags.']['img.']['rmTagIfNoAttrib'] == '1')
00053             && !$this->thisConfig['disableTYPO3Browsers']
00054             && !$this->thisConfig['buttons.']['image.']['TYPO3Browser.']['disabled'];
00055     }
00056 
00057     /**
00058      * Return JS configuration of the htmlArea plugins registered by the extension
00059      *
00060      * @param   integer     Relative id of the RTE editing area in the form
00061      *
00062      * @return  string      JS configuration for registered plugins, in this case, JS configuration of block elements
00063      *
00064      * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
00065      * Each of the instructions should be of the form:
00066      *  RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
00067      */
00068     public function buildJavascriptConfiguration($RTEcounter) {
00069 
00070         $registerRTEinJavascriptString = '';
00071         $button = 'image';
00072         if (in_array($button, $this->toolbar)) {
00073             if (!is_array( $this->thisConfig['buttons.']) || !is_array( $this->thisConfig['buttons.'][$button.'.'])) {
00074                     $registerRTEinJavascriptString .= '
00075             RTEarea['.$RTEcounter.']["buttons"]["'. $button .'"] = new Object();';
00076             }
00077             $registerRTEinJavascriptString .= '
00078             RTEarea['.$RTEcounter.'].buttons.'. $button .'.pathImageModule = "' . $this->htmlAreaRTE->extHttpPath . 'mod4/select_image.php";';
00079         }
00080         return $registerRTEinJavascriptString;
00081     }
00082 }
00083 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Image/class.tx_rtehtmlarea_typo3image.php'])) {
00084     include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Image/class.tx_rtehtmlarea_typo3image.php']);
00085 }
00086 ?>