class.tx_rtehtmlarea_selectfont.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!
***************************************************************/
/**
 * SelectFont extension for htmlArea RTE
 *
 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
 *
 * TYPO3 SVN ID: $Id: class.tx_rtehtmlarea_selectfont.php 10120 2011-01-18 20:03:36Z ohader $
 *
 */
class tx_rtehtmlarea_selectfont extends tx_rtehtmlarea_api {

    protected $extensionKey = 'rtehtmlarea';    // The key of the extension that is extending htmlArea RTE
    protected $pluginName = 'SelectFont';   // The name of the plugin registered by the extension
    protected $relativePathToLocallangFile = 'extensions/SelectFont/locallang.xml'; // Path to this main locallang file of the extension relative to the extension dir.
    protected $relativePathToSkin = '';     // 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 = 'fontstyle,fontsize';
    protected $convertToolbarForHtmlAreaArray = array (
        'fontstyle'     => 'FontName',
        'fontsize'      => 'FontSize',
        );

    protected $defaultFont = array(
        'fontstyle' => array(
            'Arial'         => 'Arial,sans-serif',
            'Arial Black'       => '\'Arial Black\',sans-serif',
            'Verdana'       => 'Verdana,Arial,sans-serif',
            'Times New Roman'   => '\'Times New Roman\',Times,serif',
            'Garamond'      => 'Garamond',
            'Lucida Handwriting'    => '\'Lucida Handwriting\'',
            'Courier'       => 'Courier',
            'Webdings'      => 'Webdings',
            'Wingdings'     => 'Wingdings',
            ),
        'fontsize' => array(
            'Extra small'   =>  '8px',
            'Very small'    =>  '9px',
            'Small'     =>  '10px',
            'Medium'    =>  '12px',
            'Large'     =>  '16px',
            'Very large'    =>  '24px',
            'Extra large'   =>  '32px',
            ),
        );

    protected $RTEProperties;

    public function main($parentObject) {
        $enabled = parent::main($parentObject) && $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rtehtmlarea']['allowStyleAttribute'];
        if ($this->htmlAreaRTE->is_FE()) {
            $this->RTEProperties = $this->htmlAreaRTE->RTEsetup;
        } else {
            $this->RTEProperties = $this->htmlAreaRTE->RTEsetup['properties'];
        }
        return $enabled;
    }

    /**
     * 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 = '';
        $pluginButtonsArray = t3lib_div::trimExplode(",", $this->pluginButtons);

            // Process Page TSConfig configuration for each button
        foreach ($pluginButtonsArray as $buttonId) {
            if (in_array($buttonId, $this->toolbar)) {
                $registerRTEinJavascriptString .= $this->buildJSFontItemsConfig($RTEcounter, $buttonId);
            }
        }
        return $registerRTEinJavascriptString;
    }

    /**
     * Return Javascript configuration of font faces
     *
     * @param   integer     $RTEcounter: The index number of the current RTE editing area within the form.
     * @param   string      $buttonId: button id
     *
     * @return  string      Javascript configuration of font faces
     */
    protected function buildJSFontItemsConfig($RTEcounter, $buttonId) {
        $configureRTEInJavascriptString = '';

            // Getting removal and addition configuration
        $hideItems = $this->htmlAreaRTE->cleanList($this->thisConfig['hideFont' .  (($buttonId == 'fontstyle') ? 'Faces' : 'Sizes')]);
        $addItems = t3lib_div::trimExplode(',', $this->htmlAreaRTE->cleanList($this->thisConfig[($buttonId == 'fontstyle') ? 'fontFace' : 'fontSize']), 1);
        if (is_array($this->thisConfig['buttons.']) && is_array($this->thisConfig['buttons.'][$buttonId . '.'])) {
            if ($this->thisConfig['buttons.'][$buttonId . '.']['removeItems']) {
                $hideItems = $this->thisConfig['buttons.'][$buttonId . '.']['removeItems'];
            }
            if ($this->thisConfig['buttons.'][$buttonId . '.']['addItems']) {
                $addItems = t3lib_div::trimExplode(',', $this->htmlAreaRTE->cleanList($this->thisConfig['buttons.'][$buttonId . '.']['addItems']), 1);
            }
        }
            // Initializing the items array
        $items = array();
        if ($this->htmlAreaRTE->is_FE()) {
            $items['none'] = array($GLOBALS['TSFE']->getLLL((($buttonId == 'fontstyle') ? 'Default font' : 'Default size'), $this->LOCAL_LANG), 'none');
        } else {
            $items['none'] = array(($GLOBALS['LANG']->getLL(($buttonId == 'fontstyle') ? 'Default font' : 'Default size')), 'none');
        }
            // Inserting and localizing default items
        if ($hideItems != '*') {
            $index = 0;
            foreach ($this->defaultFont[$buttonId] as $name => $value) {
                if (!t3lib_div::inList($hideItems, strval($index+1))) {
                    if ($this->htmlAreaRTE->is_FE()) {
                        $label = $GLOBALS['TSFE']->getLLL($name,$this->LOCAL_LANG);
                    } else {
                        $label = $GLOBALS['LANG']->getLL($name);
                        if (!$label) {
                            $label = $name;
                        }
                    }
                    $items[$name] = array($label, $this->htmlAreaRTE->cleanList($value));
                }
                $index++;
            }
        }
            // Adding configured items
        if (is_array($this->RTEProperties[($buttonId == 'fontstyle') ? 'fonts.' : 'fontSizes.'])) {
            foreach ($this->RTEProperties[($buttonId == 'fontstyle') ? 'fonts.' : 'fontSizes.'] as $name => $conf) {
                $name = substr($name,0,-1);
                if (in_array($name, $addItems)) {
                    $label = $this->htmlAreaRTE->getPageConfigLabel($conf['name'],0);
                    $items[$name] = array($label, $this->htmlAreaRTE->cleanList($conf['value']));
                }
            }
        }
            // Seting default item
        if ($this->thisConfig['buttons.'][$buttonId . '.']['defaultItem'] && $items[$this->thisConfig['buttons.'][$buttonId . '.']['defaultItem']]) {
            $items['none'] = array($items[$this->thisConfig['buttons.'][$buttonId . '.']['defaultItem']][0], 'none');
            unset($items[$this->thisConfig['buttons.'][$buttonId . '.']['defaultItem']]);
        }
            // Setting the JS list of options
        $itemsJSArray = array();
        foreach ($items as $name => $option) {
            $itemsJSArray[] = array('text' => $option[0], 'value' => $option[1]);
        }
        if ($this->htmlAreaRTE->is_FE()) {
            $GLOBALS['TSFE']->csConvObj->convArray($itemsJSArray, $this->htmlAreaRTE->OutputCharset, 'utf-8');
        } else {
            $GLOBALS['LANG']->csConvObj->convArray($itemsJSArray, $GLOBALS['LANG']->charSet, 'utf-8');
        }
        $itemsJSArray = json_encode(array('options' => $itemsJSArray));
            // Adding to button JS configuration
        if (!is_array( $this->thisConfig['buttons.']) || !is_array($this->thisConfig['buttons.'][$buttonId . '.'])) {
            $configureRTEInJavascriptString .= '
            RTEarea['.$RTEcounter.'].buttons.'. $buttonId .' = new Object();';
        }
        $configureRTEInJavascriptString .= '
            RTEarea['.$RTEcounter.'].buttons.'. $buttonId . '.dataUrl = \'' . $this->htmlAreaRTE->writeTemporaryFile('', $buttonId . '_'. $this->htmlAreaRTE->contentLanguageUid, 'js', $itemsJSArray) . '\';';
        return $configureRTEInJavascriptString;
    }
}
if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/SelectFont/class.tx_rtehtmlarea_selectfont.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/SelectFont/class.tx_rtehtmlarea_selectfont.php']);
}
?>