Added $Id$ keywords, cleaned up comment tags
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_scbase.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2003 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 * 134: class t3lib_SCbase
41 * 250: function init()
42 * 267: function menuConfig()
43 * 287: function mergeExternalItems($modName,$menuKey,$menuArr)
44 * 306: function handleExternalFunctionValue($MM_key='function')
45 * 323: function getExternalItemConfig($modName,$menuKey,$value='')
46 * 337: function checkExtObj()
47 * 351: function checkSubExtObj()
48 * 363: function extObjHeader()
49 * 372: 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 * reset($SOBE->include_once);
114 * while(list(,$INC_FILE)=each($SOBE->include_once)) {include_once($INC_FILE);}
115 *
116 * // THEN WE WILL CHECK IF THERE IS A 'SUBMODULE' REGISTERED TO BE INITIALIZED AS WELL:
117 * $SOBE->checkExtObj();
118 *
119 * // THEN WE CALL THE main() METHOD AND THIS SHOULD SPARK THE CREATION OF THE MODULE OUTPUT.
120 * $SOBE->main();
121 * // FINALLY THE printContent() FUNCTION WILL OUTPUT THE ACCUMULATED CONTENT
122 * $SOBE->printContent();
123 */
124
125 /**
126 * Parent class for 'ScriptClasses' in backend modules.
127 * See example comment above.
128 *
129 * @author Kasper Skaarhoj <kasper@typo3.com>
130 * @package TYPO3
131 * @subpackage t3lib
132 * @see t3lib_extobjbase
133 */
134 class t3lib_SCbase {
135
136 /**
137 * Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.
138 * @see init()
139 */
140 var $MCONF=array();
141
142 /**
143 * The integer value of the GET/POST var, 'id'. Used for submodules to the 'Web' module.
144 * @see init()
145 */
146 var $id;
147
148 /**
149 * The value of GET/POST var, 'CMD'
150 * @see init()
151 */
152 var $CMD;
153
154 /**
155 * A WHERE clause for selection records from the pages table based on read-permissions of the current backend user.
156 * @see init()
157 */
158 var $perms_clause;
159
160
161
162 /**
163 * The module menu items array. Each key represents a key for which values can range between the items in the array of that key.
164 * @see init()
165 */
166 var $MOD_MENU= Array (
167 'function' => array()
168 );
169
170 /**
171 * Current settings for the keys of the MOD_MENU array
172 * @see $MOD_MENU
173 */
174 var $MOD_SETTINGS=array();
175
176 /**
177 * Module TSconfig based on PAGE TSconfig / USER TSconfig
178 * @see menuConfig()
179 */
180 var $modTSconfig;
181
182 /**
183 * 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.
184 * Can be set from extension classes of this class before the init() function is called.
185 *
186 * @see menuConfig(), t3lib_BEfunc::getModuleData()
187 */
188 var $modMenu_type = '';
189
190 /**
191 * 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.
192 * Can be set from extension classes of this class before the init() function is called.
193 *
194 * @see menuConfig(), t3lib_BEfunc::getModuleData()
195 */
196 var $modMenu_dontValidateList = '';
197
198 /**
199 * List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)
200 * Can be set from extension classes of this class before the init() function is called.
201 *
202 * @see menuConfig(), t3lib_BEfunc::getModuleData()
203 */
204 var $modMenu_setDefaultList = '';
205
206 /**
207 * Contains module configuration parts from TBE_MODULES_EXT if found
208 *
209 * @see handleExternalFunctionValue()
210 */
211 var $extClassConf;
212
213 /**
214 * 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
215 *
216 * @see handleExternalFunctionValue()
217 */
218 var $include_once=array();
219
220 /**
221 * Generally used for accumulating the output content of backend modules
222 */
223 var $content='';
224
225 /**
226 * Generally used to hold an instance of the 'template' class from typo3/template.php
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 $this->MCONF = $GLOBALS['MCONF'];
252 $this->id = intval(t3lib_div::GPvar('id'));
253 $this->CMD = t3lib_div::GPvar('CMD');
254 $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
255 $this->menuConfig();
256 $this->handleExternalFunctionValue();
257 }
258
259 /**
260 * 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())
261 * 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.
262 * Also loads the modTSconfig internal variable.
263 *
264 * @return void
265 * @see init(), $MOD_MENU, $MOD_SETTINGS, t3lib_BEfunc::getModuleData(), mergeExternalItems()
266 */
267 function menuConfig() {
268 // page/be_user TSconfig settings and blinding of menu-items
269 $this->modTSconfig = t3lib_BEfunc::getModTSconfig($this->id,'mod.'.$this->MCONF['name']);
270 $this->MOD_MENU['function'] = $this->mergeExternalItems($this->MCONF['name'],'function',$this->MOD_MENU['function']);
271 $this->MOD_MENU['function'] = t3lib_BEfunc::unsetMenuItems($this->modTSconfig['properties'],$this->MOD_MENU['function'],'menu.function');
272
273 // CLEANSE 'function' SETTINGS
274 $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->MOD_MENU, t3lib_div::GPvar('SET'), $this->MCONF['name'], $this->modMenu_type, $this->modMenu_dontValidateList, $this->modMenu_setDefaultList);
275 }
276
277 /**
278 * Merges menu items from global array $TBE_MODULES_EXT
279 *
280 * @param string Module name for which to find value
281 * @param string Menu key, eg. 'function' for the function menu.
282 * @param array The part of a MOD_MENU array to work on.
283 * @return array Modified array part.
284 * @access private
285 * @see t3lib_extMgm::insertModuleFunction(), menuConfig()
286 */
287 function mergeExternalItems($modName,$menuKey,$menuArr) {
288 $mergeArray = $GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];
289 if (is_array($mergeArray)) {
290 reset($mergeArray);
291 while(list($k,$v)=each($mergeArray)) {
292 $menuArr[$k]=$GLOBALS['LANG']->sL($v['title']);
293 }
294 }
295 return $menuArr;
296 }
297
298 /**
299 * Loads $this->extClassConf with the configuration for the CURRENT function of the menu.
300 * 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
301 *
302 * @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)
303 * @return void
304 * @see $include_once, init()
305 */
306 function handleExternalFunctionValue($MM_key='function') {
307 $this->extClassConf = $this->getExternalItemConfig($this->MCONF['name'],$MM_key,$this->MOD_SETTINGS[$MM_key]);
308 if (is_array($this->extClassConf) && $this->extClassConf['path']) {
309 $this->include_once[]=$this->extClassConf['path'];
310 }
311 }
312
313 /**
314 * Returns configuration values from the global variable $TBE_MODULES_EXT for the module given.
315 * 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.
316 *
317 * @param string Module name
318 * @param string Menu key, eg. "function" for the function menu. See $this->MOD_MENU
319 * @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...
320 * @return mixed The value from the TBE_MODULES_EXT array.
321 * @see handleExternalFunctionValue()
322 */
323 function getExternalItemConfig($modName,$menuKey,$value='') {
324 return strcmp($value,'')?$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey][$value]:$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];
325 }
326
327 /**
328 * 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...)
329 * This value in extClassConf might be set by an extension (in a ext_tables/ext_localconf file) which thus "connects" to a module.
330 * The array $this->extClassConf is set in handleExternalFunctionValue() based on the value of MOD_SETTINGS[function]
331 * (Should be) called from global scope right after inclusion of files from the ->include_once array.
332 * 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.
333 *
334 * @return void
335 * @see handleExternalFunctionValue(), t3lib_extMgm::insertModuleFunction(), $extObj
336 */
337 function checkExtObj() {
338 if (is_array($this->extClassConf) && $this->extClassConf['name']) {
339 $this->extObj = t3lib_div::makeInstance($this->extClassConf['name']);
340 $this->extObj->init($this,$this->extClassConf);
341 // Re-write:
342 $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->MOD_MENU, t3lib_div::GPvar('SET'), $this->MCONF['name']);
343 }
344 }
345
346 /**
347 * Calls the checkExtObj function in sub module if present.
348 *
349 * @return void
350 */
351 function checkSubExtObj() {
352 if (is_object($this->extObj)) $this->extObj->checkExtObj();
353 }
354
355 /**
356 * Calls the 'header' function inside the "Function menu module" if present.
357 * 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.
358 * example call in the header function:
359 * $this->pObj->doc->JScode = $this->pObj->doc->wrapScriptTags(' ...
360 *
361 * @return void
362 */
363 function extObjHeader() {
364 if (is_callable(array($this->extObj,'head'))) $this->extObj->head();
365 }
366
367 /**
368 * Calls the 'main' function inside the "Function menu module" if present
369 *
370 * @return void
371 */
372 function extObjContent() {
373 $this->extObj->pObj = &$this;
374 if (is_callable(array($this->extObj, 'main'))) $this->content.=$this->extObj->main();
375 }
376 }
377 ?>