ArrayBrowser.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Lowlevel\Utility;

class ArrayBrowser {

    public $expAll = FALSE;

    // If set, will expand all (depthKeys is obsolete then) (and no links are applied)
    public $dontLinkVar = FALSE;

    // If set, the variable keys are not linked.
    public $depthKeys = array();

    // Array defining which keys to expand. Typically set from outside from some session variable - otherwise the array will collapse.
    public $searchKeys = array();

    // After calling the getSearchKeys function this array is populated with the key-positions in the array which contains values matching the search.
    public $fixedLgd = 1;

    // If set, the values are truncated with "..." appended if longer than a certain length.
    public $regexMode = 0;

    // If set, search for string with regex, otherwise stristr()
    public $searchKeysToo = FALSE;

    // If set, array keys are subject to the search too.
    public $varName = '';

    // Set var name here if you want links to the variable name.
    public function tree($arr, $depth_in, $depthData) {
        $HTML = '';
        $a = 0;
        if ($depth_in) {
            $depth_in = $depth_in . '.';
        }
        $c = count($arr);
        foreach ($arr as $key => $value) {
            $a++;
            $depth = $depth_in . $key;
            $goto = 'a' . substr(md5($depth), 0, 6);
            if (is_object($value) && !$value instanceof \Traversable) {
                $value = (array)$value;
            }
            $isArray = is_array($value) || $value instanceof \Traversable;
            $deeper = $isArray && ($this->depthKeys[$depth] || $this->expAll);
            $LN = $a == $c ? 'blank' : 'line';
            $BTM = $a == $c ? 'bottom' : '';
            $PM = $isArray ? ($deeper ? 'minus' : 'plus') : 'join';
            $HTML .= $depthData;
            $theIcon = '<img' . \TYPO3\CMS\Backend\Utility\IconUtility::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 .= ($this->expAll ? '' : '<a id="' . $goto . '" href="' . htmlspecialchars((\TYPO3\CMS\Backend\Utility\BackendUtility::getModuleUrl(\TYPO3\CMS\Core\Utility\GeneralUtility::_GP('M')) . '&node[' . $depth . ']=' . ($deeper ? 0 : 1) . '#' . $goto)) . '">') . $theIcon . ($this->expAll ? '' : '</a>');
            }
            $label = $key;
            $HTML .= $this->wrapArrayKey($label, $depth, !$isArray ? $value : '');
            if (!$isArray) {
                $theValue = $value;
                if ($this->fixedLgd) {
                    $imgBlocks = ceil(1 + strlen($depthData) / 77);
                    $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) . '</span>';
                } else {
                    $HTML .= '=' . $this->wrapValue($theValue, $depth);
                }
            }
            $HTML .= '<br />';
            if ($deeper) {
                $HTML .= $this->tree($value, $depth, $depthData . '<img' . \TYPO3\CMS\Backend\Utility\IconUtility::skinImg($GLOBALS['BACK_PATH'], ('gfx/ol/' . $LN . '.gif'), 'width="18" height="16"') . ' align="top" alt="" />');
            }
        }
        return $HTML;
    }

    public function wrapValue($theValue, $depth) {
        $wrappedValue = '';
        if (strlen($theValue) > 0) {
            $wrappedValue = '<strong>' . htmlspecialchars($theValue) . '</strong>';
        }
        return $wrappedValue;
    }

    public 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) . '\'] = ' . (!\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($theValue) ? '\'' . addslashes($theValue) . '\'' : $theValue) . '; ';
            $label = '<a href="' . htmlspecialchars((\TYPO3\CMS\Backend\Utility\BackendUtility::getModuleUrl(\TYPO3\CMS\Core\Utility\GeneralUtility::_GP('M')) . '&varname=' . urlencode($variableName))) . '#varname">' . $label . '</a>';
        }
        // Return:
        return '[' . $label . ']';
    }

    public function getSearchKeys($keyArr, $depth_in, $searchString, $keyArray) {
        $c = count($keyArr);
        if ($depth_in) {
            $depth_in = $depth_in . '.';
        }
        foreach ($keyArr as $key => $value) {
            $depth = $depth_in . $key;
            $deeper = is_array($keyArr[$key]);
            if ($this->regexMode) {
                if (is_scalar($keyArr[$key]) && preg_match('/' . $searchString . '/', $keyArr[$key]) || $this->searchKeysToo && preg_match('/' . $searchString . '/', $key)) {
                    $this->searchKeys[$depth] = 1;
                }
            } else {
                if (is_scalar($keyArr[$key]) && stristr($keyArr[$key], $searchString) || $this->searchKeysToo && stristr($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;
    }

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

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

}