Merge pull request #8130 from kenjis/refactor-ArrayHelper

refactor: move ArrayHelper class

Author: kenjis

phpstan-baseline.php

@@ -2293,7 +2293,7 @@
 ];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
-	'count' => 3,
+	'count' => 2,
 	'path' => __DIR__ . '/system/Helpers/array_helper.php',
 ];
 $ignoreErrors[] = [

system/Commands/Translation/LocalizationFinder.php

@@ -13,7 +13,7 @@
 
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
-use CodeIgniter\Commands\Translation\LocalizationFinder\ArrayHelper;
+use CodeIgniter\Helpers\Array\ArrayHelper;
 use Config\App;
 use Locale;
 use RecursiveDirectoryIterator;

system/Commands/Translation/LocalizationFinder/ArrayHelper.php

@@ -0,0 +1,232 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Helpers\Array;
+
+/**
+ * @interal This is internal implementation for the framework.
+ *
+ * If there are any methods that should be provided, make them
+ * public APIs via helper functions.
+ *
+ * @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
+ */
+final class ArrayHelper
+{
+    /**
+     * Searches an array through dot syntax. Supports wildcard searches,
+     * like `foo.*.bar`.
+     *
+     * @used-by dot_array_search()
+     *
+     * @return array|bool|int|object|string|null
+     */
+    public static function dotSearch(string $index, array $array)
+    {
+        // See https://regex101.com/r/44Ipql/1
+        $segments = preg_split(
+            '/(?<!\\\\)\./',
+            rtrim($index, '* '),
+            0,
+            PREG_SPLIT_NO_EMPTY
+        );
+
+        $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);
+
+        return self::arraySearchDot($segments, $array);
+    }
+
+    /**
+     * Recursively search the array with wildcards.
+     *
+     * @used-by dotSearch()
+     *
+     * @return array|bool|float|int|object|string|null
+     */
+    private static function arraySearchDot(array $indexes, array $array)
+    {
+        // If index is empty, returns null.
+        if ($indexes === []) {
+            return null;
+        }
+
+        // Grab the current index
+        $currentIndex = array_shift($indexes);
+
+        if (! isset($array[$currentIndex]) && $currentIndex !== '*') {
+            return null;
+        }
+
+        // Handle Wildcard (*)
+        if ($currentIndex === '*') {
+            $answer = [];
+
+            foreach ($array as $value) {
+                if (! is_array($value)) {
+                    return null;
+                }
+
+                $answer[] = self::arraySearchDot($indexes, $value);
+            }
+
+            $answer = array_filter($answer, static fn ($value) => $value !== null);
+
+            if ($answer !== []) {
+                if (count($answer) === 1) {
+                    // If array only has one element, we return that element for BC.
+                    return current($answer);
+                }
+
+                return $answer;
+            }
+
+            return null;
+        }
+
+        // If this is the last index, make sure to return it now,
+        // and not try to recurse through things.
+        if ($indexes === []) {
+            return $array[$currentIndex];
+        }
+
+        // Do we need to recursively search this value?
+        if (is_array($array[$currentIndex]) && $array[$currentIndex] !== []) {
+            return self::arraySearchDot($indexes, $array[$currentIndex]);
+        }
+
+        // Otherwise, not found.
+        return null;
+    }
+
+    /**
+     * Groups all rows by their index values. Result's depth equals number of indexes
+     *
+     * @used-by array_group_by()
+     *
+     * @param array $array        Data array (i.e. from query result)
+     * @param array $indexes      Indexes to group by. Dot syntax used. Returns $array if empty
+     * @param bool  $includeEmpty If true, null and '' are also added as valid keys to group
+     *
+     * @return array Result array where rows are grouped together by indexes values.
+     */
+    public static function groupBy(array $array, array $indexes, bool $includeEmpty = false): array
+    {
+        if ($indexes === []) {
+            return $array;
+        }
+
+        $result = [];
+
+        foreach ($array as $row) {
+            $result = self::arrayAttachIndexedValue($result, $row, $indexes, $includeEmpty);
+        }
+
+        return $result;
+    }
+
+    /**
+     * Recursively attach $row to the $indexes path of values found by
+     * `dot_array_search()`.
+     *
+     * @used-by groupBy()
+     */
+    private static function arrayAttachIndexedValue(
+        array $result,
+        array $row,
+        array $indexes,
+        bool $includeEmpty
+    ): array {
+        if (($index = array_shift($indexes)) === null) {
+            $result[] = $row;
+
+            return $result;
+        }
+
+        $value = dot_array_search($index, $row);
+
+        if (! is_scalar($value)) {
+            $value = '';
+        }
+
+        if (is_bool($value)) {
+            $value = (int) $value;
+        }
+
+        if (! $includeEmpty && $value === '') {
+            return $result;
+        }
+
+        if (! array_key_exists($value, $result)) {
+            $result[$value] = [];
+        }
+
+        $result[$value] = self::arrayAttachIndexedValue($result[$value], $row, $indexes, $includeEmpty);
+
+        return $result;
+    }
+
+    /**
+     * Compare recursively two associative arrays and return difference as new array.
+     * Returns keys that exist in `$original` but not in `$compareWith`.
+     */
+    public static function recursiveDiff(array $original, array $compareWith): array
+    {
+        $difference = [];
+
+        if ($original === []) {
+            return [];
+        }
+
+        if ($compareWith === []) {
+            return $original;
+        }
+
+        foreach ($original as $originalKey => $originalValue) {
+            if ($originalValue === []) {
+                continue;
+            }
+
+            if (is_array($originalValue)) {
+                $diffArrays = [];
+
+                if (isset($compareWith[$originalKey]) && is_array($compareWith[$originalKey])) {
+                    $diffArrays = self::recursiveDiff($originalValue, $compareWith[$originalKey]);
+                } else {
+                    $difference[$originalKey] = $originalValue;
+                }
+
+                if ($diffArrays !== []) {
+                    $difference[$originalKey] = $diffArrays;
+                }
+            } elseif (is_string($originalValue) && ! array_key_exists($originalKey, $compareWith)) {
+                $difference[$originalKey] = $originalValue;
+            }
+        }
+
+        return $difference;
+    }
+
+    /**
+     * Recursively count all keys.
+     */
+    public static function recursiveCount(array $array, int $counter = 0): int
+    {
+        foreach ($array as $value) {
+            if (is_array($value)) {
+                $counter = self::recursiveCount($value, $counter);
+            }
+
+            $counter++;
+        }
+
+        return $counter;
+    }
+}