ArrayBrowser::depthKeys() - Code Metrics - Inspection of "[TASK] Move ArrayBrowser to EXT:backend" - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3ef1ae...4ba2eb )

unknown

created 2020-03-27 13:08 UTC

ArrayBrowser::depthKeys() B

↳ Parent: ArrayBrowser

Complexity

Conditions	7
Paths	18

Size

Total Lines	23
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	16
nc	18
nop	2
dl	0
loc	23
rs	8.8333
c	0
b	0
f	0

<?php
declare(strict_types = 1);

namespace TYPO3\CMS\Backend\View;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Backend\Routing\Route;
use TYPO3\CMS\Backend\Routing\UriBuilder;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Class for displaying an array as a tree which can collapse / expand.
 *
 * See the extension 'lowlevel' / config (Backend module 'Tools > Configuration')
 * @internal just a helper class for internal usage.
 */
class ArrayBrowser
{
    /**
     * @var bool
     */
    public $expAll = false;

    /**
     * If set, the variable keys are not linked.
     *
     * @var array
     */
    public $depthKeys = [];

    /**
     * Array defining which keys to expand. Typically set from outside from some session
     * variable - otherwise the array will collapse.
     *
     * @var array
     */
    public $searchKeys = [];

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

    /**
     * If set, search for string with regex, otherwise stristr()
     *
     * @var bool
     */
    public $searchKeysToo = true;

    /**
     * @var UriBuilder
     */
    protected $uriBuilder;

    /**
     * If null then there are no links set.
     *
     * @var Route|null
     */
    protected $route;

    public function __construct(Route $route = null)
    {
        $this->route = $route;
        $this->uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
    }

    /**
     * Set var name here if you want links to the variable name.
     *
     * Make browsable tree
     * Before calling this function you may want to set some of the internal vars like
     * depthKeys and regexMode.
     *
     * @param array $array The array to display
     * @param string $positionKey Key-position id. Build up during recursive calls - [key1].[key2].[key3] - and so on.
     * @return string HTML for the tree
     */
    public function tree($array, $positionKey)
    {
        $output = '<ul class="list-tree text-monospace">';
        if ($positionKey) {
            $positionKey .= '.';
        }
        foreach ($array as $key => $value) {
            $depth = $positionKey . $key;
            if (is_object($value) && !$value instanceof \Traversable) {
                $value = (array)$value;
            }
            $isArray = is_iterable($value);
            $isResult = (bool)$this->searchKeys[$depth];
            $isExpanded = $isArray && (!empty($this->depthKeys[$depth]) || $this->expAll);
            $output .= '<li' . ($isResult ? ' class="active"' : '') . '>';
            $output .= '<span class="list-tree-group">';
            if ($isArray && !$this->expAll && $this->route) {
                $goto = 'a' . substr(md5($depth), 0, 6);
                $output .= '<a class="list-tree-control' . ($isExpanded ? ' list-tree-control-open' : ' list-tree-control-closed') . '" id="' . $goto . '" href="' . htmlspecialchars((string)$this->uriBuilder->buildUriFromRoute($this->route->getOption('_identifier'), ['node' => [rawurldecode($depth) => $isExpanded ? 0 : 1]]) . '#' . $goto) . '"><i class="fa"></i></a> ';
            }
            $output .= '<span class="list-tree-label">' . htmlspecialchars($key) . '</span>';
            if (!$isArray) {
                $output .= ' = <span class="list-tree-value">' . htmlspecialchars($value) . '</span>';
            }
            $output .= '</span>';
            if ($isExpanded) {
                $output .= $this->tree(
                    $value,
                    $depth
                );
            }
            $output .= '</li>';
        }
        $output .= '</ul>';
        return $output;
    }

    /**
     * Creates an array with "depthKeys" which will expand the array to show the search results
     *
     * @param array $keyArr The array to search for the value
     * @param string $depth_in Depth string - blank for first call (will build up during recursive calling creating
     *                         an id of the position: [key1].[key2].[key3]
     * @param string $searchString The string to search for
     * @param array $keyArray Key array, for first call pass empty array
     * @return array
     */
    public function getSearchKeys($keyArr, $depth_in, $searchString, $keyArray)
    {
        if ($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]) && stripos($keyArr[$key], $searchString) !== false

                    || $this->searchKeysToo && stripos($key, $searchString) !== false
                ) {
                    $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 modifying the depthKey array
     *
     * @param array $arr Array with instructions to open/close nodes.
     * @param array $settings Input depth_key array
     * @return array Output depth_key array with entries added/removed based on $arr
     */
    public function depthKeys($arr, $settings)
    {
        $tsbrArray = [];
        foreach ($arr as $theK => $theV) {
            $theKeyParts = explode('.', (string)$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;
    }
}


1			<?php
2			declare(strict_types = 1);
3
4			namespace TYPO3\CMS\Backend\View;
5
6			/*
7			* This file is part of the TYPO3 CMS project.
8			*
9			* It is free software; you can redistribute it and/or modify it under
10			* the terms of the GNU General Public License, either version 2
11			* of the License, or any later version.
12			*
13			* For the full copyright and license information, please read the
14			* LICENSE.txt file that was distributed with this source code.
15			*
16			* The TYPO3 project - inspiring people to share!
17			*/
18
19			use TYPO3\CMS\Backend\Routing\Route;
20			use TYPO3\CMS\Backend\Routing\UriBuilder;
21			use TYPO3\CMS\Core\Utility\GeneralUtility;
22
23			/**
24			* Class for displaying an array as a tree which can collapse / expand.
25			*
26			* See the extension 'lowlevel' / config (Backend module 'Tools > Configuration')
27			* @internal just a helper class for internal usage.
28			*/
29			class ArrayBrowser
30			{
31			/**
32			* @var bool
33			*/
34			public $expAll = false;
35
36			/**
37			* If set, the variable keys are not linked.
38			*
39			* @var array
40			*/
41			public $depthKeys = [];
42
43			/**
44			* Array defining which keys to expand. Typically set from outside from some session
45			* variable - otherwise the array will collapse.
46			*
47			* @var array
48			*/
49			public $searchKeys = [];
50
51			/**
52			* If set, the values are truncated with "..." appended if longer than a certain
53			* length.
54			*
55			* @var int
56			*/
57			public $regexMode = 0;
58
59			/**
60			* If set, search for string with regex, otherwise stristr()
61			*
62			* @var bool
63			*/
64			public $searchKeysToo = true;
65
66			/**
67			* @var UriBuilder
68			*/
69			protected $uriBuilder;
70
71			/**
72			* If null then there are no links set.
73			*
74			* @var Route\|null
75			*/
76			protected $route;
77
78			public function __construct(Route $route = null)
79			{
80			$this->route = $route;
81			$this->uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
82			}
83
84			/**
85			* Set var name here if you want links to the variable name.
86			*
87			* Make browsable tree
88			* Before calling this function you may want to set some of the internal vars like
89			* depthKeys and regexMode.
90			*
91			* @param array $array The array to display
92			* @param string $positionKey Key-position id. Build up during recursive calls - [key1].[key2].[key3] - and so on.
93			* @return string HTML for the tree
94			*/
95			public function tree($array, $positionKey)
96			{
97			$output = '<ul class="list-tree text-monospace">';
98			if ($positionKey) {
99			$positionKey .= '.';
100			}
101			foreach ($array as $key => $value) {
102			$depth = $positionKey . $key;
103			if (is_object($value) && !$value instanceof \Traversable) {
104			$value = (array)$value;
105			}
106			$isArray = is_iterable($value);
107			$isResult = (bool)$this->searchKeys[$depth];
108			$isExpanded = $isArray && (!empty($this->depthKeys[$depth]) \|\| $this->expAll);
109			$output .= '<li' . ($isResult ? ' class="active"' : '') . '>';
110			$output .= '<span class="list-tree-group">';
111			if ($isArray && !$this->expAll && $this->route) {
112			$goto = 'a' . substr(md5($depth), 0, 6);
113			$output .= '<a class="list-tree-control' . ($isExpanded ? ' list-tree-control-open' : ' list-tree-control-closed') . '" id="' . $goto . '" href="' . htmlspecialchars((string)$this->uriBuilder->buildUriFromRoute($this->route->getOption('_identifier'), ['node' => [rawurldecode($depth) => $isExpanded ? 0 : 1]]) . '#' . $goto) . '"><i class="fa"></i></a> ';
114			}
115			$output .= '<span class="list-tree-label">' . htmlspecialchars($key) . '</span>';
116			if (!$isArray) {
117			$output .= ' = <span class="list-tree-value">' . htmlspecialchars($value) . '</span>';
118			}
119			$output .= '</span>';
120			if ($isExpanded) {
121			$output .= $this->tree(
122			$value,
123			$depth
124			);
125			}
126			$output .= '</li>';
127			}
128			$output .= '</ul>';
129			return $output;
130			}
131
132			/**
133			* Creates an array with "depthKeys" which will expand the array to show the search results
134			*
135			* @param array $keyArr The array to search for the value
136			* @param string $depth_in Depth string - blank for first call (will build up during recursive calling creating
137			* an id of the position: [key1].[key2].[key3]
138			* @param string $searchString The string to search for
139			* @param array $keyArray Key array, for first call pass empty array
140			* @return array
141			*/
142			public function getSearchKeys($keyArr, $depth_in, $searchString, $keyArray)
143			{
144			if ($depth_in) {
145			$depth_in .= '.';
146			}
147			foreach ($keyArr as $key => $value) {
148			$depth = $depth_in . $key;
149			$deeper = is_array($keyArr[$key]);
150			if ($this->regexMode) {
151			if (
152			is_scalar($keyArr[$key]) && preg_match('/' . $searchString . '/', $keyArr[$key])
			0 ignored issues – show introduced 2018-05-31 17:45 UTC by Report Bug Copy Issue Report Consider adding parentheses for clarity. Current Interpretation: `(is_scalar($keyArr[$key]...archString . '/', $key)`, Probably Intended Meaning: `is_scalar($keyArr[$key])...rchString . '/', $key))` Loading history...
153			\|\| $this->searchKeysToo && preg_match('/' . $searchString . '/', $key)
154			) {
155			$this->searchKeys[$depth] = 1;
156			}
157			} else {
158			if (
159			is_scalar($keyArr[$key]) && stripos($keyArr[$key], $searchString) !== false
			0 ignored issues – show introduced 2019-08-23 10:19 UTC by Report Bug Copy Issue Report Consider adding parentheses for clarity. Current Interpretation: `(is_scalar($keyArr[$key]...searchString) !== false`, Probably Intended Meaning: `is_scalar($keyArr[$key])...earchString) !== false)` Loading history...
160			\|\| $this->searchKeysToo && stripos($key, $searchString) !== false
161			) {
162			$this->searchKeys[$depth] = 1;
163			}
164			}
165			if ($deeper) {
166			$cS = count($this->searchKeys);
167			$keyArray = $this->getSearchKeys($keyArr[$key], $depth, $searchString, $keyArray);
168			if ($cS != count($this->searchKeys)) {
169			$keyArray[$depth] = 1;
170			}
171			}
172			}
173			return $keyArray;
174			}
175
176			/**
177			* Function modifying the depthKey array
178			*
179			* @param array $arr Array with instructions to open/close nodes.
180			* @param array $settings Input depth_key array
181			* @return array Output depth_key array with entries added/removed based on $arr
182			*/
183			public function depthKeys($arr, $settings)
184			{
185			$tsbrArray = [];
186			foreach ($arr as $theK => $theV) {
187			$theKeyParts = explode('.', (string)$theK);
188			$depth = '';
189			$c = count($theKeyParts);
190			$a = 0;
191			foreach ($theKeyParts as $p) {
192			$a++;
193			$depth .= ($depth ? '.' : '') . $p;
194			$tsbrArray[$depth] = $c == $a ? $theV : 1;
195			}
196			}
197			// Modify settings
198			foreach ($tsbrArray as $theK => $theV) {
199			if ($theV) {
200			$settings[$theK] = 1;
201			} else {
202			unset($settings[$theK]);
203			}
204			}
205			return $settings;
206			}
207			}
208

TYPO3 / TYPO3.CMS

Push — master ( 3ef1ae...4ba2eb )

ArrayBrowser::depthKeys() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like