Various
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_scbase.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2004 Kasper Skaarhoj (kasper@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 <kasper@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 133: class t3lib_SCbase
41 * 249: function init()
42 * 266: function menuConfig()
43 * 286: function mergeExternalItems($modName,$menuKey,$menuArr)
44 * 305: function handleExternalFunctionValue($MM_key='function')
45 * 322: function getExternalItemConfig($modName,$menuKey,$value='')
46 * 336: function checkExtObj()
47 * 350: function checkSubExtObj()
48 * 362: function extObjHeader()
49 * 371: 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 * require_once(PATH_t3lib.'class.t3lib_scbase.php'); // NOTICE THE INCLUSION OF t3lib_SCbase
84 * $BE_USER->modAccess($MCONF,1);
85 *
86 * // SC_mod_prototype EXTENDS THE CLASS t3lib_SCbase with a main() and printContent() function:
87 * class SC_mod_prototype extends t3lib_SCbase {
88 * // MAIN FUNCTION - HERE YOU CREATE THE MODULE CONTENT IN $this->content
89 * function main() {
90 * // TYPICALLY THE INTERNAL VAR, $this->doc is instantiated like this:
91 * $this->doc = t3lib_div::makeInstance('mediumDoc');
92 * // TYPICALLY THE INTERNAL VAR, $this->backPath is set like this:
93 * $this->backPath = $this->doc->backPath = $GLOBALS['BACK_PATH'];
94 * // ... AND OF COURSE A LOT OF OTHER THINGS GOES ON - LIKE PUTTING CONTENT INTO $this->content
95 * $this->content='';
96 * }
97 * // PRINT CONTENT - DONE AS THE LAST THING
98 * function printContent() {
99 * echo $this->content;
100 * }
101 * }
102 *
103 * // CHECKING IF THERE ARE AN EXTENSION CLASS CONFIGURED FOR THIS CLASS:
104 * if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/prototype/index.php']) {
105 * include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/prototype/index.php']);
106 * }
107 *
108 * // MAKE INSTANCE OF THE SCRIPT CLASS AND CALL init()
109 * $SOBE = t3lib_div::makeInstance('SC_mod_prototype');
110 * $SOBE->init();
111 *
112 * // AFTER INIT THE INTERNAL ARRAY ->include_once MAY HOLD FILENAMES TO INCLUDE
113 * foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
114 *
115 * // THEN WE WILL CHECK IF THERE IS A 'SUBMODULE' REGISTERED TO BE INITIALIZED AS WELL:
116 * $SOBE->checkExtObj();
117 *
118 * // THEN WE CALL THE main() METHOD AND THIS SHOULD SPARK THE CREATION OF THE MODULE OUTPUT.
119 * $SOBE->main();
120 * // FINALLY THE printContent() FUNCTION WILL OUTPUT THE ACCUMULATED CONTENT
121 * $SOBE->printContent();
122 */
123
124 /**
125 * Parent class for 'ScriptClasses' in backend modules.
126 * See example comment above.
127 *
128 * @author Kasper Skaarhoj <kasper@typo3.com>
129 * @package TYPO3
130 * @subpackage t3lib
131 * @see t3lib_extobjbase
132 */
133 class t3lib_SCbase {
134
135 /**
136 * Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.
137 * @see init()
138 */
139 var $MCONF = array();
140
141 /**
142 * The integer value of the GET/POST var, 'id'. Used for submodules to the 'Web' module (page id)
143 * @see init()
144 */
145 var $id;
146
147 /**
148 * The value of GET/POST var, 'CMD'
149 * @see init()
150 */
151 var $CMD;
152
153 /**
154 * A WHERE clause for selection records from the pages table based on read-permissions of the current backend user.
155 * @see init()
156 */
157 var $perms_clause;
158
159
160
161 /**
162 * The module menu items array. Each key represents a key for which values can range between the items in the array of that key.
163 * @see init()
164 */
165 var $MOD_MENU = Array (
166 'function' => array()
167 );
168
169 /**
170 * Current settings for the keys of the MOD_MENU array
171 * @see $MOD_MENU
172 */
173 var $MOD_SETTINGS = array();
174
175 /**
176 * Module TSconfig based on PAGE TSconfig / USER TSconfig
177 * @see menuConfig()
178 */
179 var $modTSconfig;
180
181 /**
182 * 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.
183 * Can be set from extension classes of this class before the init() function is called.
184 *
185 * @see menuConfig(), t3lib_BEfunc::getModuleData()
186 */
187 var $modMenu_type = '';
188
189 /**
190 * 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.
191 * Can be set from extension classes of this class before the init() function is called.
192 *
193 * @see menuConfig(), t3lib_BEfunc::getModuleData()
194 */
195 var $modMenu_dontValidateList = '';
196
197 /**
198 * List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)
199 * Can be set from extension classes of this class before the init() function is called.
200 *
201 * @see menuConfig(), t3lib_BEfunc::getModuleData()
202 */
203 var $modMenu_setDefaultList = '';
204
205 /**
206 * Contains module configuration parts from TBE_MODULES_EXT if found
207 *
208 * @see handleExternalFunctionValue()
209 */
210 var $extClassConf;
211
212 /**
213 * 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
214 *
215 * @see handleExternalFunctionValue()
216 */
217 var $include_once = array();
218
219 /**
220 * Generally used for accumulating the output content of backend modules
221 */
222 var $content = '';
223
224 /**
225 * Generally used to hold an instance of the 'template' class from typo3/template.php
226 */
227 var $doc;
228
229 /**
230 * May contain an instance of a 'Function menu module' which connects to this backend module.
231 *
232 * @see checkExtObj()
233 */
234 var $extObj;
235
236
237
238
239
240
241
242
243 /**
244 * Initializes the backend module by setting internal variables, initializing the menu.
245 *
246 * @return void
247 * @see menuConfig()
248 */
249 function init() {
250 $this->MCONF = $GLOBALS['MCONF'];
251 $this->id = intval(t3lib_div::_GP('id'));
252 $this->CMD = t3lib_div::_GP('CMD');
253 $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
254 $this->menuConfig();
255 $this->handleExternalFunctionValue();
256 }
257
258 /**
259 * 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())
260 * 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.
261 * Also loads the modTSconfig internal variable.
262 *
263 * @return void
264 * @see init(), $MOD_MENU, $MOD_SETTINGS, t3lib_BEfunc::getModuleData(), mergeExternalItems()
265 */
266 function menuConfig() {
267 // page/be_user TSconfig settings and blinding of menu-items
268 $this->modTSconfig = t3lib_BEfunc::getModTSconfig($this->id,'mod.'.$this->MCONF['name']);
269 $this->MOD_MENU['function'] = $this->mergeExternalItems($this->MCONF['name'],'function',$this->MOD_MENU['function']);
270 $this->MOD_MENU['function'] = t3lib_BEfunc::unsetMenuItems($this->modTSconfig['properties'],$this->MOD_MENU['function'],'menu.function');
271
272 #debug($this->MOD_MENU['function'],$this->MCONF['name']);
273 #debug($this->modTSconfig['properties']);
274
275 // CLEANSE 'function' SETTINGS
276 $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);
277 }
278
279 /**
280 * Merges menu items from global array $TBE_MODULES_EXT
281 *
282 * @param string Module name for which to find value
283 * @param string Menu key, eg. 'function' for the function menu.
284 * @param array The part of a MOD_MENU array to work on.
285 * @return array Modified array part.
286 * @access private
287 * @see t3lib_extMgm::insertModuleFunction(), menuConfig()
288 */
289 function mergeExternalItems($modName,$menuKey,$menuArr) {
290 $mergeArray = $GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];
291 if (is_array($mergeArray)) {
292 reset($mergeArray);
293 while(list($k,$v)=each($mergeArray)) {
294 $menuArr[$k]=$GLOBALS['LANG']->sL($v['title']);
295 }
296 }
297 return $menuArr;
298 }
299
300 /**
301 * Loads $this->extClassConf with the configuration for the CURRENT function of the menu.
302 * 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
303 *
304 * @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)
305 * @return void
306 * @see $include_once, init()
307 */
308 function handleExternalFunctionValue($MM_key='function') {
309 $this->extClassConf = $this->getExternalItemConfig($this->MCONF['name'],$MM_key,$this->MOD_SETTINGS[$MM_key]);
310 if (is_array($this->extClassConf) && $this->extClassConf['path']) {
311 $this->include_once[]=$this->extClassConf['path'];
312 }
313 }
314
315 /**
316 * Returns configuration values from the global variable $TBE_MODULES_EXT for the module given.
317 * 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.
318 *
319 * @param string Module name
320 * @param string Menu key, eg. "function" for the function menu. See $this->MOD_MENU
321 * @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...
322 * @return mixed The value from the TBE_MODULES_EXT array.
323 * @see handleExternalFunctionValue()
324 */
325 function getExternalItemConfig($modName,$menuKey,$value='') {
326 return strcmp($value,'')?$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey][$value]:$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];
327 }
328
329 /**
330 * 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...)
331 * This value in extClassConf might be set by an extension (in a ext_tables/ext_localconf file) which thus "connects" to a module.
332 * The array $this->extClassConf is set in handleExternalFunctionValue() based on the value of MOD_SETTINGS[function]
333 * (Should be) called from global scope right after inclusion of files from the ->include_once array.
334 * 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.
335 *
336 * @return void
337 * @see handleExternalFunctionValue(), t3lib_extMgm::insertModuleFunction(), $extObj
338 */
339 function checkExtObj() {
340 if (is_array($this->extClassConf) && $this->extClassConf['name']) {
341 $this->extObj = t3lib_div::makeInstance($this->extClassConf['name']);
342 $this->extObj->init($this,$this->extClassConf);
343 // Re-write:
344 $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->MOD_MENU, t3lib_div::_GP('SET'), $this->MCONF['name']);
345 }
346 }
347
348 /**
349 * Calls the checkExtObj function in sub module if present.
350 *
351 * @return void
352 */
353 function checkSubExtObj() {
354 if (is_object($this->extObj)) $this->extObj->checkExtObj();
355 }
356
357 /**
358 * Calls the 'header' function inside the "Function menu module" if present.
359 * 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.
360 * example call in the header function:
361 * $this->pObj->doc->JScode = $this->pObj->doc->wrapScriptTags(' ...
362 *
363 * @return void
364 */
365 function extObjHeader() {
366 if (is_callable(array($this->extObj,'head'))) $this->extObj->head();
367 }
368
369 /**
370 * Calls the 'main' function inside the "Function menu module" if present
371 *
372 * @return void
373 */
374 function extObjContent() {
375 $this->extObj->pObj = &$this;
376 if (is_callable(array($this->extObj, 'main'))) $this->content.=$this->extObj->main();
377 }
378 }
379 ?>