class.tx_rtehtmlarea_plaintext.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2010-2011 Stanislas Rolland <typo3(arobas)sjbr.ca>
*  All rights reserved
*
*  This script is part of the Typo3 project. The Typo3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
 * Copy as Plain Text extension for htmlArea RTE
 *
 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
 *
 * TYPO3 SVN ID: $Id: class.tx_rtehtmlarea_plaintext.php 7838 2010-06-08 16:10:41Z stan $
 *
 */
class tx_rtehtmlarea_plaintext extends tx_rtehtmlarea_api {
    protected $extensionKey = 'rtehtmlarea';        // The key of the extension that is extending htmlArea RTE
    protected $pluginName = 'PlainText';            // The name of the plugin registered by the extension
    protected $relativePathToLocallangFile = '';        // Path to this main locallang file of the extension relative to the extension dir.
    protected $relativePathToSkin = 'extensions/PlainText/skin/htmlarea.css';       // Path to the skin (css) file relative to the extension dir
    protected $htmlAreaRTE;                 // Reference to the invoking object
    protected $thisConfig;                  // Reference to RTE PageTSConfig
    protected $toolbar;                 // Reference to RTE toolbar array
    protected $LOCAL_LANG;                  // Frontend language array
    protected $pluginButtons = 'pastetoggle,pastebehaviour';
    protected $convertToolbarForHtmlAreaArray = array (
        'pastetoggle'       => 'PasteToggle',
        'pastebehaviour'    => 'PasteBehaviour',
        );
    public function main ($parentObject) {
            // Opera has no onPaste event to handle
        return parent::main($parentObject) && $this->htmlAreaRTE->client['browser'] != 'opera';
    }
    /**
     * Return JS configuration of the htmlArea plugins registered by the extension
     *
     * @param   integer     Relative id of the RTE editing area in the form
     *
     * @return string       JS configuration for registered plugins
     *
     * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
     * Each of the instructions should be of the form:
     *  RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
     */
    public function buildJavascriptConfiguration($RTEcounter) {
        $registerRTEinJavascriptString = '';
        $button = 'pastebehaviour';
            // Get current TYPO3 User Setting, if available
        if (TYPO3_MODE === 'BE' && t3lib_extMgm::isLoaded('setup') && is_array($GLOBALS['TYPO3_USER_SETTINGS']) && is_object($GLOBALS['BE_USER'])) {
            if (!is_array($this->thisConfig['buttons.']) || !is_array($this->thisConfig['buttons.'][$button.'.'])) {
                    $registerRTEinJavascriptString .= '
            RTEarea[' . $RTEcounter . '].buttons.' . $button . ' = new Object();';
            }
            $registerRTEinJavascriptString .= '
            RTEarea[' . $RTEcounter . '].buttons.' . $button . '.current = "' . (isset($GLOBALS['BE_USER']->uc['rteCleanPasteBehaviour']) ? $GLOBALS['BE_USER']->uc['rteCleanPasteBehaviour'] : 'plainText') . '";';
        }
        return $registerRTEinJavascriptString;
    }
    /**
     * Return an updated array of toolbar enabled buttons
     *
     * @param   array       $show: array of toolbar elements that will be enabled, unless modified here
     *
     * @return  array       toolbar button array, possibly updated
     */
    public function applyToolbarConstraints ($show) {
        $removeButtons = array();
            // Remove pastebehaviour button if pastetoggle is not configured
        if (!in_array('pastetoggle', $show)) {
            $removeButtons[] = 'pastebehaviour';
        }
            // Remove pastebehaviour button if TYPO3 User Settings are available
        if (TYPO3_MODE === 'BE' && t3lib_extMgm::isLoaded('setup') && is_array($GLOBALS['TYPO3_USER_SETTINGS']) && is_object($GLOBALS['BE_USER'])) {
            $removeButtons[] = 'pastebehaviour';
        }
        return array_diff($show, $removeButtons);
    }
}
if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/PlainText/class.tx_rtehtmlarea_plaintext.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/PlainText/class.tx_rtehtmlarea_plaintext.php']);
}
?>