class.t3lib_rteapi.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  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.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  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!
***************************************************************/
class t3lib_rteapi {

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

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








   /***********************************
    *
    * 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!
    *
    **********************************/

   function isAvailable()  {
      global $CLIENT;

      $this->errorLog = array();
      if (!$CLIENT['FORMSTYLE'])    $this->errorLog[] = 'RTE API: Browser didn\'t support styles';

      if (!count($this->errorLog))  return TRUE;
   }

   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;">'.
         t3lib_div::formatForTextarea($value).
         '</textarea>';

         // Return form item:
      return $item;
   }

   function transformContent($dirRTE,$value,$table,$field,$row,$specConf,$thisConfig,$RTErelPath,$pid)   {

#debug(array($dirRTE,$value,$table,$field,array(),$specConf,$thisConfig,$RTErelPath,$pid));

      if ($specConf['rte_transform'])  {
         $p = t3lib_BEfunc::getSpecConfParametersFromArray($specConf['rte_transform']['parameters']);
         if ($p['mode'])   {  // There must be a mode set for transformation
#debug($p['mode'],'MODE');

               // Initialize transformation:
            $parseHTML = t3lib_div::makeInstance('t3lib_parsehtml_proc');
            $parseHTML->init($table.':'.$field, $pid);
            $parseHTML->setRelPath($RTErelPath);

               // Perform transformation:
            $value = $parseHTML->RTE_transform($value, $specConf, $dirRTE, $thisConfig);
         }
      }

#debug(array($dirRTE,$value),'OUT: '.$dirRTE);
      return $value;
   }












   /***********************************
    *
    * Helper functions
    *
    **********************************/

   function triggerField($fieldName)   {

      $triggerFieldName = ereg_replace('\[([^]]+)\]$','[_TRANSFORM_\1]', $fieldName);
      return '<input type="hidden" name="'.htmlspecialchars($triggerFieldName).'" value="RTE" />';
   }
}

// Include extension?
if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rte/class.tx_rte_base.php']) {
   include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rte/class.tx_rte_base.php']);
}
?>

---