Fixed bug #14050: CleanUp - CGL format of t3lib files - t3lib_scbase
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_extobjbase.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2010 Kasper Skårhøj (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 base class for 'Extension Objects' in backend modules.
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
32 *
33 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 145: class t3lib_extobjbase
41 * 197: function init(&$pObj,$conf)
42 * 221: function handleExternalFunctionValue()
43 * 237: function incLocalLang()
44 * 253: function checkExtObj()
45 * 268: function extObjContent()
46 * 279: function modMenu()
47 *
48 * TOTAL FUNCTIONS: 6
49 * (This index is automatically created/updated by the extension "extdeveval")
50 *
51 */
52
53
54 /**
55 * EXAMPLE: One level.
56 *
57 * This can be seen in the extension 'cms' where the info module have a function added. In 'ext_tables.php' this is done by this function call:
58 *
59 * t3lib_extMgm::insertModuleFunction(
60 * 'web_info',
61 * 'tx_cms_webinfo_page',
62 * t3lib_extMgm::extPath($_EXTKEY).'web_info/class.tx_cms_webinfo.php',
63 * 'LLL:EXT:cms/locallang_tca.php:mod_tx_cms_webinfo_page'
64 * );
65 *
66 *
67 *
68 * EXAMPLE: Two levels.
69 * This is the advanced example. You can see it with the extension 'func_wizards' which is the first layer but then providing another layer for extensions to connect by.
70 * The key used in TBE_MODULES_EXT is normally 'function' (for the 'function menu') but the 'func_wizards' extension uses an alternative key for its configuration: 'wiz'.
71 * In the 'ext_tables.php' file of an extension ('wizard_crpages') which uses the framework provided by 'func_wizards' this looks like this:
72 *
73 * t3lib_extMgm::insertModuleFunction(
74 * 'web_func',
75 * 'tx_wizardcrpages_webfunc_2',
76 * t3lib_extMgm::extPath($_EXTKEY).'class.tx_wizardcrpages_webfunc_2.php',
77 * 'LLL:EXT:wizard_crpages/locallang.php:wiz_crMany',
78 * 'wiz'
79 * );
80 *
81 * But for this two-level thing to work it also requires that the parent module (the real backend module) supports it.
82 * This is the case for the modules web_func and web_info since they have two times inclusion sections in their index.php scripts. For example (from web_func):
83 *
84 * // Make instance:
85 * $SOBE = t3lib_div::makeInstance("SC_mod_web_func_index");
86 * $SOBE->init();
87 *
88 * // Include files?
89 * foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
90 * $SOBE->checkExtObj(); // Checking for first level external objects
91 *
92 * // Repeat Include files! - if any files has been added by second-level extensions
93 * foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
94 * $SOBE->checkSubExtObj(); // Checking second level external objects
95 *
96 * $SOBE->main();
97 * $SOBE->printContent();
98 *
99 * Notice that the first part is as usual: Include classes and call $SOBE->checkExtObj() to initialize any level-1 sub-modules
100 * But then again ->include_once is traversed IF the initialization of the level-1 modules might have added more files!!
101 * And after that $SOBE->checkSubExtObj() is called to initialize the second level.
102 * In this way even a third level could be supported - but most likely that is a too layered model to be practical.
103 *
104 * Anyways, the final interesting thing is to see what the framework "func_wizard" actually does:
105 *
106 * class tx_funcwizards_webfunc extends t3lib_extobjbase {
107 * var $localLangFile = "locallang.php";
108 * var $function_key = "wiz";
109 * function init(&$pObj,$conf) {
110 * // OK, handles ordinary init. This includes setting up the menu array with ->modMenu
111 * parent::init($pObj,$conf);
112 * // Making sure that any further external classes are added to the include_once array. Notice that inclusion happens twice in the main script because of this!!!
113 * $this->handleExternalFunctionValue();
114 * }
115 * ....
116 *
117 * Notice that the handleExternalFunctionValue of this class (t3lib_extobjbase) is called and that the ->function_key internal var is set!
118 *
119 * The two level-2 sub-module "wizard_crpages" and "wizard_sortpages" are totally normal "submodules".
120 */
121
122 /**
123 * Parent class for 'Extension Objects' in backend modules.
124 * Used for 'submodules' to other modules. Also called 'Function menu modules' in t3lib_extMgm. And now its even called 'Extension Objects'. Or 'Module functions'. Wish we had just one name. Or a name at all...(?) Thank God its not so advanced when it works...
125 * In other words this class is used for backend modules which is not true backend modules appearing in the menu but rather adds themselves as a new entry in the function menu which typically exists for a backend module (like Web>Functions, Web>Info or Tools etc...)
126 * The magic that binds this together is stored in the global variable $TBE_MODULES_EXT where extensions wanting to connect a module based on this class to an existing backend module store configuration which consists of the classname, script-path and a label (title/name)
127 * For more information about this, please see the large example comment for the class t3lib_SCbase. This will show the principle of a 'level-1' connection.
128 * The more advanced example - having two layers as it is done by the 'func_wizards' extension with the 'web_info' module - can be seen in the comment above.
129 *
130 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
131 * @package TYPO3
132 * @subpackage t3lib
133 * @see t3lib_SCbase,tx_funcwizards_webfunc::init(), tx_funcwizards_webfunc, tx_wizardsortpages_webfunc_2
134 */
135 class t3lib_extobjbase {
136
137 /**
138 * Contains a reference to the parent (calling) object (which is probably an instance of an extension class to t3lib_SCbase)
139 *
140 * @var t3lib_SCbase
141 * @see init()
142 */
143 var $pObj; // parent SC object
144
145 /**
146 * Set to the directory name of this class file.
147 * @see init()
148 */
149 var $thisPath = '';
150
151 /**
152 * Can be hardcoded to the name of a locallang.php file (from the same directory as the class file) to use/load
153 * @see incLocalLang()
154 */
155 var $localLangFile = 'locallang.php';
156
157 /**
158 * Contains module configuration parts from TBE_MODULES_EXT if found
159 *
160 * @see handleExternalFunctionValue()
161 */
162 var $extClassConf;
163
164 /**
165 * If this value is set it points to a key in the TBE_MODULES_EXT array (not on the top level..) where another classname/filepath/title can be defined for sub-subfunctions.
166 * This is a little hard to explain, so see it in action; it used in the extension 'func_wizards' in order to provide yet a layer of interfacing with the backend module.
167 * The extension 'func_wizards' has this description: 'Adds the 'Wizards' item to the function menu in Web>Func. This is just a framework for wizard extensions.' - so as you can see it is designed to allow further connectivity - 'level 2'
168 *
169 * @see handleExternalFunctionValue(), tx_funcwizards_webfunc
170 */
171 var $function_key = '';
172
173
174 /**
175 * Initialize the object
176 *
177 * @param object A reference to the parent (calling) object (which is probably an instance of an extension class to t3lib_SCbase)
178 * @param array The configuration set for this module - from global array TBE_MODULES_EXT
179 * @return void
180 * @see t3lib_SCbase::checkExtObj()
181 */
182 function init(&$pObj, $conf) {
183 global $LANG;
184
185 $this->pObj = $pObj;
186
187 // Path of this script:
188 $this->thisPath = dirname($conf['path']);
189 if (!@is_dir($this->thisPath)) {
190 throw new RuntimeException(
191 'TYPO3 Fatal Error: Extension "' . $this->thisPath . ' was not a directory as expected...',
192 1270853912
193 );
194 }
195
196 // Local lang:
197 $this->incLocalLang();
198
199 // Setting MOD_MENU items as we need them for logging:
200 $this->pObj->MOD_MENU = array_merge($this->pObj->MOD_MENU, $this->modMenu()); // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
201 }
202
203 /**
204 * If $this->function_key is set (which means there are two levels of object connectivity) then $this->extClassConf is loaded with the TBE_MODULES_EXT configuration for that sub-sub-module
205 *
206 * @return void
207 * @see $function_key, tx_funcwizards_webfunc::init()
208 */
209 function handleExternalFunctionValue() {
210 // Must clean first to make sure the correct key is set...
211 $this->pObj->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->pObj->MOD_MENU, t3lib_div::_GP('SET'), $this->pObj->MCONF['name']);
212 if ($this->function_key) {
213 $this->extClassConf = $this->pObj->getExternalItemConfig($this->pObj->MCONF['name'], $this->function_key, $this->pObj->MOD_SETTINGS[$this->function_key]);
214 if (is_array($this->extClassConf) && $this->extClassConf['path']) {
215 $this->pObj->include_once[] = $this->extClassConf['path'];
216 }
217 }
218 }
219
220 /**
221 * Including any locallang file configured and merging its content over the current global LOCAL_LANG array (which is EXPECTED to exist!!!)
222 *
223 * @return void
224 */
225 function incLocalLang() {
226 global $LANG;
227 #if ($this->localLangFile && @is_file($this->thisPath.'/'.$this->localLangFile)) {
228 # include($this->thisPath.'/'.$this->localLangFile);
229 if ($this->localLangFile && (@is_file($this->thisPath . '/' . $this->localLangFile) || @is_file($this->thisPath . '/' . substr($this->localLangFile, 0, -4) . '.xml'))) {
230 $LOCAL_LANG = $LANG->includeLLFile($this->thisPath . '/' . $this->localLangFile, FALSE);
231 if (is_array($LOCAL_LANG)) {
232 $GLOBALS['LOCAL_LANG'] = t3lib_div::array_merge_recursive_overrule((array) $GLOBALS['LOCAL_LANG'], $LOCAL_LANG);
233 }
234 }
235 }
236
237 /**
238 * Same as t3lib_SCbase::checkExtObj()
239 *
240 * @return void
241 * @see t3lib_SCbase::checkExtObj()
242 */
243 function checkExtObj() {
244 if (is_array($this->extClassConf) && $this->extClassConf['name']) {
245 $this->extObj = t3lib_div::makeInstance($this->extClassConf['name']);
246 $this->extObj->init($this->pObj, $this->extClassConf);
247
248 // Re-write:
249 $this->pObj->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->pObj->MOD_MENU, t3lib_div::_GP('SET'), $this->pObj->MCONF['name']);
250 }
251 }
252
253 /**
254 * Calls the main function inside ANOTHER sub-submodule which might exist.
255 *
256 * @return void
257 */
258 function extObjContent() {
259 if (is_object($this->extObj)) {
260 return $this->extObj->main();
261 }
262 }
263
264 /**
265 * Dummy function - but is used to set up additional menu items for this submodule.
266 * For an example see the extension 'cms' where the 'web_info' submodule is defined in cms/web_info/class.tx_cms_webinfo.php, tx_cms_webinfo_page::modMenu()
267 *
268 * @return array A MOD_MENU array which will be merged together with the one from the parent object
269 * @see init(), tx_cms_webinfo_page::modMenu()
270 */
271 function modMenu() {
272 return array();
273 }
274 }
275
276 ?>