Added feature #13953: Hookrequest - t3lib_page::getRecordOverlay (thanks to Tolleiv...
[Packages/TYPO3.CMS.git] / 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 .= t3lib_div::wrapJS('
173 function uFormUrl(aname) {
174 document.' . $this->ext_CEformName . '.action = "' . t3lib_div::linkThisScript() . '#"+aname;
175 }
176 ');
177 $content .= '<form action="' . htmlspecialchars($script ? $script : t3lib_div::linkThisScript()) . '" name="' . $this->ext_CEformName . '" method="post" enctype="' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['form_enctype'] . '">';
178 $content.= $addFields;
179 $content.= $printFields;
180 $content.= '<input type="Submit" name="submit" value="Update" />';
181
182 $example = $this->ext_displayExample();
183 $content.= $example?'<hr/>'.$example:"";
184
185 return $content;
186 }
187
188 /**
189 * [Describe function...]
190 *
191 * @return [type] ...
192 */
193 function ext_displayExample() {
194 global $SOBE,$tmpl;
195 if ($this->helpConfig["imagetag"] || $this->helpConfig["description"] || $this->helpConfig["header"]) {
196 $out = '<div align="center">'.$this->helpConfig["imagetag"].'</div><BR>'.
197 ($this->helpConfig["description"] ? implode(explode("//",$this->helpConfig["description"]),"<BR>")."<BR>" : "").
198 ($this->helpConfig["bulletlist"] ? "<ul><li>".implode(explode("//",$this->helpConfig["bulletlist"]),"<li>")."</ul>" : "<BR>");
199 }
200 return $out;
201 }
202
203 /**
204 * [Describe function...]
205 *
206 * @param [type] $arr: ...
207 * @return [type] ...
208 */
209 function ext_mergeIncomingWithExisting($arr) {
210 $parseObj = t3lib_div::makeInstance("t3lib_TSparser");
211 $parseObj->parse(implode(chr(10),$this->ext_incomingValues));
212 $arr2 = $parseObj->setup;
213 return t3lib_div::array_merge_recursive_overrule($arr,$arr2);
214 }
215
216 // extends:
217 function ext_getKeyImage($key) {
218 return '<img'.t3lib_iconWorks::skinImg($this->ext_backPath,'gfx/rednumbers/'.$key.'.gif','').' hspace="2" align="top" alt="" />';
219 }
220
221 /**
222 * [Describe function...]
223 *
224 * @param [type] $imgConf: ...
225 * @return [type] ...
226 */
227 function ext_getTSCE_config_image($imgConf) {
228 $iFile=$this->ext_localGfxPrefix.$imgConf;
229 $tFile=$this->ext_localWebGfxPrefix.$imgConf;
230 $imageInfo=@getImagesize($iFile);
231 return '<img src="'.$tFile.'" '.$imageInfo[3].'>';
232 }
233
234 /**
235 * [Describe function...]
236 *
237 * @param [type] $params: ...
238 * @return [type] ...
239 */
240 function ext_fNandV($params) {
241 $fN='data['.$params["name"].']';
242 $fV=$params["value"]=isset($this->ext_realValues[$params["name"]]) ? $this->ext_realValues[$params["name"]] : $params["default_value"];
243 $reg = array();
244 if (preg_match('/^\{[\$][a-zA-Z0-9\.]*\}$/',trim($fV),$reg)) { // Values entered from the constantsedit cannot be constants!
245 $fV="";
246 }
247 $fV=htmlspecialchars($fV);
248
249 return array($fN,$fV,$params);
250 }
251
252 /**
253 * [Describe function...]
254 *
255 * @param [type] $absPath: ...
256 * @return [type] ...
257 */
258 function ext_loadResources($absPath) {
259 $this->ext_readDirResources($GLOBALS["TYPO3_CONF_VARS"]["MODS"]["web_ts"]["onlineResourceDir"]);
260 if (is_dir($absPath)) {
261 $absPath = rtrim($absPath, '/');
262 $this->readDirectory($absPath);
263 }
264 $this->ext_resourceDims();
265 }
266
267 /**
268 * [Describe function...]
269 *
270 * @param [type] $key: ...
271 * @param [type] $var: ...
272 * @return [type] ...
273 */
274 function ext_putValueInConf($key, $var) {
275 $this->ext_incomingValues[$key]=$key."=".$var;
276 }
277
278 /**
279 * [Describe function...]
280 *
281 * @param [type] $key: ...
282 * @return [type] ...
283 */
284 function ext_removeValueInConf($key) {
285 // Nothing...
286 }
287 }
288
289
290 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsstyleconfig.php']) {
291 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsstyleconfig.php']);
292 }
293 ?>