class.tx_rtehtmlarea_typo3link.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2008-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!
***************************************************************/
/**
 * TYPO3Link plugin for htmlArea RTE
 *
 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
 *
 * TYPO3 SVN ID: $Id: class.tx_rtehtmlarea_typo3link.php 10502 2011-02-20 04:18:31Z stan $
 *
 */
class tx_rtehtmlarea_typo3link extends tx_rtehtmlarea_api {

    protected $extensionKey = 'rtehtmlarea';    // The key of the extension that is extending htmlArea RTE
    protected $pluginName = 'TYPO3Link';        // 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/TYPO3Link/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 = 'link, unlink';
    protected $convertToolbarForHtmlAreaArray = array (
        'link'      => 'CreateLink',
        'unlink'    => 'UnLink',
        );

    public function main($parentObject) {
            // Check if this should be enabled based on Page TSConfig
        return parent::main($parentObject) && !$this->thisConfig['disableTYPO3Browsers']
                && !(is_array( $this->thisConfig['buttons.']) && is_array($this->thisConfig['buttons.']['link.']) && is_array($this->thisConfig['buttons.']['link.']['TYPO3Browser.']) && $this->thisConfig['buttons.']['link.']['TYPO3Browser.']['disabled']);
    }

    /**
     * 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, in this case, JS configuration of block elements
     *
     * 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 = 'link';
        if (in_array($button, $this->toolbar)) {
            if (!is_array( $this->thisConfig['buttons.']) || !is_array( $this->thisConfig['buttons.'][$button.'.'])) {
                $registerRTEinJavascriptString .= '
            RTEarea['.$RTEcounter.'].buttons.'. $button .' = new Object();';
            }
            $registerRTEinJavascriptString .= '
            RTEarea['.$RTEcounter.'].buttons.'. $button .'.pathLinkModule = "' . $this->htmlAreaRTE->extHttpPath . 'mod3/browse_links.php";';

            if ($this->htmlAreaRTE->is_FE()) {
                $RTEProperties = $this->htmlAreaRTE->RTEsetup;
            } else {
                $RTEProperties = $this->htmlAreaRTE->RTEsetup['properties'];
            }
            if (is_array($RTEProperties['classesAnchor.'])) {
                $registerRTEinJavascriptString .= '
            RTEarea['.$RTEcounter.'].buttons.'. $button .'.classesAnchorUrl = "' . $this->htmlAreaRTE->writeTemporaryFile('', 'classesAnchor_'.$this->htmlAreaRTE->contentLanguageUid, 'js', $this->buildJSClassesAnchorArray(), TRUE) . '";';
            }
            $registerRTEinJavascriptString .= '
            RTEarea['.$RTEcounter.'].buttons.'. $button .'.additionalAttributes = "external' . ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->extensionKey]['plugins'][$this->pluginName]['additionalAttributes'] ? (',' . $GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->extensionKey]['plugins'][$this->pluginName]['additionalAttributes']) : '') . '";';
        }
        return $registerRTEinJavascriptString;
    }

    /**
     * Return a JS array for special anchor classes
     *
     * @return  string      classesAnchor array definition
     */
    public function buildJSClassesAnchorArray() {
        global $LANG, $TYPO3_CONF_VARS;

        $linebreak = $TYPO3_CONF_VARS['EXTCONF'][$this->htmlAreaRTE->ID]['enableCompressedScripts'] ? '' : LF;
        $JSClassesAnchorArray .= 'HTMLArea.classesAnchorSetup = [ ' . $linebreak;
        $classesAnchorIndex = 0;
        foreach ($this->htmlAreaRTE->RTEsetup['properties']['classesAnchor.'] as $label => $conf) {
            if (is_array($conf) && $conf['class']) {
                $JSClassesAnchorArray .= (($classesAnchorIndex++)?',':'') . ' { ' . $linebreak;
                $index = 0;
                $JSClassesAnchorArray .= (($index++)?',':'') . 'name : "' . str_replace('"', '', str_replace('\'', '', $conf['class'])) . '"' . $linebreak;
                if ($conf['type']) {
                    $JSClassesAnchorArray .= (($index++)?',':'') . 'type : "' . str_replace('"', '', str_replace('\'', '', $conf['type'])) . '"' . $linebreak;
                }
                if (trim(str_replace('\'', '', str_replace('"', '', $conf['image'])))) {
                    $JSClassesAnchorArray .= (($index++)?',':'') . 'image : "' . $this->htmlAreaRTE->siteURL . t3lib_div::resolveBackPath(TYPO3_mainDir . $this->htmlAreaRTE->getFullFileName(trim(str_replace('\'', '', str_replace('"', '', $conf['image']))))) . '"' . $linebreak;
                }
                $JSClassesAnchorArray .= (($index++)?',':'') . 'addIconAfterLink : ' . ($conf['addIconAfterLink']?'true':'false') . $linebreak;
                if (trim($conf['altText'])) {
                    $string = $this->htmlAreaRTE->getLLContent(trim($conf['altText']));
                    $JSClassesAnchorArray .= (($index++)?',':'') . 'altText : ' . str_replace('"', '\"', str_replace('\\\'', '\'', $string)) . $linebreak;
                }
                if (trim($conf['titleText'])) {
                    $string = $this->htmlAreaRTE->getLLContent(trim($conf['titleText']));
                    $JSClassesAnchorArray .= (($index++)?',':'') . 'titleText : ' . str_replace('"', '\"', str_replace('\\\'', '\'', $string)) . $linebreak;
                }
                if (trim($conf['target'])) {
                    $JSClassesAnchorArray .= (($index++)?',':'') . 'target : "' . trim($conf['target']) . '"' . $linebreak;
                }
                $JSClassesAnchorArray .= '}' . $linebreak;
            }
        }
        $JSClassesAnchorArray .= '];' . $linebreak;
        return $JSClassesAnchorArray;
    }

    /**
     * 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) {
            // We will not allow unlink if link is not enabled
        if (!in_array('link', $show)) {
            return array_diff($show, t3lib_div::trimExplode(',', $this->pluginButtons));
        } else {
            return $show;
        }
    }
}
if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Link/class.tx_rtehtmlarea_typo3link.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Link/class.tx_rtehtmlarea_typo3link.php']);
}
?>