Fixed bug #10735: Wrong returnUrl with clipboard actions
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_arraybrowser.php
index 64d5d2e..0920645 100644 (file)
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *
-*  (c) 1999-2004 Kasper Skaarhoj (kasper@typo3.com)
+*  (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
  * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
  * XHTML compliant
  *
- * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
  */
 /**
  * [CLASS/FUNCTION INDEX of SCRIPT]
  *
  *
  *
- *   75: class t3lib_arrayBrowser
- *   91:     function tree($arr, $depth_in, $depthData)
- *  154:     function getSearchKeys($keyArr, $depth_in, $searchString, $keyArray)
- *  186:     function fixed_lgd($string,$chars)
- *  203:     function depthKeys($arr,$settings)
+ *   77: class t3lib_arrayBrowser
+ *   96:     function tree($arr, $depth_in, $depthData)
+ *  160:     function wrapValue($theValue,$depth)
+ *  172:     function wrapArrayKey($label,$depth,$theValue)
+ *  196:     function getSearchKeys($keyArr, $depth_in, $searchString, $keyArray)
+ *  228:     function fixed_lgd($string,$chars)
+ *  245:     function depthKeys($arr,$settings)
  *
- * TOTAL FUNCTIONS: 4
+ * TOTAL FUNCTIONS: 6
  * (This index is automatically created/updated by the extension "extdeveval")
  *
  */
  * Class for displaying an array as a tree
  * See the extension 'lowlevel' /config (Backend module 'Tools > Configuration')
  *
- * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  * @see SC_mod_tools_config_index::main()
  */
 class t3lib_arrayBrowser       {
+       var $expAll = FALSE;                    // If set, will expand all (depthKeys is obsolete then) (and no links are applied)
+       var $dontLinkVar = FALSE;               // If set, the variable keys are not linked.
        var $depthKeys = array();               // Array defining which keys to expand. Typically set from outside from some session variable - otherwise the array will collapse.
        var $searchKeys = array();              // After calling the getSearchKeys function this array is populated with the key-positions in the array which contains values matching the search.
        var $fixedLgd=1;                                // If set, the values are truncated with "..." appended if longer than a certain length.
        var $regexMode=0;                               // If set, search for string with regex, otherwise stristr()
+       var $searchKeysToo=FALSE;               // If set, array keys are subject to the search too.
+       var $varName='';                                // Set var name here if you want links to the variable name.
 
        /**
         * Make browsable tree
@@ -98,10 +104,10 @@ class t3lib_arrayBrowser   {
                reset($arr);
                while (list($key,)=each($arr))  {
                        $a++;
-                       $depth=$depth_in.$key;
+                       $depth = $depth_in.$key;
                        $goto = substr(md5($depth),0,6);
 
-                       $deeper = (is_array($arr[$key]) && $this->depthKeys[$depth]) ? 1 : 0;
+                       $deeper = (is_array($arr[$key]) && ($this->depthKeys[$depth] || $this->expAll)) ? 1 : 0;
                        $PM = 'join';
                        $LN = ($a==$c)?'blank':'line';
                        $BTM = ($a==$c)?'bottom':'';
@@ -113,11 +119,14 @@ class t3lib_arrayBrowser  {
                        if ($PM=='join')        {
                                $HTML.=$theIcon;
                        } else {
-                               $HTML.='<a name="'.$goto.'" href="'.htmlspecialchars('index.php?node['.$depth.']='.($deeper?0:1).'#'.$goto).'">'.$theIcon.'</a>';
+                               $HTML.=
+                                       ($this->expAll ? '' : '<a name="'.$goto.'" href="'.htmlspecialchars('index.php?node['.$depth.']='.($deeper?0:1).'#'.$goto).'">').
+                                       $theIcon.
+                                       ($this->expAll ? '' : '</a>');
                        }
 
                        $label = $key;
-                       $HTML.='['.$label.']';
+                       $HTML.= $this->wrapArrayKey($label,$depth,!is_array($arr[$key]) ? $arr[$key] : '');
 
                        if (!is_array($arr[$key]))      {
                                $theValue = $arr[$key];
@@ -128,9 +137,9 @@ class t3lib_arrayBrowser    {
                                        $theValue = $this->fixed_lgd($theValue,$lgdChars);
                                }
                                if ($this->searchKeys[$depth])  {
-                                       $HTML.='=<b><span style="color:red;">'.htmlspecialchars($theValue).'</font></b>';
+                                       $HTML.='=<span style="color:red;">'.$this->wrapValue($theValue,$depth).'</span>';
                                } else {
-                                       $HTML.='=<b>'.htmlspecialchars($theValue).'</b>';
+                                       $HTML.='='.$this->wrapValue($theValue,$depth);
                                }
                        }
                        $HTML.='<br />';
@@ -143,6 +152,40 @@ class t3lib_arrayBrowser   {
        }
 
        /**
+        * Wrapping the value in bold tags etc.
+        *
+        * @param       string          The title string
+        * @param       string          Depth path
+        * @return      string          Title string, htmlspecialchars()'ed
+        */
+       function wrapValue($theValue,$depth)    {
+               return '<b>'.htmlspecialchars($theValue).'</b>';
+       }
+
+       /**
+        * Wrapping the value in bold tags etc.
+        *
+        * @param       string          The title string
+        * @param       string          Depth path
+        * @param       string          The value for the array entry.
+        * @return      string          Title string, htmlspecialchars()'ed
+        */
+       function wrapArrayKey($label,$depth,$theValue)  {
+
+                       // Protect label:
+               $label = htmlspecialchars($label);
+
+                       // If varname is set:
+               if ($this->varName && !$this->dontLinkVar) {
+                       $variableName = $this->varName.'[\''.str_replace('.','\'][\'',$depth).'\'] = '.(!t3lib_div::testInt($theValue) ? '\''.addslashes($theValue).'\'' : $theValue).'; ';
+                       $label = '<a href="'.htmlspecialchars('index.php?varname='.$variableName.'#varname').'">'.$label.'</a>';
+               }
+
+                       // Return:
+               return '['.$label.']';
+       }
+
+       /**
         * Creates an array with "depthKeys" which will expand the array to show the search results
         *
         * @param       array           The array to search for the value
@@ -160,9 +203,9 @@ class t3lib_arrayBrowser    {
                        $deeper = is_array($keyArr[$key]);
 
                        if ($this->regexMode)   {
-                               if (ereg($searchString,$keyArr[$key]))  {       $this->searchKeys[$depth]=1;    }
+                               if (ereg($searchString,$keyArr[$key]) || ($this->searchKeysToo && ereg($searchString,$key)))    {       $this->searchKeys[$depth]=1;    }
                        } else {
-                               if (stristr($keyArr[$key],$searchString)      {       $this->searchKeys[$depth]=1;    }
+                               if (stristr($keyArr[$key],$searchString) || ($this->searchKeysToo && stristr($key,$searchString)))      {       $this->searchKeys[$depth]=1;    }
                        }
 
                        if ($deeper)    {