[TYPO3-core] Fwd: mod.php

[Michael Stucki]

Also see http://bugs.typo3.org/view.php?id=5326

- michael

Michael Stucki wrote:

> Hi guys,
> 
> I'm just forwarding this from Kasper. It's FYI.
> 
> - michael
> 
> ----------  Weitergeleitete Nachricht  ----------
> 
> Can you forward to core list?
> 
> - kasper
> 
> Begin forwarded message:
>> From: "Kasper Skårhøj (GMAIL)" <kasper.typo3 at gmail.com>
>> Date: March 22, 2007 12:37:08 PM GMT+01:00
>> To: TYPO3 core team <typo3-team-core at lists.netfielders.de>
>>
>> Hi Guys,
>>
>>
>> For your information I updated Inside TYPO3 with the description of
>> how to use the new "mod.php" script in typo3/. This allows backend
>> modules which no need to modify conf.php during extension
>> installation AND perfect symlinking of extensions as a result.
>>
>>
>> This is what I wrote, if you write backend modules you would like
>> to know. The Kickstarter could be updated to accommodate this as well:
>>
>>
>>
>>
>> Backend modules using typo3/mod.php
>> With version 4.1 of TYPO3 there is a new and better framework for
>> integration of backend modules into the backend. The main principle
>> is, that all backend modules using this method are called through a
>> central script, ?mod.php? in typo3/. This way, we get rid of the
>> trouble with conf.php files in need of modification when installing
>> extensions in local, global and system scopes.
>>
>> Introduction
>> Traditionally, a backend module runs directly from its own
>> ?index.php? script (or named otherwise as set up with $MCONF
>> ['script']). In order to initialize it must include the typo3/
>> init.php file. Accessing this file requires the module conf.php
>> file to hold the ?BACK_PATH? to the typo3/ directory. This will
>> differ depending on where the extension the module is in is
>> installed: locally in typo3conf/ext/ or as a global/system
>> extension. So not only is the conf.php file changed by the
>> Extension Manager when installing extensions, it also makes it very
>> tricky and possibly error-prone to share local extensions between
>> sites with symlinks!
>>
>> Using mod.php makes it all work differently. Examples in the core
>> can already be seen. For instance the ?Tools > User Admin? uses
>> this method now. Instead of directly calling the script ?typo3/
>> sysext/beuser/mod/index.php?, the script ?typo3/mod.php?
>> M=tools_beuser? is called which will look up (in $TBE_MODULES
>> ['_PATHS']) which script is associated with ?tools_beuser? and
>> include that. The mod.php script also initializes the backend,
>> includes configuration and so on.
>>
>> Adapting existing modules to this method
>> Generally, you can create a module as you always did and then make
>> these changes:
>>
>> ?    conf.php
>>
>> ?    Comment out (or remove!) the lines with the TYPO3_MOD_PATH and
>> BACK_PATH definitions. They are not needed anymore ($BACK_PATH is
>> blank for scripts running in typo3/ as mod.php does).
>>
>> Examples:
>>
>> #define('TYPO3_MOD_PATH', 'sysext/beuser/mod/');
>> #$BACK_PATH='../../../';
>>
>> ?    Set the value of $MCONF['script'] to ?_DISPATCH?. This will
>> make sure links to the module are pointed to ?mod.php? instead
>> of the real script of the module. This is only needed for modules
>> appearing in the menu as a main- or submodule.
>>
>> Example:
>>
>>
>>
>> $MCONF['script']='_DISPATCH';
>>
>> ?    ext_emconf.php
>>
>> ?    Remove the module name from the ?module? entry in the array!
>> This entry was what instructed the Extension Manager to modify
>> TYPO3_MOD_PATH and BACK_PATH in the conf.php file of the module
>> during installation of the extension. Since this is not needed any
>> more.
>>
>> ?    Module script name
>>
>> ?    Must be ?index.php? - but most modules will be that anyway.
>> That's the convension.
>>
>> ?    index.php (the module script)
>>
>> ?    In the module script you will have to comment out / remove those
>> lines that are initializing the module:
>>
>>
>>
>> #unset($MCONF);
>>
>> #require ('conf.php');
>>
>> #require ($BACK_PATH.'init.php');
>>
>> #require ($BACK_PATH.'template.php');
>>
>>
>>
>> This is logical because this initialization is now done by mod.php.
>>
>> ?    Observe that the main script changed! When the module is calling
>> it self, any hardcoded values for the script name (like ?index.php?
>> id=123?) must be changed. Now you must call ?mod.php?M=
>> [moduleKey]&id=123?. Its suggested you use  htmlspecialchars
>> ($GLOBALS['MCONF']['_']) as a reference to "thisScript" and add
>> parameters like ."&par=val"
>>
>>
>>
>> Context Menus: You will of course have to modify the clickmenu-
>> class to call "mod.php?M=[module name here]" where module name most
>> logically is the value of "$MCONF['name']" from the conf.php file.
>>
>> Also, if you use this method for not-menu-modules, you must call
>> t3lib_extMgm::addModulePath() from ext_tables.php to register the
>> path of the module. Example:
>>
>> t3lib_extMgm::addModulePath('xMOD_tximpexp',t3lib_extMgm::extPath
>> ($_EXTKEY).'app/');
> 
> - kasper
> 
> ----------------------------
> NOTICE: NEW EMAIL for 2007: kasper2007 at typo3.com
> 
> -------------------------------------------------------

-- 
Use a newsreader! Check out
http://typo3.org/community/mailing-lists/use-a-news-reader/