class.t3lib_arraybrowser.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
class t3lib_arrayBrowser   {
   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 $varName='';           // Set var name here if you want links to the variable name.

   function tree($arr, $depth_in, $depthData)   {
      $HTML='';
      $a=0;

      if ($depth_in) {$depth_in = $depth_in.'.';}

      $c=count($arr);
      reset($arr);
      while (list($key,)=each($arr))   {
         $a++;
         $depth = $depth_in.$key;
         $goto = substr(md5($depth),0,6);

         $deeper = (is_array($arr[$key]) && $this->depthKeys[$depth]) ? 1 : 0;
         $PM = 'join';
         $LN = ($a==$c)?'blank':'line';
         $BTM = ($a==$c)?'bottom':'';
         $PM = is_array($arr[$key]) ? ($deeper ? 'minus':'plus') : 'join';


         $HTML.=$depthData;
         $theIcon='<img'.t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'],'gfx/ol/'.$PM.$BTM.'.gif','width="18" height="16"').' align="top" border="0" alt="" />';
         if ($PM=='join')  {
            $HTML.=$theIcon;
         } else {
            $HTML.='<a name="'.$goto.'" href="'.htmlspecialchars('index.php?node['.$depth.']='.($deeper?0:1).'#'.$goto).'">'.$theIcon.'</a>';
         }

         $label = $key;
         $HTML.= $this->wrapArrayKey($label,$depth,!is_array($arr[$key]) ? $arr[$key] : '');

         if (!is_array($arr[$key])) {
            $theValue = $arr[$key];
            if ($this->fixedLgd) {
               $imgBlocks = ceil(1+strlen($depthData)/77);
//             debug($imgBlocks);
               $lgdChars = 68-ceil(strlen('['.$key.']')*0.8)-$imgBlocks*3;
               $theValue = $this->fixed_lgd($theValue,$lgdChars);
            }
            if ($this->searchKeys[$depth])   {
               $HTML.='=<span style="color:red;">'.$this->wrapValue($theValue,$depth).'</font>';
            } else {
               $HTML.='='.$this->wrapValue($theValue,$depth);
            }
         }
         $HTML.='<br />';

         if ($deeper)   {
            $HTML.=$this->tree($arr[$key], $depth, $depthData.'<img'.t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'],'gfx/ol/'.$LN.'.gif','width="18" height="16"').' align="top" alt="" />');
         }
      }
      return $HTML;
   }

   function wrapValue($theValue,$depth)   {
      return '<b>'.htmlspecialchars($theValue).'</b>';
   }

   function wrapArrayKey($label,$depth,$theValue)  {

         // Protect label:
      $label = htmlspecialchars($label);

         // If varname is set:
      if ($this->varName) {
         $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.']';
   }

   function getSearchKeys($keyArr, $depth_in, $searchString, $keyArray)    {
      reset($keyArr);
      $c=count($keyArr);
      if ($depth_in) {$depth_in = $depth_in.'.';}
      while (list($key,)=each($keyArr))   {
         $depth=$depth_in.$key;
         $deeper = is_array($keyArr[$key]);

         if ($this->regexMode)   {
            if (ereg($searchString,$keyArr[$key])) {  $this->searchKeys[$depth]=1;  }
         } else {
            if (stristr($keyArr[$key],$searchString)) {  $this->searchKeys[$depth]=1;  }
         }

         if ($deeper)   {
            $cS = count($this->searchKeys);
            $keyArray = $this->getSearchKeys($keyArr[$key], $depth, $searchString, $keyArray);
            if ($cS != count($this->searchKeys))   {
               $keyArray[$depth]=1;
            }
         }
      }
      return $keyArray;
   }

   function fixed_lgd($string,$chars)  {
      if ($chars >= 4)  {
         if(strlen($string)>$chars)  {
            return substr($string, 0, $chars-3).'...';
         }
      }
      return $string;
   }

   function depthKeys($arr,$settings)  {
      $tsbrArray=array();
      reset($arr);
      while(list($theK,$theV)=each($arr)) {
         $theKeyParts = explode('.',$theK);
         $depth='';
         $c=count($theKeyParts);
         $a=0;
         while(list(,$p)=each($theKeyParts)) {
            $a++;
            $depth.=($depth?'.':'').$p;
            $tsbrArray[$depth]= ($c==$a) ? $theV : 1;
         }
      }
         // Modify settings
      reset($tsbrArray);
      while(list($theK,$theV)=each($tsbrArray)) {
         if ($theV)  {
            $settings[$theK] = 1;
         } else {
            unset($settings[$theK]);
         }
      }
      return $settings;
   }
}

if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_arraybrowser.php'])  {
   include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_arraybrowser.php']);
}
?>

---