Fixed bug #11937: Do not show E_DEPRECATED messages on productive systems
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_scbase.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 * Contains the parent class for 'ScriptClasses' in backend modules.
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 133: class t3lib_SCbase
41 * 249: function init()
42 * 269: function menuConfig()
43 * 292: function mergeExternalItems($modName,$menuKey,$menuArr)
44 * 317: function handleExternalFunctionValue($MM_key='function', $MS_value=NULL)
45 * 335: function getExternalItemConfig($modName,$menuKey,$value='')
46 * 349: function checkExtObj()
47 * 363: function checkSubExtObj()
48 * 375: function extObjHeader()
49 * 384: function extObjContent()
50 *
51 * TOTAL FUNCTIONS: 9
52 * (This index is automatically created/updated by the extension "extdeveval")
53 *
54 */
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70 /**
71 * EXAMPLE PROTOTYPE
72 *
73 * As for examples there are lots of them if you search for classes which extends 't3lib_SCbase'.
74 * However you can see a prototype example of how a module might use this class in an index.php file typically hosting a backend module.
75 * NOTICE: This example only outlines the basic structure of how this class is used. You should consult the documentation and other real-world examples for some actual things to do when building modules.
76 *
77 * // TYPICAL 'HEADER' OF A BACKEND MODULE:
78 * unset($MCONF);
79 * require ('conf.php');
80 * require ($BACK_PATH.'init.php');
81 * require ($BACK_PATH.'template.php');
82 * $LANG->includeLLFile('EXT:prototype/locallang.php');
83 * $BE_USER->modAccess($MCONF,1);
84 *
85 * // SC_mod_prototype EXTENDS THE CLASS t3lib_SCbase with a main() and printContent() function:
86 * class SC_mod_prototype extends t3lib_SCbase {
87 * // MAIN FUNCTION - HERE YOU CREATE THE MODULE CONTENT IN $this->content
88 * function main() {
89 * // TYPICALLY THE INTERNAL VAR, $this->doc is instantiated like this:
90 * $this->doc = t3lib_div::makeInstance('mediumDoc');
91 * // TYPICALLY THE INTERNAL VAR, $this->backPath is set like this:
92 * $this->backPath = $this->doc->backPath = $GLOBALS['BACK_PATH'];
93 * // ... AND OF COURSE A LOT OF OTHER THINGS GOES ON - LIKE PUTTING CONTENT INTO $this->content
94 * $this->content='';
95 * }
96 * // PRINT CONTENT - DONE AS THE LAST THING
97 * function printContent() {
98 * echo $this->content;
99 * }
100 * }
101 *
102 * // CHECKING IF THERE ARE AN EXTENSION CLASS CONFIGURED FOR THIS CLASS:
103 * if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/prototype/index.php']) {
104 * include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/prototype/index.php']);
105 * }
106 *
107 * // MAKE INSTANCE OF THE SCRIPT CLASS AND CALL init()
108 * $SOBE = t3lib_div::makeInstance('SC_mod_prototype');
109 * $SOBE->init();
110 *
111 * // AFTER INIT THE INTERNAL ARRAY ->include_once MAY HOLD FILENAMES TO INCLUDE
112 * foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
113 *
114 * // THEN WE WILL CHECK IF THERE IS A 'SUBMODULE' REGISTERED TO BE INITIALIZED AS WELL:
115 * $SOBE->checkExtObj();
116 *
117 * // THEN WE CALL THE main() METHOD AND THIS SHOULD SPARK THE CREATION OF THE MODULE OUTPUT.
118 * $SOBE->main();
119 * // FINALLY THE printContent() FUNCTION WILL OUTPUT THE ACCUMULATED CONTENT
120 * $SOBE->printContent();
121 */
122
123 /**
124 * Parent class for 'ScriptClasses' in backend modules.
125 * See example comment above.
126 *
127 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
128 * @package TYPO3
129 * @subpackage t3lib
130 * @see t3lib_extobjbase
131 */
132 class t3lib_SCbase {
133
134 /**
135 * Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.
136 * @see init()
137 */
138 var $MCONF = array();
139
140 /**
141 * The integer value of the GET/POST var, 'id'. Used for submodules to the 'Web' module (page id)
142 * @see init()
143 */
144 var $id;
145
146 /**
147 * The value of GET/POST var, 'CMD'
148 * @see init()
149 */
150 var $CMD;
151
152 /**
153 * A WHERE clause for selection records from the pages table based on read-permissions of the current backend user.
154 * @see init()
155 */
156 var $perms_clause;
157
158
159
160 /**
161 * The module menu items array. Each key represents a key for which values can range between the items in the array of that key.
162 * @see init()
163 */
164 var $MOD_MENU = Array (
165 'function' => array()
166 );
167
168 /**
169 * Current settings for the keys of the MOD_MENU array
170 * @see $MOD_MENU
171 */
172 var $MOD_SETTINGS = array();
173
174 /**
175 * Module TSconfig based on PAGE TSconfig / USER TSconfig
176 * @see menuConfig()
177 */
178 var $modTSconfig;
179
180 /**
181 * If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in.
182 * Can be set from extension classes of this class before the init() function is called.
183 *
184 * @see menuConfig(), t3lib_BEfunc::getModuleData()
185 */
186 var $modMenu_type = '';
187
188 /**
189 * dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus.
190 * Can be set from extension classes of this class before the init() function is called.
191 *
192 * @see menuConfig(), t3lib_BEfunc::getModuleData()
193 */
194 var $modMenu_dontValidateList = '';
195
196 /**
197 * List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)
198 * Can be set from extension classes of this class before the init() function is called.
199 *
200 * @see menuConfig(), t3lib_BEfunc::getModuleData()
201 */
202 var $modMenu_setDefaultList = '';
203
204 /**
205 * Contains module configuration parts from TBE_MODULES_EXT if found
206 *
207 * @see handleExternalFunctionValue()
208 */
209 var $extClassConf;
210
211 /**
212 * Contains absolute paths to class files to include from the global scope. This is done in the module index.php files after calling the init() function
213 *
214 * @see handleExternalFunctionValue()
215 */
216 var $include_once = array();
217
218 /**
219 * Generally used for accumulating the output content of backend modules
220 */
221 var $content = '';
222
223 /**
224 * Generally used to hold an instance of the 'template' class from typo3/template.php
225 *
226 * @var template
227 */
228 var $doc;
229
230 /**
231 * May contain an instance of a 'Function menu module' which connects to this backend module.
232 *
233 * @see checkExtObj()
234 */
235 var $extObj;
236
237
238
239
240
241
242
243
244 /**
245 * Initializes the backend module by setting internal variables, initializing the menu.
246 *
247 * @return void
248 * @see menuConfig()
249 */
250 function init() {
251 // name might be set from outside
252 if (!$this->MCONF['name']) {
253 $this->MCONF = $GLOBALS['MCONF'];
254 }
255 $this->id = intval(t3lib_div::_GP('id'));
256 $this->CMD = t3lib_div::_GP('CMD');
257 $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
258 $this->menuConfig();
259 $this->handleExternalFunctionValue();
260 }
261
262 /**
263 * Initializes the internal MOD_MENU array setting and unsetting items based on various conditions. It also merges in external menu items from the global array TBE_MODULES_EXT (see mergeExternalItems())
264 * Then MOD_SETTINGS array is cleaned up (see t3lib_BEfunc::getModuleData()) so it contains only valid values. It's also updated with any SET[] values submitted.
265 * Also loads the modTSconfig internal variable.
266 *
267 * @return void
268 * @see init(), $MOD_MENU, $MOD_SETTINGS, t3lib_BEfunc::getModuleData(), mergeExternalItems()
269 */
270 function menuConfig() {
271 // page/be_user TSconfig settings and blinding of menu-items
272 $this->modTSconfig = t3lib_BEfunc::getModTSconfig($this->id,'mod.'.$this->MCONF['name']);
273 $this->MOD_MENU['function'] = $this->mergeExternalItems($this->MCONF['name'],'function',$this->MOD_MENU['function']);
274 $this->MOD_MENU['function'] = t3lib_BEfunc::unsetMenuItems($this->modTSconfig['properties'],$this->MOD_MENU['function'],'menu.function');
275
276 #debug($this->MOD_MENU['function'],$this->MCONF['name']);
277 #debug($this->modTSconfig['properties']);
278
279 $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->MOD_MENU, t3lib_div::_GP('SET'), $this->MCONF['name'], $this->modMenu_type, $this->modMenu_dontValidateList, $this->modMenu_setDefaultList);
280 }
281
282 /**
283 * Merges menu items from global array $TBE_MODULES_EXT
284 *
285 * @param string Module name for which to find value
286 * @param string Menu key, eg. 'function' for the function menu.
287 * @param array The part of a MOD_MENU array to work on.
288 * @return array Modified array part.
289 * @access private
290 * @see t3lib_extMgm::insertModuleFunction(), menuConfig()
291 */
292 function mergeExternalItems($modName,$menuKey,$menuArr) {
293 $mergeArray = $GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];
294 if (is_array($mergeArray)) {
295 reset($mergeArray);
296 while(list($k,$v)=each($mergeArray)) {
297 if ((string)$v['ws']==='' ||
298 ($GLOBALS['BE_USER']->workspace===0 && t3lib_div::inList($v['ws'],'online')) ||
299 ($GLOBALS['BE_USER']->workspace===-1 && t3lib_div::inList($v['ws'],'offline')) ||
300 ($GLOBALS['BE_USER']->workspace>0 && t3lib_div::inList($v['ws'],'custom'))) {
301 $menuArr[$k]=$GLOBALS['LANG']->sL($v['title']);
302 }
303 }
304 }
305 return $menuArr;
306 }
307
308 /**
309 * Loads $this->extClassConf with the configuration for the CURRENT function of the menu.
310 * If for this array the key 'path' is set then that is expected to be an absolute path to a file which should be included - so it is set in the internal array $this->include_once
311 *
312 * @param string The key to MOD_MENU for which to fetch configuration. 'function' is default since it is first and foremost used to get information per "extension object" (I think that is what its called)
313 * @param string The value-key to fetch from the config array. If NULL (default) MOD_SETTINGS[$MM_key] will be used. This is usefull if you want to force another function than the one defined in MOD_SETTINGS[function]. Call this in init() function of your Script Class: handleExternalFunctionValue('function', $forcedSubModKey)
314 * @return void
315 * @see getExternalItemConfig(), $include_once, init()
316 */
317 function handleExternalFunctionValue($MM_key='function', $MS_value=NULL) {
318 $MS_value = is_null($MS_value) ? $this->MOD_SETTINGS[$MM_key] : $MS_value;
319 $this->extClassConf = $this->getExternalItemConfig($this->MCONF['name'],$MM_key,$MS_value);
320 if (is_array($this->extClassConf) && $this->extClassConf['path']) {
321 $this->include_once[]=$this->extClassConf['path'];
322 }
323 }
324
325 /**
326 * Returns configuration values from the global variable $TBE_MODULES_EXT for the module given.
327 * For example if the module is named "web_info" and the "function" key ($menuKey) of MOD_SETTINGS is "stat" ($value) then you will have the values of $TBE_MODULES_EXT['webinfo']['MOD_MENU']['function']['stat'] returned.
328 *
329 * @param string Module name
330 * @param string Menu key, eg. "function" for the function menu. See $this->MOD_MENU
331 * @param string Optionally the value-key to fetch from the array that would otherwise have been returned if this value was not set. Look source...
332 * @return mixed The value from the TBE_MODULES_EXT array.
333 * @see handleExternalFunctionValue()
334 */
335 function getExternalItemConfig($modName,$menuKey,$value='') {
336 return strcmp($value,'')?$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey][$value]:$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];
337 }
338
339 /**
340 * Creates an instance of the class found in $this->extClassConf['name'] in $this->extObj if any (this should hold three keys, "name", "path" and "title" if a "Function menu module" tries to connect...)
341 * This value in extClassConf might be set by an extension (in a ext_tables/ext_localconf file) which thus "connects" to a module.
342 * The array $this->extClassConf is set in handleExternalFunctionValue() based on the value of MOD_SETTINGS[function]
343 * (Should be) called from global scope right after inclusion of files from the ->include_once array.
344 * If an instance is created it is initiated with $this passed as value and $this->extClassConf as second argument. Further the $this->MOD_SETTING is cleaned up again after calling the init function.
345 *
346 * @return void
347 * @see handleExternalFunctionValue(), t3lib_extMgm::insertModuleFunction(), $extObj
348 */
349 function checkExtObj() {
350 if (is_array($this->extClassConf) && $this->extClassConf['name']) {
351 $this->extObj = t3lib_div::makeInstance($this->extClassConf['name']);
352 $this->extObj->init($this,$this->extClassConf);
353 // Re-write:
354 $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->MOD_MENU, t3lib_div::_GP('SET'), $this->MCONF['name'], $this->modMenu_type, $this->modMenu_dontValidateList, $this->modMenu_setDefaultList);
355 }
356 }
357
358 /**
359 * Calls the checkExtObj function in sub module if present.
360 *
361 * @return void
362 */
363 function checkSubExtObj() {
364 if (is_object($this->extObj)) $this->extObj->checkExtObj();
365 }
366
367 /**
368 * Calls the 'header' function inside the "Function menu module" if present.
369 * A header function might be needed to add JavaScript or other stuff in the head. This can't be done in the main function because the head is already written.
370 * example call in the header function:
371 * $this->pObj->doc->JScode = $this->pObj->doc->wrapScriptTags(' ...
372 *
373 * @return void
374 */
375 function extObjHeader() {
376 if (is_callable(array($this->extObj,'head'))) $this->extObj->head();
377 }
378
379 /**
380 * Calls the 'main' function inside the "Function menu module" if present
381 *
382 * @return void
383 */
384 function extObjContent() {
385 $this->extObj->pObj = $this;
386
387 if (is_callable(array($this->extObj, 'main'))) {
388 $this->content .= $this->extObj->main();
389 }
390 }
391 }
392
393 ?>