Fix #168: Add benchmark, improve ArrayHelper::htmlEncode() performance

Author: samdark

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 3.2.1 under development
 
+- Enh #168: Add benchmark, improve `ArrayHelper::htmlEncode()` performance (@samdark)
 - Enh #169: Bump `yiisoft/strings` dependency to `^2.6` (@vjik)
 
 ## 3.2.0 February 01, 2025

composer.json

@@ -37,7 +37,8 @@
         "rector/rector": "^2.0.9",
         "roave/infection-static-analysis-plugin": "^1.35",
         "spatie/phpunit-watcher": "^1.24",
-        "vimeo/psalm": "^5.26.1 || ^6.5.1"
+        "vimeo/psalm": "^5.26.1 || ^6.5.1",
+        "phpbench/phpbench": "^1.4"
     },
     "autoload": {
         "psr-4": {

phpbench.json

@@ -0,0 +1,14 @@
+{
+    "$schema": "./vendor/phpbench/phpbench/phpbench.schema.json",
+    "runner.bootstrap": "vendor/autoload.php",
+    "runner.path": "tests/Benchmark",
+    "runner.php_config": {
+        "memory_limit": "1G"
+    },
+    "report.generators": {
+        "default": {
+            "generator": "composite",
+            "reports": ["aggregate", "env"]
+        }
+    }
+}

src/ArrayHelper.php

@@ -7,12 +7,9 @@
 use Closure;
 use InvalidArgumentException;
 
-use function array_fill;
 use function array_multisort;
 use function count;
 use function is_array;
-use function is_scalar;
-use function range;
 
 final class ArraySorter
 {
@@ -30,7 +27,7 @@ final class ArraySorter
      * ArraySorter::multisort($data, ['age', 'name'], [SORT_ASC, SORT_DESC]);
      * ```
      *
-     * After sorting we'll get the following in `$data`:
+     * After sorting, we'll get the following in `$data`:
      *
      * ```php
      * [
@@ -43,7 +40,7 @@ final class ArraySorter
      * @param array<array-key, array|object> $array The array to be sorted. The array will be modified after calling
      * this method.
      * @param array<array-key, Closure|string>|Closure|string $key The key(s) to be sorted by. This refers to a key
-     * name of the sub-array elements, a property name of the objects, or an anonymous function returning the values
+     * name of the subarray elements, a property name of the objects, or an anonymous function returning the values
      * for comparison purpose. The anonymous function signature should be: `function($item)`.
      * To sort by multiple keys, provide an array of keys here.
      * @param array<array-key, int>|int $direction The sorting direction. It can be either `SORT_ASC` or `SORT_DESC`.
@@ -62,80 +59,47 @@ public static function multisort(
         array|int $direction = SORT_ASC,
         array|int $sortFlag = SORT_REGULAR
     ): void {
-        $keys = self::getKeys($array, $key);
-        if (empty($keys)) {
+        $count = count($array);
+        if ($count === 0) {
             return;
         }
 
-        $n = count($keys);
-        if (is_scalar($direction)) {
-            $direction = array_fill(0, $n, $direction);
-        } elseif (count($direction) !== $n) {
-            throw new InvalidArgumentException('The length of $direction parameter must be the same as that of $keys.');
+        $keys = is_array($key) ? $key : [$key];
+        $keysCount = count($keys);
+        if ($keysCount === 0) {
+            return;
         }
 
-        if (is_scalar($sortFlag)) {
-            $sortFlag = array_fill(0, $n, $sortFlag);
-        } elseif (count($sortFlag) !== $n) {
+        if (is_array($direction) && count($direction) !== $keysCount) {
+            throw new InvalidArgumentException('The length of $direction parameter must be the same as that of $keys.');
+        }
+        if (is_array($sortFlag) && count($sortFlag) !== $keysCount) {
             throw new InvalidArgumentException('The length of $sortFlag parameter must be the same as that of $keys.');
         }
 
-        $_args = self::getArguments($array, $keys, $direction, $sortFlag);
-
-        /** @psalm-suppress UnsupportedReferenceUsage */
-        $_args[] = &$array;
-
-        /** @psalm-suppress MixedArgument */
-        array_multisort(...$_args);
-    }
+        $args = [];
 
-    /**
-     * Get keys for get arguments.
-     *
-     * @param array<array-key, array|object> $array The array to be sorted.
-     * @param array<array-key, Closure|string>|Closure|string $key The keys to be sorted by. This refers to a key name
-     * of the sub-array elements, a property name of the objects, or an anonymous function returning the values for
-     * comparison purpose. The anonymous function signature should be: `function($item)`.
-     * To sort by multiple keys, provide an array of keys here.
-     *
-     * @return array<array-key, Closure|string> The keys.
-     */
-    private static function getKeys(array $array, array|Closure|string $key): array
-    {
-        $keys = is_array($key) ? $key : [$key];
-        if (empty($keys) || empty($array)) {
-            return [];
+        for ($i = 0; $i < $keysCount; $i++) {
+            $args[] = ArrayHelper::getColumn($array, $keys[$i]);
+            $args[] = is_array($direction) ? $direction[$i] : $direction;
+            $args[] = is_array($sortFlag) ? $sortFlag[$i] : $sortFlag;
         }
 
-        return $keys;
-    }
-
-    /**
-     * Get arguments for multisort.
-     *
-     * @param array<array-key, array|object> $array The array to be sorted.
-     * @param array<array-key, Closure|string> $keys Array of keys.
-     * @param array<array-key, int> $direction Array of sorting directions.
-     * @param array<array-key, int> $sortFlags Array of sort flags.
-     *
-     * @return array The arguments.
-     */
-    private static function getArguments(array $array, array $keys, array $direction, array $sortFlags): array
-    {
-        $args = [];
-        foreach ($keys as $i => $iKey) {
-            $flag = $sortFlags[$i];
-            $args[] = ArrayHelper::getColumn($array, $iKey);
-            $args[] = $direction[$i];
-            $args[] = $flag;
+        // Add tie-breaker only for non-empty arrays
+        if ($count > 0) {
+            $tieBreaker = [];
+            for ($i = 0; $i < $count; $i++) {
+                $tieBreaker[$i] = $i + 1;
+            }
+            $args[] = $tieBreaker;
+            $args[] = SORT_ASC;
+            $args[] = SORT_NUMERIC;
         }
 
-        // This fix is used for cases when main sorting specified by columns has equal values.
-        // Without it will lead to Fatal Error: Nesting level too deep - recursive dependency?
-        $args[] = range(1, count($array));
-        $args[] = SORT_ASC;
-        $args[] = SORT_NUMERIC;
+        /** @psalm-suppress UnsupportedReferenceUsage */
+        $args[] = &$array;
 
-        return $args;
+        /** @psalm-suppress ArgumentTypeCoercion */
+        array_multisort(...$args);
     }
 }