AbstractRte.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\Rte;

use TYPO3\CMS\Core\Utility\GeneralUtility;

class AbstractRte {

    // Internal, dynamic:
    // Error messages regarding non-availability is collected here.
    public $errorLog = array();

    // Internal, static:
    // Set this to the extension key of the RTE so it can identify itself.
    public $ID = '';

    /***********************************
     *
     * Main API functions;
     * When you create alternative RTEs, simply override these functions in your parent class.
     * See the "rte" or "rtehtmlarea" extension as an example!
     *
     **********************************/
    public function isAvailable() {
        return TRUE;
    }

    public function drawRTE(&$pObj, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue) {
        // Transform value:
        $value = $this->transformContent('rte', $PA['itemFormElValue'], $table, $field, $row, $specConf, $thisConfig, $RTErelPath, $thePidValue);
        // Create item:
        $item = '
            ' . $this->triggerField($PA['itemFormElName']) . '
            <textarea name="' . htmlspecialchars($PA['itemFormElName']) . '"' . $pObj->formWidthText('48', 'off') . ' rows="20" wrap="off" style="background-color: #99eebb;">' . GeneralUtility::formatForTextarea($value) . '</textarea>';
        // Return form item:
        return $item;
    }

    public function transformContent($dirRTE, $value, $table, $field, $row, $specConf, $thisConfig, $RTErelPath, $pid) {
        if ($specConf['rte_transform']) {
            $p = \TYPO3\CMS\Backend\Utility\BackendUtility::getSpecConfParametersFromArray($specConf['rte_transform']['parameters']);
            // There must be a mode set for transformation
            if ($p['mode']) {
                // Initialize transformation:
                $parseHTML = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Html\\RteHtmlParser');
                $parseHTML->init($table . ':' . $field, $pid);
                $parseHTML->setRelPath($RTErelPath);
                // Perform transformation:
                $value = $parseHTML->RTE_transform($value, $specConf, $dirRTE, $thisConfig);
            }
        }
        return $value;
    }

    /***********************************
     *
     * Helper functions
     *
     **********************************/
    public function triggerField($fieldName) {
        $triggerFieldName = preg_replace('/\\[([^]]+)\\]$/', '[_TRANSFORM_\\1]', $fieldName);
        return '<input type="hidden" name="' . htmlspecialchars($triggerFieldName) . '" value="RTE" />';
    }

}