Inside TYPO3

3.5.2. conf.php

The "conf.php" file is used to configure both Backend Modules and Stand-alone scripts - but not Function Menu modules (which are running inside a backend modules environment!).

The file contains variable and constants definitions according to this scheme:

    // Configures path for a core module:

  define('TYPO3_MOD_PATH', 

          'mod/web/info/');

    // Configures path for an extension module:

  define('TYPO3_MOD_PATH', 

          '../typo3conf/ext/temp/mod2/');

    // Configures backpath for a core module:

  $BACK_PATH = '../../../';

    // Configures backpath for extension module:

  $BACK_PATH = '../../../../typo3/';

  $MLANG["default"]["tabs_images"]["tab"] = 

          "moduleicon.gif";

  $MLANG["default"]["ll_ref"] = 

          "LLL:EXT:temp/mod1/locallang_mod.php";

    // For the "Web" main module:

  $MCONF['defaultMod'] = 'list';

  $MCONF['navFrameScript'] = '../../alt_db_navframe.php';

  $MCONF['name'] = 'web';

  $MCONF['access'] = 'user,group';

    // More common for extension backend modules:

  $MCONF["access"] = "user,group";

  $MCONF["script"] = "index.php";

Extensions and "conf.php" files

When you create backend modules in extensions there is a tricky thing to be aware of (exception: When using typo3/mod.php to dispatch to a module, see later); The "conf.php" file has to change depending on whether the extension is installed as "global"/"system" extension or "local". The reason is that the TYPO3_MOD_PATH and $BACK_PATH values has to be different when an extension is in the "typo3conf/" folder which is located outside the main TYPO3 directory, PATH_typo3. For instance TYPO3_MOD_PATH could look like "../typo3conf/ext/myext/mod/" for a locally installed extensions while it would be "ext/myext/mod/" for a globally installed extension!

If you install extensions via the Extension Manager this is no problem since the Extension Manager (EM) corrects it before writing the "conf.php" file to the servers file-system. But you need to make your "conf.php" file compatible with this behaviour. Basically that includes:

1. Insert the two lines with "defined('TYPO3_MOD_PATH'......" and "$BACK_PATH = ....." as the first ones and do not prefix or suffix them with anything; then the EM should be able to detect them.

2. In the "ext_emconf.php" file of the extension you need to add the directory of the module to the list of backend modules configured in the key $EM_CONF[extension-key]["module"] - otherwise the EM will not know that there is a "conf.php" file to modify!

An example would look like this:

  <?php

      // DO NOT REMOVE OR CHANGE THESE 3 LINES:

  define('TYPO3_MOD_PATH', '../typo3conf/ext/temp/mod2/');

  $BACK_PATH='../../../../typo3/';

  $MCONF["name"]="web_txtempM2";

  $MCONF["access"]="user,group";

  $MCONF["script"]="index.php";

  $MLANG["default"]["tabs_images"]["tab"] = "moduleicon.gif";

  $MLANG["default"]["ll_ref"]="LLL:EXT:temp/mod2/locallang_mod.php";

  ?>

$MLANG

  $MLANG['default']['tabs_images']['tab']

  $MLANG['default']['ll_ref']

  $MLANG[ language-key ]['labels']['tablabel']
$MLANG[ language-key ]['labels']['tabdescr']
$MLANG[ language-key ]['tabs']['tab']

The $MLANG variable contains the icon reference and title / description for a Backend Module. Originally the $MLANG variable defined values for all languages inside the conf.php file. This (obsolete) codelisting shows it:

  $MLANG["default"]["labels"]["tablabel"] = "Advanced functions";

  $MLANG["default"]["tabs"]["tab"] = "Func";

  $MLANG["default"]["tabs_images"]["tab"] = "func.gif";

  $MLANG["dk"]["labels"]["tablabel"] = "Avancerede funktioner";

  $MLANG["dk"]["tabs"]["tab"] = "Funk.";

  $MLANG["de"]["labels"]["tablabel"] = "Erweiterte Funktionen";

  $MLANG["de"]["tabs"]["tab"] = "Funk.";

  $MLANG["no"]["labels"]["tablabel"] = "Avanserte funksjoner";

  $MLANG["no"]["tabs"]["tab"] = "Funk.";

  $MLANG["it"]["labels"]["tablabel"] = "Funzioni avanzate";

  $MLANG["it"]["tabs"]["tab"] = "Funzione";

  ...

  (OBSOLETE!)

This is still supported for backwards compatibility reasons. Today you need to configure only two lines, one for a "locallang" file reference and one for the icon image:

  $MLANG['default']['tabs_images']['tab'] = 'func.gif';

  $MLANG['default']['ll_ref']='LLL:EXT:lang/locallang_mod_web_func.php';

The icon reference (line 1) points to an icon image relative to the current directory (normally located there).

The "locallang" file reference in line 2 points to a "locallang"-file which in this case looks like this:

  <?php

  # TYPO3 CVS ID: $Id: locallang_mod_web_func.php,v 1.5 2004/04/30 16:19:54 typo3 Exp $

  $LOCAL_LANG = Array (

      'default' => Array (

          'title' => 'Advanced functions',

          'clickAPage_content' => 'Please click a page title in the page tree.',

          'mlang_labels_tablabel' => 'Advanced functions',

          'mlang_labels_tabdescr' => 'You\'ll find general export and import functions here. ... sorting of pages.',

          'mlang_tabs_tab' => 'Functions',

      ),

      'dk' => Array (

          'title' => 'Avancerede funktioner',

          'clickAPage_content' => 'Klik på en sidetitel i sidetræet.',

          'mlang_labels_tablabel' => 'Avancerede funktioner',

          'mlang_labels_tabdescr' => 'Her vil du finde generelle eksport og import funktioner. ... sortering af sider.',

          'mlang_tabs_tab' => 'Funktioner',

      ),

  ...

  );

  ?>

In this locallang file, some keys are reserved words that point out information related to the "conf.php" file:

1. mlang_tabs_tab : Title of the module in the menu.

2. mlang_labels_tablabel : Long title of the module. Used as "title" attribute for menu link and title in the "About modules" list.

3. mlang_labels_tabdescr : Description of the module (used in "About modules")

$MCONF

  $MCONF['name']

    // Main module (from extension)

  $MCONF["name"]="txtempM1";

    // Submodule of "Web" main module:

  $MCONF["name"]="web_txtempM2";

    // File>Filelist module:

  $MCONF['name']='file_list';

    // Setting pseudo module name

  $this->MCONF['name']='xMOD_alt_clickmenu.php';

    // Setting pseudo module name for CSM item
$MCONF["name"]="xMOD_tx_temp_cm1";

  $MCONF['script']

  $MCONF['access']

  $MCONF['workspaces']

  $MCONF['defaultMod']

  $MCONF['navFrameScript']

  $MCONF['navFrameScript']='../../alt_db_navframe.php';

  $MCONF['navFrameScriptParam']

  $MCONF['shy']

Example: conf.php for Stand-Alone backend scripts

The difference between a stand-alone backend script and a backend module is that the backend module has an API for access control and a menu item. But they share the same requirements for basic initialization.

The most basic configuration for a backend script is setting the TYPO3_MOD_PATH constant and the $BACK_PATH variable before including "init.php". The script "typo3/install/index.php" is an example of this:

  define('TYPO3_MOD_PATH', 'install/');

  $BACK_PATH='../';

  ...

  require('../init.php');

It is more common to define the TYPO3_MOD_PATH constant and $BACK_PATH variable in a separate conf-file - that is always done for modules and when you are supplying backend scripts from extensions. In such a case the initialization of the backend script will look like this:

  unset($MCONF);

  require('conf.php');

  require($BACK_PATH.'init.php');

  ...

The file "conf.php" looks like this:

  <?php

      // DO NOT REMOVE OR CHANGE THESE 3 LINES:

  define('TYPO3_MOD_PATH', '../typo3conf/ext/temp/cm1/');

  $BACK_PATH = '../../../../typo3/';

  $MCONF['name'] = 'xMOD_tx_temp_cm1';

  ?>

The line defining $MCONF['name'] is optional since the script is a stand-alone script. It might be used as a key for Function menus or otherwise. You can tell that it is a pseudo module name since it is prefixed "xMOD_".

The main point of TYPO3_MOD_PATH and $BACK_PATH is to set the environment so TYPO3 knows the position of the backend script in relation to the main backend folder, PATH_typo3. And the inclusion of "init.php" is required in order to initialize the backend environment and authenticate the backend user. If the script returns from "init.php" it went well and you can be safe that a backend user is logged in (unless configured otherwise).

Example: conf.php for Backend Modules

The conf.php file for a backend module compared to a stand-alone script is different mainly by defining values for $MCONF and $MLANG. This is an example:

  <?php

      // DO NOT REMOVE OR CHANGE THESE 3 LINES:

  define('TYPO3_MOD_PATH', '../typo3conf/ext/temp/mod2/');

  $BACK_PATH = '../../../../typo3/';

  $MCONF['name'] = 'web_txtempM2';

  $MCONF['access'] = 'user,group';

  $MCONF['script'] = 'index.php';

  $MLANG['default']['tabs_images']['tab'] = 'moduleicon.gif';

  $MLANG['default']['ll_ref'] = 'LLL:EXT:temp/mod2/locallang_mod.php';

  ?>

It doesn't do any difference whether the module is a main- or sub-module. Only the $MCONF['name'] will change in that case.