* Added some file icons from Ben and Emile
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_loadmodules.php
index 770551b..ec1e9ca 100644 (file)
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *  
-*  (c) 1999-2003 Kasper Skårhøj (kasper@typo3.com)
+*  (c) 1999-2004 Kasper Skaarhoj (kasper@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is 
 /** 
  * This document provides a class that loads the modules for the TYPO3 interface.
  *
+ * $Id$
  * Modifications by Rene Fritz, 2001
- * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
+ * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
  *
- * @author     Kasper Skårhøj <kasper@typo3.com>
- * @package TYPO3
- * @subpackage t3lib
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
  * @internal
  */
 /**
  *
  *
  *
- *   77: class t3lib_loadModules 
- *   96:     function load($modulesArray,$BE_USER='')  
- *  365:     function checkExtensionModule($name)      
- *  384:     function checkMod($name, $fullpath)       
- *  444:     function checkModAccess($name,$MCONF)     
- *  467:     function parseModulesArray ($arr) 
- *  497:     function cleanName ($str) 
- *  508:     function getRelativePath($baseDir,$destDir)
+ *   78: class t3lib_loadModules 
+ *   97:     function load($modulesArray,$BE_USER='')  
+ *  366:     function checkExtensionModule($name)      
+ *  385:     function checkMod($name, $fullpath)       
+ *  458:     function checkModAccess($name,$MCONF)     
+ *  481:     function parseModulesArray ($arr) 
+ *  511:     function cleanName ($str) 
+ *  522:     function getRelativePath($baseDir,$destDir)
  *
  * TOTAL FUNCTIONS: 7
  * (This index is automatically created/updated by the extension "extdeveval")
 
 /**
  * Load Backend Interface modules
- * 
+ *
  * Typically instantiated like this:
  *             $this->loadModules = t3lib_div::makeInstance('t3lib_loadModules');
  *             $this->loadModules->load($TBE_MODULES);
- * 
- * @author     Kasper Skårhøj <kasper@typo3.com>
+ *
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @package TYPO3
+ * @subpackage t3lib
  */
 class t3lib_loadModules {
        var $modules = Array();         // After the init() function this array will contain the structure of available modules for the backend user.
@@ -88,10 +89,10 @@ class t3lib_loadModules {
         * Init.
         * The outcome of the load() function will be a $this->modules array populated with the backend module structure available to the BE_USER
         * Further the global var $LANG will have labels and images for the modules loaded in an internal array.
-        * 
+        *
         * @param       array           $modulesArray should be the global var $TBE_MODULES, $BE_USER can optionally be set to an alternative Backend user object than the global var $BE_USER (which is the currently logged in user)
         * @param       object          Optional backend user object to use. If not set, the global BE_USER object is used.
-        * @return      void            
+        * @return      void
         */
        function load($modulesArray,$BE_USER='')        {
                        // Setting the backend user for use internally
@@ -358,7 +359,7 @@ class t3lib_loadModules {
 
        /**
         * If the module name ($name) is a module from an extension (has path in $this->absPathArray) then that path is returned relative to PATH_site
-        * 
+        *
         * @param       string          Module name
         * @return      string          If found, the relative path from PATH_site
         */
@@ -376,7 +377,7 @@ class t3lib_loadModules {
         *      'notFound':     If the module was not found in the path
         *      false:          If no access to the module
         *      array():        Configuration array, in case a valid module where access IS granted exists.
-        * 
+        *
         * @param       string          Module name
         * @param       string          Absolute path to module
         * @return      mixed           See description of function
@@ -393,7 +394,20 @@ class t3lib_loadModules {
                                                // $MLANG['default']['tabs_images']['tab'] is for modules the reference to the module icon.
                                                // Here the path is transformed to an absolute reference.
                                        if ($MLANG['default']['tabs_images']['tab'])    {
-                                               $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$fullpath.'/'.$MLANG['default']['tabs_images']['tab']);
+                                               
+                                                       // Initializing search for alternative icon:
+                                               $altIconKey = 'MOD:'.$name.'/'.$MLANG['default']['tabs_images']['tab'];         // Alternative icon key (might have an alternative set in $TBE_STYLES['skinImg']
+                                               $altIconAbsPath = is_array($GLOBALS['TBE_STYLES']['skinImg'][$altIconKey]) ? t3lib_div::resolveBackPath(PATH_typo3.$GLOBALS['TBE_STYLES']['skinImg'][$altIconKey][0]) : '';
+
+                                                       // Setting icon, either default or alternative:
+                                               if ($altIconAbsPath && @is_file($altIconAbsPath))       {
+                                                       $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$altIconAbsPath);
+                                               } else {
+                                                               // Setting default icon:
+                                                       $MLANG['default']['tabs_images']['tab']=$this->getRelativePath(PATH_typo3,$fullpath.'/'.$MLANG['default']['tabs_images']['tab']);
+                                               }
+                       
+                                                       // Finally, setting the icon with correct path:
                                                if (substr($MLANG['default']['tabs_images']['tab'],0,3)=='../') {
                                                        $MLANG['default']['tabs_images']['tab'] = PATH_site.substr($MLANG['default']['tabs_images']['tab'],3);
                                                } else {
@@ -436,7 +450,7 @@ class t3lib_loadModules {
 
        /**
         * Returns true if the internal BE_USER has access to the module $name with $MCONF (based on security level set for that module)
-        * 
+        *
         * @param       string          Module name
         * @param       array           MCONF array (module configuration array) from the modules conf.php file (contains settings about what access level the module has)
         * @return      boolean         True if access is granted for $this->BE_USER
@@ -460,7 +474,7 @@ class t3lib_loadModules {
        /**
         * Parses the moduleArray ($TBE_MODULES) into a internally useful structure.
         * Returns an array where the keys are names of the module and the values may be true (only module) or an array (of submodules)
-        * 
+        *
         * @param       array           moduleArray ($TBE_MODULES)
         * @return      array           Output structure with available modules
         */
@@ -490,9 +504,9 @@ class t3lib_loadModules {
 
        /**
         * The $str is cleaned so that it contains alphanumerical characters only. Modules must only consist of these characters
-        * 
-        * @param       string          
-        * @return      string          
+        *
+        * @param       string          String to clean up
+        * @return      string
         */
        function cleanName ($str)       {
                return ereg_replace('[^A-Za-z0-9]*','',$str);
@@ -500,7 +514,7 @@ class t3lib_loadModules {
 
        /**
         * Get relative path for $destDir compared to $baseDir
-        * 
+        *
         * @param       string          Base directory
         * @param       string          Destination directory
         * @return      string          The relative path of destination compared to base.