gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Simplify Util::getValueByKey()

Browse Source 
Signed-off-by: Kamil Tekiela <tekiela246@gmail.com>
This commit is contained in:
Kamil Tekiela 2023-12-17 19:03:02 +01:00
parent 0e0a16b69e
commit 982b5bb4d0
7 changed files with 109 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
phpstan-baseline.neon
View File

@ -4342,7 +4342,7 @@ parameters:
-
message: "#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#"
count: 4
count: 3
path: src/Controllers/Sql/SqlController.php
-
@ -16440,11 +16440,6 @@ parameters:
count: 2
path: src/Util.php
-
message: "#^Cannot access offset mixed on mixed\\.$#"
count: 1
path: src/Util.php
-
message: "#^Cannot cast mixed to string\\.$#"
count: 1
@ -16535,6 +16530,11 @@ parameters:
count: 1
path: src/Util.php
-
message: "#^Parameter \\#2 \\$array of function array_key_exists expects array, mixed given\\.$#"
count: 1
path: src/Util.php
-
message: "#^Parameter \\#2 \\$table of method PhpMyAdmin\\\\DatabaseInterface\\:\\:getTablesFull\\(\\) expects array\\|string, mixed given\\.$#"
count: 1

43
psalm-baseline.xml
View File

@ -4036,22 +4036,22 @@
<code><![CDATA[$_POST['field_transformation'][$fieldindex]]]></code>
<code><![CDATA[$_POST['field_transformation_options'][$fieldindex]]]></code>
<code>$newCol</code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_collation.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_collation_orig.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_comments.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_comments_orig.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_expression.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_expression_orig.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_extra.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_extra_orig.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_move_to.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_move_to_orig.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_null.' . $i, 'NO')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_null_orig.' . $i, 'NO')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_orig.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_orig.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_virtuality.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_virtuality_orig.' . $i, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_collation', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_collation_orig', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_comments', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_comments_orig', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_expression', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_expression_orig', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_extra', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_extra_orig', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_move_to', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_move_to_orig', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_null', $i], 'NO')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_null_orig', $i], 'NO')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_orig', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_orig', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_virtuality', $i], '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_virtuality_orig', $i], '')]]></code>
</MixedArgument>
<MixedAssignment>
<code>$newCol</code>
@ -11522,7 +11522,7 @@
<code><![CDATA[$formParams['db']]]></code>
<code><![CDATA[$formParams['table']]]></code>
<code>$type</code>
<code><![CDATA[Util::getValueByKey($_POST, 'field_key.' . $columnNumber, '')]]></code>
<code><![CDATA[Util::getValueByKey($_POST, ['field_key', $columnNumber], '')]]></code>
</MixedArgument>
<MixedArrayAccess>
<code><![CDATA[$GLOBALS['mime_map'][$columnMeta['Field']]]]></code>
@ -12301,13 +12301,15 @@
<code>$byteUnits[$d]</code>
<code>$units[$d]</code>
</InvalidArrayOffset>
<MixedArgument>
<code>$array</code>
</MixedArgument>
<MixedArgumentTypeCoercion>
<code>$columnNames</code>
<code><![CDATA[uksort($tables, 'strnatcasecmp')]]></code>
</MixedArgumentTypeCoercion>
<MixedArrayAccess>
<code><![CDATA[$_SESSION['tmpval']['table_limit_offset']]]></code>
<code>$array[$p]</code>
<code><![CDATA[$row['Cardinality']]]></code>
<code><![CDATA[$row['Column_name']]]></code>
<code><![CDATA[$row['Column_name']]]></code>
@ -12334,8 +12336,6 @@
<code><![CDATA[$_SESSION['tmpval']['table_limit_offset_db']]]></code>
</MixedArrayAssignment>
<MixedArrayOffset>
<code>$array[$p]</code>
<code>$array[$p]</code>
<code><![CDATA[$indexesData[$row['Key_name']]]]></code>
<code><![CDATA[$indexesData[$row['Key_name']]]]></code>
<code><![CDATA[$indexesData[$row['Key_name']][$row['Seq_in_index']]]]></code>
@ -12356,8 +12356,6 @@
<code><![CDATA[$indexesInfo[$row['Key_name']]['Non_unique']]]></code>
<code><![CDATA[$indexesInfo[$row['Key_name']]['Sequences'][]]]></code>
<code>$lastIndex</code>
<code>$p</code>
<code>$p</code>
<code>$row</code>
<code>$unit</code>
<code>$value</code>
@ -15773,6 +15771,7 @@
<code>providerForTestBackquote</code>
<code>providerForTestGetLowerCaseNames</code>
<code>providerForTestGetMySQLDocuURL</code>
<code>providerForTestGetValueByKey</code>
<code>providerFormatByteDown</code>
<code>providerFormatNumber</code>
<code>providerForwardedHeaders</code>

32
src/Controllers/Table/Structure/SaveController.php
View File

@ -80,20 +80,20 @@ final class SaveController extends AbstractController
}
$changes[] = 'CHANGE ' . Table::generateAlter(
Util::getValueByKey($_POST, 'field_orig.' . $i, ''),
Util::getValueByKey($_POST, ['field_orig', $i], ''),
$_POST['field_name'][$i],
$_POST['field_type'][$i],
$_POST['field_length'][$i],
$_POST['field_attribute'][$i],
Util::getValueByKey($_POST, 'field_collation.' . $i, ''),
Util::getValueByKey($_POST, 'field_null.' . $i, 'NO'),
Util::getValueByKey($_POST, ['field_collation', $i], ''),
Util::getValueByKey($_POST, ['field_null', $i], 'NO'),
$_POST['field_default_type'][$i],
$_POST['field_default_value'][$i],
Util::getValueByKey($_POST, 'field_extra.' . $i, ''),
Util::getValueByKey($_POST, 'field_comments.' . $i, ''),
Util::getValueByKey($_POST, 'field_virtuality.' . $i, ''),
Util::getValueByKey($_POST, 'field_expression.' . $i, ''),
Util::getValueByKey($_POST, 'field_move_to.' . $i, ''),
Util::getValueByKey($_POST, ['field_extra', $i], ''),
Util::getValueByKey($_POST, ['field_comments', $i], ''),
Util::getValueByKey($_POST, ['field_virtuality', $i], ''),
Util::getValueByKey($_POST, ['field_expression', $i], ''),
Util::getValueByKey($_POST, ['field_move_to', $i], ''),
$columnsWithIndex,
);
@ -232,20 +232,20 @@ final class SaveController extends AbstractController
}
$changesRevert[] = 'CHANGE ' . Table::generateAlter(
Util::getValueByKey($_POST, 'field_orig.' . $i, ''),
Util::getValueByKey($_POST, ['field_orig', $i], ''),
$_POST['field_name'][$i],
$_POST['field_type_orig'][$i],
$_POST['field_length_orig'][$i],
$_POST['field_attribute_orig'][$i],
Util::getValueByKey($_POST, 'field_collation_orig.' . $i, ''),
Util::getValueByKey($_POST, 'field_null_orig.' . $i, 'NO'),
Util::getValueByKey($_POST, ['field_collation_orig', $i], ''),
Util::getValueByKey($_POST, ['field_null_orig', $i], 'NO'),
$_POST['field_default_type_orig'][$i],
$_POST['field_default_value_orig'][$i],
Util::getValueByKey($_POST, 'field_extra_orig.' . $i, ''),
Util::getValueByKey($_POST, 'field_comments_orig.' . $i, ''),
Util::getValueByKey($_POST, 'field_virtuality_orig.' . $i, ''),
Util::getValueByKey($_POST, 'field_expression_orig.' . $i, ''),
Util::getValueByKey($_POST, 'field_move_to_orig.' . $i, ''),
Util::getValueByKey($_POST, ['field_extra_orig', $i], ''),
Util::getValueByKey($_POST, ['field_comments_orig', $i], ''),
Util::getValueByKey($_POST, ['field_virtuality_orig', $i], ''),
Util::getValueByKey($_POST, ['field_expression_orig', $i], ''),
Util::getValueByKey($_POST, ['field_move_to_orig', $i], ''),
);
}

4
src/Query/Cache.php
View File

@ -75,8 +75,8 @@ class Cache
/**
* Get a cached value from table cache.
*
* @param mixed[] $contentPath Array of the name of the target value
* @param mixed $default Return value on cache miss
* @param (int|string)[] $contentPath Array of the name of the target value
* @param mixed $default Return value on cache miss
*
* @return mixed cached value or default
*/

32
src/Table/ColumnsDefinition.php
View File

@ -160,21 +160,21 @@ final class ColumnsDefinition
if ($regenerate) {
$columnMeta = $this->getColumnMetaForRegeneratedFields($columnNumber);
$length = Util::getValueByKey($_POST, 'field_length.' . $columnNumber, $length);
$submitAttribute = Util::getValueByKey($_POST, 'field_attribute.' . $columnNumber, false);
$commentsMap[$columnMeta['Field']] = Util::getValueByKey($_POST, 'field_comments.' . $columnNumber);
$length = Util::getValueByKey($_POST, ['field_length', $columnNumber], $length);
$submitAttribute = Util::getValueByKey($_POST, ['field_attribute', $columnNumber], false);
$commentsMap[$columnMeta['Field']] = Util::getValueByKey($_POST, ['field_comments', $columnNumber]);
$GLOBALS['mime_map'][$columnMeta['Field']] = array_merge(
$GLOBALS['mime_map'][$columnMeta['Field']] ?? [],
[
'mimetype' => Util::getValueByKey($_POST, 'field_mimetype.' . $columnNumber),
'mimetype' => Util::getValueByKey($_POST, ['field_mimetype', $columnNumber]),
'transformation' => Util::getValueByKey(
$_POST,
'field_transformation.' . $columnNumber,
['field_transformation' , $columnNumber],
),
'transformation_options' => Util::getValueByKey(
$_POST,
'field_transformation_options.' . $columnNumber,
['field_transformation_options' , $columnNumber],
),
],
);
@ -406,22 +406,22 @@ final class ColumnsDefinition
private function getColumnMetaForRegeneratedFields(int $columnNumber): array
{
$columnMeta = [
'Field' => Util::getValueByKey($_POST, 'field_name.' . $columnNumber),
'Type' => Util::getValueByKey($_POST, 'field_type.' . $columnNumber),
'Collation' => Util::getValueByKey($_POST, 'field_collation.' . $columnNumber, ''),
'Null' => Util::getValueByKey($_POST, 'field_null.' . $columnNumber, ''),
'DefaultType' => Util::getValueByKey($_POST, 'field_default_type.' . $columnNumber, 'NONE'),
'DefaultValue' => Util::getValueByKey($_POST, 'field_default_value.' . $columnNumber, ''),
'Extra' => Util::getValueByKey($_POST, 'field_extra.' . $columnNumber),
'Virtuality' => Util::getValueByKey($_POST, 'field_virtuality.' . $columnNumber, ''),
'Expression' => Util::getValueByKey($_POST, 'field_expression.' . $columnNumber, ''),
'Field' => Util::getValueByKey($_POST, ['field_name', $columnNumber]),
'Type' => Util::getValueByKey($_POST, ['field_type', $columnNumber]),
'Collation' => Util::getValueByKey($_POST, ['field_collation', $columnNumber], ''),
'Null' => Util::getValueByKey($_POST, ['field_null', $columnNumber], ''),
'DefaultType' => Util::getValueByKey($_POST, ['field_default_type', $columnNumber], 'NONE'),
'DefaultValue' => Util::getValueByKey($_POST, ['field_default_value', $columnNumber], ''),
'Extra' => Util::getValueByKey($_POST, ['field_extra', $columnNumber]),
'Virtuality' => Util::getValueByKey($_POST, ['field_virtuality', $columnNumber], ''),
'Expression' => Util::getValueByKey($_POST, ['field_expression', $columnNumber], ''),
'Key' => '',
'Comment' => false,
];
$parts = explode(
'_',
Util::getValueByKey($_POST, 'field_key.' . $columnNumber, ''),
Util::getValueByKey($_POST, ['field_key', $columnNumber], ''),
2,
);
if (count($parts) === 2 && $parts[1] == $columnNumber) {

19
src/Util.php
View File

@ -18,7 +18,6 @@ use function _pgettext;
use function abs;
use function array_key_exists;
use function array_map;
use function array_shift;
use function array_unique;
use function bin2hex;
use function chr;
@ -1962,28 +1961,22 @@ class Util
}
/**
* Access to a multidimensional array by dot notation
* Access to a multidimensional array recursively by the keys specified in $path
*
* @param mixed[] $array List of values
* @param string|mixed[] $path Path to searched value
* @param (int|string)[] $path Path to searched value
* @param mixed $default Default value
*
* @return mixed Searched value
*/
public static function getValueByKey(array $array, string|array $path, mixed $default = null): mixed
public static function getValueByKey(array $array, array $path, mixed $default = null): mixed
{
if (is_string($path)) {
$path = explode('.', $path);
}
$p = array_shift($path);
while ($p !== null) {
if (! isset($array[$p])) {
foreach ($path as $key) {
if (! array_key_exists($key, $array)) {
return $default;
}
$array = $array[$p];
$p = array_shift($path);
$array = $array[$key];
}
return $array;

42
tests/classes/UtilTest.php
View File

@ -1628,4 +1628,46 @@ SQL;
];
$this->assertSame($expected, Util::getSupportedDatatypes());
}
/**
* @param mixed[] $array
* @param (string|int)[] $path
*/
#[DataProvider('providerForTestGetValueByKey')]
public function testGetValueByKey(mixed $expected, array $array, array $path, mixed $default = null): void
{
$this->assertSame($expected, Util::getValueByKey($array, $path, $default));
}
/** @return iterable<string, array{mixed, mixed[], (string|int)[], mixed}> */
public static function providerForTestGetValueByKey(): iterable
{
yield 'array_has_all_keys' => [
'foo',
['key1' => ['key2' => 'foo']],
['key1', 'key2'],
null,
];
yield 'key_not_found' => [
'def',
['key1' => ['key2' => 'foo']],
['key1', 'key3'],
'def',
];
yield 'subarray_requested' => [
['key2' => 'foo'],
['key1' => ['key2' => 'foo']],
['key1'],
'def',
];
yield 'no_keys_specified' => [
['key1' => ['key2' => 'foo']],
['key1' => ['key2' => 'foo']],
[],
'def',
];
}
}