t3lib/class.t3lib_tsstyleconfig.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
   6 *  All rights reserved
   7 *
   8 *  This script is part of the TYPO3 project. The TYPO3 project is
   9 *  free software; you can redistribute it and/or modify
  10 *  it under the terms of the GNU General Public License as published by
  11 *  the Free Software Foundation; either version 2 of the License, or
  12 *  (at your option) any later version.
  13 *
  14 *  The GNU General Public License can be found at
  15 *  http://www.gnu.org/copyleft/gpl.html.
  16 *  A copy is found in the textfile GPL.txt and important notices to the license
  17 *  from the author is found in LICENSE.txt distributed with these scripts.
  18 *
  19 *
  20 *  This script is distributed in the hope that it will be useful,
  21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 *  GNU General Public License for more details.
  24 *
  25 *  This copyright notice MUST APPEAR in all copies of the script!
  26 ***************************************************************/
  27 /**
  28  * Provides a simplified layer for making Constant Editor style configuration forms
  29  *
  30  * $Id$
  31  *
  32  * @author      Kasper Skaarhoj <kasperYYYY@typo3.com>
  33  */
  34 /**
  35  * [CLASS/FUNCTION INDEX of SCRIPT]
  36  *
  37  *
  38  *
  39  *   79: class t3lib_tsStyleConfig extends t3lib_tsparser_ext
  40  *   98:     function ext_initTSstyleConfig($configTemplate,$pathRel,$pathAbs,$backPath)
  41  *  118:     function ext_setValueArray($theConstants,$valueArray)
  42  *  145:     function ext_getCategoriesForModMenu()
  43  *  155:     function ext_makeHelpInformationForCategory($cat)
  44  *  168:     function ext_getForm($cat,$theConstants,$script="",$addFields="")
  45  *  175:     function uFormUrl(aname)
  46  *  197:     function ext_displayExample()
  47  *  213:     function ext_mergeIncomingWithExisting($arr)
  48  *  221:     function ext_getKeyImage($key)
  49  *  231:     function ext_getTSCE_config_image($imgConf)
  50  *  244:     function ext_fNandV($params)
  51  *  262:     function ext_loadResources($absPath)
  52  *  278:     function ext_putValueInConf($key, $var)
  53  *  288:     function ext_removeValueInConf($key)
  54  *
  55  * TOTAL FUNCTIONS: 14
  56  * (This index is automatically created/updated by the extension "extdeveval")
  57  *
  58  */
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71 /**
  72  * Provides a simplified layer for making Constant Editor style configuration forms
  73  *
  74  * @author      Kasper Skaarhoj <kasperYYYY@typo3.com>
  75  * @package TYPO3
  76  * @subpackage t3lib
  77  */
  78 class t3lib_tsStyleConfig extends t3lib_tsparser_ext    {
  79                 // internal
  80         var $categories = array();
  81         var $ext_dontCheckIssetValues=1;
  82         var $ext_CEformName="tsStyleConfigForm";
  83         var $ext_noCEUploadAndCopying=1;
  84         var $ext_printAll=1;
  85         var $ext_defaultOnlineResourceFlag=1;
  86
  87         var $ext_incomingValues = array();
  88
  89
  90         /**
  91          * @param       string          pathRel is the path relative to the typo3/ directory
  92          * @param       string          pathAbs is the absolute path from root
  93          * @param       string          backPath is the backReference from current position to typo3/ dir
  94          * @param       [type]          $backPath: ...
  95          * @return      [type]          ...
  96          */
  97         function ext_initTSstyleConfig($configTemplate,$pathRel,$pathAbs,$backPath)     {
  98                 $this->tt_track = 0;    // Do not log time-performance information
  99                 $this->constants=array($configTemplate,"");
 100
 101                 $theConstants = $this->generateConfig_constants();      // The editable constants are returned in an array.
 102
 103                 $this->ext_localGfxPrefix=$pathAbs;
 104                 $this->ext_localWebGfxPrefix=$backPath.$pathRel;
 105                 $this->ext_backPath = $backPath;
 106
 107                 return $theConstants;
 108         }
 109
 110         /**
 111          * [Describe function...]
 112          *
 113          * @param       [type]          $theConstants: ...
 114          * @param       [type]          $valueArray: ...
 115          * @return      [type]          ...
 116          */
 117         function ext_setValueArray($theConstants,$valueArray)   {
 118
 119                 $temp = $this->flatSetup;
 120                 $this->flatSetup = Array();
 121                 $this->flattenSetup($valueArray,"","");
 122                 $this->objReg = $this->ext_realValues = $this->flatSetup;
 123                 $this->flatSetup = $temp;
 124
 125
 126                 reset($theConstants);
 127                 while(list($k,$p)=each($theConstants))  {
 128                         if (isset($this->objReg[$k]))   {
 129                                 $theConstants[$k]["value"] = $this->ext_realValues[$k];
 130                         }
 131                 }
 132
 133                 $this->categories=array(); // Reset the default pool of categories.
 134                 $this->ext_categorizeEditableConstants($theConstants);  // The returned constants are sorted in categories, that goes into the $this->categories array
 135
 136                 return $theConstants;
 137         }
 138
 139         /**
 140          * [Describe function...]
 141          *
 142          * @return      [type]          ...
 143          */
 144         function ext_getCategoriesForModMenu()  {
 145                 return $this->ext_getCategoryLabelArray();
 146         }
 147
 148         /**
 149          * [Describe function...]
 150          *
 151          * @param       [type]          $cat: ...
 152          * @return      [type]          ...
 153          */
 154         function ext_makeHelpInformationForCategory($cat)       {
 155                 return $this->ext_getTSCE_config($cat);
 156         }
 157
 158         /**
 159          * [Describe function...]
 160          *
 161          * @param       [type]          $cat: ...
 162          * @param       [type]          $theConstants: ...
 163          * @param       [type]          $script: ...
 164          * @param       [type]          $addFields: ...
 165          * @return      [type]          ...
 166          */
 167         function ext_getForm($cat,$theConstants,$script="",$addFields="")       {
 168                 $this->ext_makeHelpInformationForCategory($cat);
 169                 $printFields = trim($this->ext_printFields($theConstants,$cat));
 170
 171                 $content='';
 172                 $content.='
 173                 <script language="javascript" type="text/javascript">
 174                         function uFormUrl(aname)        {
 175                                 document.'.$this->ext_CEformName.'.action = "'.t3lib_div::linkThisScript().'#"+aname;
 176                         }
 177                 </script>
 178                 ';
 179                 $content .= '<form action="' . ($script ? $script : t3lib_div::linkThisScript()) . '" name="' . $this->ext_CEformName . '" method="post" enctype="' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['form_enctype'] . '">';
 180                 $content.= $addFields;
 181 #               $content.= '<input type="Submit" name="submit" value="Update"><BR>';
 182                 $content.= $printFields;
 183                 $content.= '<input type="Submit" name="submit" value="Update">';
 184
 185                 $example = $this->ext_displayExample();
 186                 $content.= $example?'<HR>'.$example:"";
 187
 188                 return $content;
 189         }
 190
 191         /**
 192          * [Describe function...]
 193          *
 194          * @return      [type]          ...
 195          */
 196         function ext_displayExample()   {
 197                 global $SOBE,$tmpl;
 198                 if ($this->helpConfig["imagetag"] || $this->helpConfig["description"] || $this->helpConfig["header"])   {
 199                         $out = '<div align="center">'.$this->helpConfig["imagetag"].'</div><BR>'.
 200                                 ($this->helpConfig["description"] ? implode(explode("//",$this->helpConfig["description"]),"<BR>")."<BR>" : "").
 201                                 ($this->helpConfig["bulletlist"] ? "<ul><li>".implode(explode("//",$this->helpConfig["bulletlist"]),"<li>")."</ul>" : "<BR>");
 202                 }
 203                 return $out;
 204         }
 205
 206         /**
 207          * [Describe function...]
 208          *
 209          * @param       [type]          $arr: ...
 210          * @return      [type]          ...
 211          */
 212         function ext_mergeIncomingWithExisting($arr)    {
 213                 $parseObj = t3lib_div::makeInstance("t3lib_TSparser");
 214                 $parseObj->parse(implode(chr(10),$this->ext_incomingValues));
 215                 $arr2 = $parseObj->setup;
 216                 return t3lib_div::array_merge_recursive_overrule($arr,$arr2);
 217         }
 218
 219                 // extends:
 220         function ext_getKeyImage($key)  {
 221                 return '<img'.t3lib_iconWorks::skinImg($this->ext_backPath,'gfx/rednumbers/'.$key.'.gif','').' hspace="2" align="top" alt="" />';
 222         }
 223
 224         /**
 225          * [Describe function...]
 226          *
 227          * @param       [type]          $imgConf: ...
 228          * @return      [type]          ...
 229          */
 230         function ext_getTSCE_config_image($imgConf)     {
 231                 $iFile=$this->ext_localGfxPrefix.$imgConf;
 232                 $tFile=$this->ext_localWebGfxPrefix.$imgConf;
 233                 $imageInfo=@getImagesize($iFile);
 234                 return '<img src="'.$tFile.'" '.$imageInfo[3].'>';
 235         }
 236
 237         /**
 238          * [Describe function...]
 239          *
 240          * @param       [type]          $params: ...
 241          * @return      [type]          ...
 242          */
 243         function ext_fNandV($params)    {
 244                 $fN='data['.$params["name"].']';
 245                 $fV=$params["value"]=isset($this->ext_realValues[$params["name"]]) ? $this->ext_realValues[$params["name"]] : $params["default_value"];
 246                 $reg = array();
 247                 if (preg_match('/^\{[\$][a-zA-Z0-9\.]*\}$/',trim($fV),$reg))    {               // Values entered from the constantsedit cannot be constants!
 248                         $fV="";
 249                 }
 250                 $fV=htmlspecialchars($fV);
 251
 252                 return array($fN,$fV,$params);
 253         }
 254
 255         /**
 256          * [Describe function...]
 257          *
 258          * @param       [type]          $absPath: ...
 259          * @return      [type]          ...
 260          */
 261         function ext_loadResources($absPath)    {
 262                 $this->ext_readDirResources($GLOBALS["TYPO3_CONF_VARS"]["MODS"]["web_ts"]["onlineResourceDir"]);
 263                 if (is_dir($absPath))   {
 264                         $absPath = rtrim($absPath, '/');
 265                         $this->readDirectory($absPath);
 266                 }
 267                 $this->ext_resourceDims();
 268         }
 269
 270         /**
 271          * [Describe function...]
 272          *
 273          * @param       [type]          $key: ...
 274          * @param       [type]          $var: ...
 275          * @return      [type]          ...
 276          */
 277         function ext_putValueInConf($key, $var) {
 278                 $this->ext_incomingValues[$key]=$key."=".$var;
 279         }
 280
 281         /**
 282          * [Describe function...]
 283          *
 284          * @param       [type]          $key: ...
 285          * @return      [type]          ...
 286          */
 287         function ext_removeValueInConf($key)    {
 288                 // Nothing...
 289         }
 290 }
 291
 292
 293 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsstyleconfig.php'])     {
 294         include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsstyleconfig.php']);
 295 }
 296 ?>