RteHtmlAreaApi.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Rtehtmlarea;

abstract class RteHtmlAreaApi {

    protected $extensionKey;

    // The key of the extension that is extending htmlArea RTE
    protected $pluginName;

    // The name of the plugin registered by the extension
    protected $relativePathToLocallangFile;

    // Path to the localization file for this script, relative to the extension dir
    protected $relativePathToSkin;

    // Path to the skin (css) file that should be added to the RTE skin when the registered plugin is enabled, relative to the extension dir
    protected $relativePathToPluginDirectory;

    // Path to the directory containing the plugin, relative to the extension dir (should end with slash /)
    protected $htmlAreaRTE;

    // Reference to the invoking object
    protected $rteExtensionKey;

    // The extension key of the RTE
    protected $thisConfig;

    // Reference to RTE PageTSConfig
    protected $toolbar;

    // Refrence to RTE toolbar array
    protected $LOCAL_LANG;

    // Frontend language array
    protected $pluginButtons = '';

    // The comma-separated list of button names that the registered plugin is adding to the htmlArea RTE toolbar
    protected $pluginLabels = '';

    // The comma-separated list of label names that the registered plugin is adding to the htmlArea RTE toolbar
    protected $pluginAddsButtons = TRUE;

    // Boolean indicating whether the plugin is adding buttons or not
    protected $convertToolbarForHtmlAreaArray = array();

    // The name-converting array, converting the button names used in the RTE PageTSConfing to the button id's used by the JS scripts
    protected $requiresClassesConfiguration = FALSE;

    // TRUE if the registered plugin requires the PageTSConfig Classes configuration
    protected $requiresSynchronousLoad = FALSE;

    // TRUE if the plugin must be loaded synchronously
    protected $requiredPlugins = '';

    // The comma-separated list of names of prerequisite plugins
    public function main($parentObject) {
        global $TYPO3_CONF_VARS, $LANG, $TSFE;
        $this->htmlAreaRTE = $parentObject;
        $this->rteExtensionKey = &$this->htmlAreaRTE->ID;
        $this->thisConfig = &$this->htmlAreaRTE->thisConfig;
        $this->toolbar = &$this->htmlAreaRTE->toolbar;
        $this->LOCAL_LANG = &$this->htmlAreaRTE->LOCAL_LANG;
        // Set the value of this boolean based on the initial value of $this->pluginButtons
        $this->pluginAddsButtons = !empty($this->pluginButtons);
        // Check if the plugin should be disabled in frontend
        if ($this->htmlAreaRTE->is_FE() && $TYPO3_CONF_VARS['EXTCONF'][$this->rteExtensionKey]['plugins'][$this->pluginName]['disableInFE']) {
            return FALSE;
        }
        // Localization array must be initialized here
        if ($this->relativePathToLocallangFile) {
            if ($this->htmlAreaRTE->is_FE()) {
                \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule(
                    $this->LOCAL_LANG,
                    \TYPO3\CMS\Core\Utility\GeneralUtility::readLLfile(
                        'EXT:' . $this->extensionKey . '/' . $this->relativePathToLocallangFile,
                        $this->htmlAreaRTE->language
                    )
                );
            } else {
                $LANG->includeLLFile('EXT:' . $this->extensionKey . '/' . $this->relativePathToLocallangFile);
            }
        }
        return TRUE;
    }

    public function addButtonsToToolbar() {
        //Add only buttons not yet in the default toolbar order
        $addButtons = implode(',', array_diff(\TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->pluginButtons, TRUE), \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->htmlAreaRTE->defaultToolbarOrder, TRUE)));
        return ($addButtons ? 'bar,' . $addButtons . ',linebreak,' : '') . $this->htmlAreaRTE->defaultToolbarOrder;
    }

    public function getPathToSkin() {
        global $TYPO3_CONF_VARS;
        if ($TYPO3_CONF_VARS['EXTCONF'][$this->rteExtensionKey]['plugins'][$this->pluginName]['addIconsToSkin']) {
            return $this->relativePathToSkin;
        } else {
            return '';
        }
    }

    public function buildJavascriptConfiguration($RTEcounter) {
        global $TSFE, $LANG;
        $registerRTEinJavascriptString = '';
        $pluginButtons = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->pluginButtons, TRUE);
        foreach ($pluginButtons as $button) {
            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();';
                }
            }
        }
        return $registerRTEinJavascriptString;
    }

    public function getExtensionKey() {
        return $this->extensionKey;
    }

    public function getPathToPluginDirectory() {
        return $this->relativePathToPluginDirectory ? $this->htmlAreaRTE->httpTypo3Path . \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath($this->extensionKey) . $this->relativePathToPluginDirectory : '';
    }

    public function addsButtons() {
        return $this->pluginAddsButtons;
    }

    public function getPluginButtons() {
        return $this->pluginButtons;
    }

    public function getPluginLabels() {
        return $this->pluginLabels;
    }

    public function getConvertToolbarForHtmlAreaArray() {
        return $this->convertToolbarForHtmlAreaArray;
    }

    public function requiresClassesConfiguration() {
        return $this->requiresClassesConfiguration;
    }

    public function requiresSynchronousLoad() {
        return $this->requiresSynchronousLoad;
    }

    public function setSynchronousLoad($value = TRUE) {
        $this->requiresSynchronousLoad = $value;
    }

    public function getRequiredPlugins() {
        return $this->requiredPlugins;
    }

}