*** empty log message ***
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_tsstyleconfig.php
index 98045d6..457a420 100755 (executable)
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *  
-*  (c) 1999-2003 Kasper Skårhøj (kasper@typo3.com)
+*  (c) 1999-2003 Kasper Skaarhoj (kasper@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is 
 /** 
  * Provides a simplified layer for making Constant Editor style configuration forms
  *
- * @author     Kasper Skårhøj <kasper@typo3.com>
- * @package TYPO3
- * @subpackage t3lib
+ * $Id$
+ *
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ */
+/**
+ * [CLASS/FUNCTION INDEX of SCRIPT]
+ *
+ *
+ *
+ *   79: class t3lib_tsStyleConfig extends t3lib_tsparser_ext  
+ *   98:     function ext_initTSstyleConfig($configTemplate,$pathRel,$pathAbs,$backPath)       
+ *  118:     function ext_setValueArray($theConstants,$valueArray)     
+ *  145:     function ext_getCategoriesForModMenu()    
+ *  155:     function ext_makeHelpInformationForCategory($cat) 
+ *  168:     function ext_getForm($cat,$theConstants,$script="",$addFields="") 
+ *  175:     function uFormUrl(aname)  
+ *  197:     function ext_displayExample()     
+ *  213:     function ext_mergeIncomingWithExisting($arr)      
+ *  221:     function ext_getKeyImage($key)    
+ *  231:     function ext_getTSCE_config_image($imgConf)       
+ *  244:     function ext_fNandV($params)      
+ *  261:     function ext_loadResources($absPath)      
+ *  277:     function ext_putValueInConf($key, $var)   
+ *  287:     function ext_removeValueInConf($key)      
+ *
+ * TOTAL FUNCTIONS: 14
+ * (This index is automatically created/updated by the extension "extdeveval")
+ *
  */
 
+require_once(PATH_t3lib.'class.t3lib_tsparser_ext.php');
+
+
+
+
+
+
+
+
+
 
-require_once(PATH_t3lib."class.t3lib_tsparser_ext.php");
 
+/**
+ * Provides a simplified layer for making Constant Editor style configuration forms
+ * 
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @package TYPO3
+ * @subpackage t3lib
+ */
 class t3lib_tsStyleConfig extends t3lib_tsparser_ext   {
                // internal
        var $categories = array();
@@ -46,9 +87,14 @@ class t3lib_tsStyleConfig extends t3lib_tsparser_ext {
        
        var $ext_incomingValues = array();
 
-               // pathRel is the path relative to the typo3/ directory
-               // pathAbs is the absolute path from root
-               // backPath is the backReference from current position to typo3/ dir
+       
+       /**
+        * @param       string          pathRel is the path relative to the typo3/ directory
+        * @param       string          pathAbs is the absolute path from root
+        * @param       string          backPath is the backReference from current position to typo3/ dir
+        * @param       [type]          $backPath: ...
+        * @return      [type]          ...
+        */
        function ext_initTSstyleConfig($configTemplate,$pathRel,$pathAbs,$backPath)     {
                $this->tt_track = 0;    // Do not log time-performance information
                $this->constants=array($configTemplate,"");
@@ -61,6 +107,14 @@ class t3lib_tsStyleConfig extends t3lib_tsparser_ext        {
 
                return $theConstants;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $theConstants: ...
+        * @param       [type]          $valueArray: ...
+        * @return      [type]          ...
+        */
        function ext_setValueArray($theConstants,$valueArray)   {
 
                $temp = $this->flatSetup;
@@ -82,12 +136,35 @@ class t3lib_tsStyleConfig extends t3lib_tsparser_ext       {
 
                return $theConstants;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @return      [type]          ...
+        */
        function ext_getCategoriesForModMenu()  {
                return $this->ext_getCategoryLabelArray();
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $cat: ...
+        * @return      [type]          ...
+        */
        function ext_makeHelpInformationForCategory($cat)       {
                return $this->ext_getTSCE_config($cat);
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $cat: ...
+        * @param       [type]          $theConstants: ...
+        * @param       [type]          $script: ...
+        * @param       [type]          $addFields: ...
+        * @return      [type]          ...
+        */
        function ext_getForm($cat,$theConstants,$script="",$addFields="")       {
                $this->ext_makeHelpInformationForCategory($cat);
                $printFields = trim($this->ext_printFields($theConstants,$cat));
@@ -111,6 +188,12 @@ class t3lib_tsStyleConfig extends t3lib_tsparser_ext       {
                
                return $content;        
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @return      [type]          ...
+        */
        function ext_displayExample()   {
                global $SOBE,$tmpl;
                if ($this->helpConfig["imagetag"] || $this->helpConfig["description"] || $this->helpConfig["header"])   {
@@ -120,6 +203,13 @@ class t3lib_tsStyleConfig extends t3lib_tsparser_ext       {
                }
                return $out;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $arr: ...
+        * @return      [type]          ...
+        */
        function ext_mergeIncomingWithExisting($arr)    {
                $parseObj = t3lib_div::makeInstance("t3lib_TSparser");
                $parseObj->parse(implode(chr(10),$this->ext_incomingValues));
@@ -131,12 +221,26 @@ class t3lib_tsStyleConfig extends t3lib_tsparser_ext      {
        function ext_getKeyImage($key)  {
                return '<img src="'.$this->ext_backPath.'gfx/rednumbers/'.$key.'.gif" align="top" hspace=2>';
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $imgConf: ...
+        * @return      [type]          ...
+        */
        function ext_getTSCE_config_image($imgConf)     {
                $iFile=$this->ext_localGfxPrefix.$imgConf;
                $tFile=$this->ext_localWebGfxPrefix.$imgConf;
                $imageInfo=@getImagesize($iFile);
                return '<img src="'.$tFile.'" '.$imageInfo[3].'>';
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $params: ...
+        * @return      [type]          ...
+        */
        function ext_fNandV($params)    {
                $fN='data['.$params["name"].']';
                $fV=$params["value"]=isset($this->ext_realValues[$params["name"]]) ? $this->ext_realValues[$params["name"]] : $params["default_value"];
@@ -147,6 +251,13 @@ class t3lib_tsStyleConfig extends t3lib_tsparser_ext       {
 #debug(array($params,$fN,$fV,isset($this->ext_realValues[$params["name"]])));
                return array($fN,$fV,$params);
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $absPath: ...
+        * @return      [type]          ...
+        */
        function ext_loadResources($absPath)    {
                $this->ext_readDirResources($GLOBALS["TYPO3_CONF_VARS"]["MODS"]["web_ts"]["onlineResourceDir"]);
                if (is_dir($absPath))   {
@@ -156,19 +267,30 @@ class t3lib_tsStyleConfig extends t3lib_tsparser_ext      {
                $this->ext_resourceDims();
        }
 
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $key: ...
+        * @param       [type]          $var: ...
+        * @return      [type]          ...
+        */
        function ext_putValueInConf($key, $var) {
                $this->ext_incomingValues[$key]=$key."=".$var;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $key: ...
+        * @return      [type]          ...
+        */
        function ext_removeValueInConf($key)    {
                // Nothing...
        }
 }
 
 
-
-
-if (defined("TYPO3_MODE") && $TYPO3_CONF_VARS[TYPO3_MODE]["XCLASS"]["t3lib/class.t3lib_tsstyleconfig.php"])    {
-       include_once($TYPO3_CONF_VARS[TYPO3_MODE]["XCLASS"]["t3lib/class.t3lib_tsstyleconfig.php"]);
+if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsstyleconfig.php'])    {
+       include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsstyleconfig.php']);
 }
-
 ?>
\ No newline at end of file