[TASK] Clean up phpDoc comments in t3lib_extobjbase
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_extobjbase.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 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 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
31 *
32 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
33 */
34
35 /**
36 * EXAMPLE: One level.
37 *
38 * 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:
39 *
40 * t3lib_extMgm::insertModuleFunction(
41 * 'web_info',
42 * 'tx_cms_webinfo_page',
43 * t3lib_extMgm::extPath($_EXTKEY).'web_info/class.tx_cms_webinfo.php',
44 * 'LLL:EXT:cms/locallang_tca.php:mod_tx_cms_webinfo_page'
45 * );
46 *
47 * EXAMPLE: Two levels.
48 * 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.
49 * 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'.
50 * In the 'ext_tables.php' file of an extension ('wizard_crpages') which uses the framework provided by 'func_wizards' this looks like this:
51 *
52 * t3lib_extMgm::insertModuleFunction(
53 * 'web_func',
54 * 'tx_wizardcrpages_webfunc_2',
55 * t3lib_extMgm::extPath($_EXTKEY).'class.tx_wizardcrpages_webfunc_2.php',
56 * 'LLL:EXT:wizard_crpages/locallang.php:wiz_crMany',
57 * 'wiz'
58 * );
59 *
60 * But for this two-level thing to work it also requires that the parent module (the real backend module) supports it.
61 * 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):
62 *
63 * // Make instance:
64 * $SOBE = t3lib_div::makeInstance("SC_mod_web_func_index");
65 * $SOBE->init();
66 *
67 * // Include files?
68 * foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
69 * $SOBE->checkExtObj(); // Checking for first level external objects
70 *
71 * // Repeat Include files! - if any files has been added by second-level extensions
72 * foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
73 * $SOBE->checkSubExtObj(); // Checking second level external objects
74 *
75 * $SOBE->main();
76 * $SOBE->printContent();
77 *
78 * Notice that the first part is as usual: Include classes and call $SOBE->checkExtObj() to initialize any level-1 sub-modules
79 * But then again ->include_once is traversed IF the initialization of the level-1 modules might have added more files!!
80 * And after that $SOBE->checkSubExtObj() is called to initialize the second level.
81 * In this way even a third level could be supported - but most likely that is a too layered model to be practical.
82 *
83 * Anyways, the final interesting thing is to see what the framework "func_wizard" actually does:
84 *
85 * class tx_funcwizards_webfunc extends t3lib_extobjbase {
86 * var $localLangFile = "locallang.php";
87 * var $function_key = "wiz";
88 * function init(&$pObj,$conf) {
89 * // OK, handles ordinary init. This includes setting up the menu array with ->modMenu
90 * parent::init($pObj,$conf);
91 * // 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!!!
92 * $this->handleExternalFunctionValue();
93 * }
94 * }
95 *
96 * Notice that the handleExternalFunctionValue of this class (t3lib_extobjbase) is called and that the ->function_key internal var is set!
97 *
98 * The two level-2 sub-module "wizard_crpages" and "wizard_sortpages" are totally normal "submodules".
99 */
100
101 /**
102 * Parent class for 'Extension Objects' in backend modules.
103 * 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...
104 * 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...)
105 * 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)
106 * 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.
107 * 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.
108 *
109 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
110 * @package TYPO3
111 * @subpackage t3lib
112 * @see t3lib_SCbase,tx_funcwizards_webfunc::init(), tx_funcwizards_webfunc, tx_wizardsortpages_webfunc_2
113 */
114 class t3lib_extobjbase {
115
116 /**
117 * Contains a reference to the parent (calling) object (which is probably an instance of an extension class to t3lib_SCbase)
118 *
119 * @var t3lib_SCbase
120 * @see init()
121 */
122 var $pObj;
123
124 /**
125 * Set to the directory name of this class file.
126 * @see init()
127 */
128 var $thisPath = '';
129
130 /**
131 * Can be hardcoded to the name of a locallang.php file (from the same directory as the class file) to use/load
132 * @see incLocalLang()
133 */
134 var $localLangFile = 'locallang.php';
135
136 /**
137 * Contains module configuration parts from TBE_MODULES_EXT if found
138 *
139 * @see handleExternalFunctionValue()
140 */
141 var $extClassConf;
142
143 /**
144 * 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.
145 * 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.
146 * 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'
147 *
148 * @see handleExternalFunctionValue(), tx_funcwizards_webfunc
149 */
150 var $function_key = '';
151
152 /**
153 * Initialize the object
154 *
155 * @param object $pObj A reference to the parent (calling) object (which is probably an instance of an extension class to t3lib_SCbase)
156 * @param array $conf The configuration set for this module - from global array TBE_MODULES_EXT
157 * @return void
158 * @see t3lib_SCbase::checkExtObj()
159 */
160 function init(&$pObj, $conf) {
161 $this->pObj = $pObj;
162
163 // Path of this script:
164 $this->thisPath = dirname($conf['path']);
165 if (!@is_dir($this->thisPath)) {
166 throw new RuntimeException(
167 'TYPO3 Fatal Error: Extension "' . $this->thisPath . ' was not a directory as expected...',
168 1270853912
169 );
170 }
171
172 // Local lang:
173 $this->incLocalLang();
174
175 // Setting MOD_MENU items as we need them for logging:
176 $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...
177 }
178
179 /**
180 * 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
181 *
182 * @return void
183 * @see $function_key, tx_funcwizards_webfunc::init()
184 */
185 function handleExternalFunctionValue() {
186 // Must clean first to make sure the correct key is set...
187 $this->pObj->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->pObj->MOD_MENU, t3lib_div::_GP('SET'), $this->pObj->MCONF['name']);
188 if ($this->function_key) {
189 $this->extClassConf = $this->pObj->getExternalItemConfig($this->pObj->MCONF['name'], $this->function_key, $this->pObj->MOD_SETTINGS[$this->function_key]);
190 if (is_array($this->extClassConf) && $this->extClassConf['path']) {
191 $this->pObj->include_once[] = $this->extClassConf['path'];
192 }
193 }
194 }
195
196 /**
197 * Including any locallang file configured and merging its content over the current global LOCAL_LANG array (which is EXPECTED to exist!!!)
198 *
199 * @return void
200 */
201 function incLocalLang() {
202 if ($this->localLangFile && (
203 @is_file($this->thisPath . '/' . $this->localLangFile)
204 || @is_file($this->thisPath . '/' . substr($this->localLangFile, 0, -4) . '.xml')
205 || @is_file($this->thisPath . '/' . substr($this->localLangFile, 0, -4) . '.xlf')
206 )
207 ) {
208 $LOCAL_LANG = $GLOBALS['LANG']->includeLLFile($this->thisPath . '/' . $this->localLangFile, FALSE);
209 if (is_array($LOCAL_LANG)) {
210 $GLOBALS['LOCAL_LANG'] = t3lib_div::array_merge_recursive_overrule((array) $GLOBALS['LOCAL_LANG'], $LOCAL_LANG);
211 }
212 }
213 }
214
215 /**
216 * Same as t3lib_SCbase::checkExtObj()
217 *
218 * @return void
219 * @see t3lib_SCbase::checkExtObj()
220 */
221 function checkExtObj() {
222 if (is_array($this->extClassConf) && $this->extClassConf['name']) {
223 $this->extObj = t3lib_div::makeInstance($this->extClassConf['name']);
224 $this->extObj->init($this->pObj, $this->extClassConf);
225
226 // Re-write:
227 $this->pObj->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->pObj->MOD_MENU, t3lib_div::_GP('SET'), $this->pObj->MCONF['name']);
228 }
229 }
230
231 /**
232 * Calls the main function inside ANOTHER sub-submodule which might exist.
233 *
234 * @return void
235 */
236 function extObjContent() {
237 if (is_object($this->extObj)) {
238 return $this->extObj->main();
239 }
240 }
241
242 /**
243 * Dummy function - but is used to set up additional menu items for this submodule.
244 * 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()
245 *
246 * @return array A MOD_MENU array which will be merged together with the one from the parent object
247 * @see init(), tx_cms_webinfo_page::modMenu()
248 */
249 function modMenu() {
250 return array();
251 }
252 }
253
254 ?>