Add ArrayHelper::iterableToArray()

Author: vjik

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Enh #168: Add benchmark, improve `ArrayHelper::htmlEncode()` performance (@samdark)
 - Enh #169: Bump `yiisoft/strings` dependency to `^2.6` (@vjik)
+- New #170: Add `ArrayHelper::iterableToArray()` method (@vjik)
 
 ## 3.2.0 February 01, 2025
 

README.md

@@ -82,6 +82,7 @@ Overall the helper has the following method groups.
 ### Transformation
 
 - index
+- iterableToArray
 - group
 - filter
 - map

composer.json

@@ -34,11 +34,11 @@
     "require-dev": {
         "bamarni/composer-bin-plugin": "^1.8.2",
         "phpunit/phpunit": "^10.5.45",
-        "rector/rector": "^2.0.9",
-        "roave/infection-static-analysis-plugin": "^1.35",
+        "rector/rector": "^2.0.11",
+        "roave/infection-static-analysis-plugin": "^1.37",
         "spatie/phpunit-watcher": "^1.24",
-        "vimeo/psalm": "^5.26.1 || ^6.5.1",
-        "phpbench/phpbench": "^1.4"
+        "vimeo/psalm": "^5.26.1 || ^6.10",
+        "phpbench/phpbench": "^1.4.1"
     },
     "autoload": {
         "psr-4": {

src/ArrayHelper.php

@@ -7,6 +7,7 @@
 use Closure;
 use InvalidArgumentException;
 use Throwable;
+use Traversable;
 use Yiisoft\Strings\NumericHelper;
 use Yiisoft\Strings\StringHelper;
 
@@ -1414,6 +1415,18 @@ public static function renameKey(array $array, int|string $from, int|string $to)
         return array_combine($keys, $array);
     }
 
+    /**
+     * Converts an iterable value to an array.
+     *
+     * @param iterable $iterable The iterable to convert.
+     *
+     * @return array The converted array.
+     */
+    public static function iterableToArray(iterable $iterable): array
+    {
+        return $iterable instanceof Traversable ? iterator_to_array($iterable) : $iterable;
+    }
+
     /**
      * @param array[] $arrays
      */

tests/ArrayHelper/IterableToArrayTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Arrays\Tests\ArrayHelper;
+
+use ArrayIterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Yiisoft\Arrays\ArrayHelper;
+
+use function PHPUnit\Framework\assertSame;
+
+final class IterableToArrayTest extends TestCase
+{
+    public static function dataBase(): iterable
+    {
+        yield [[1, 2, 3], [1, 2, 3]];
+        yield [[1, 2, 3], new ArrayIterator([1, 2, 3])];
+        yield [['key' => 'value'], ['key' => 'value']];
+        yield [['key' => 'value'], new ArrayIterator(['key' => 'value'])];
+    }
+
+    #[DataProvider('dataBase')]
+    public function testBase(array $expected, iterable $value): void
+    {
+        $result = ArrayHelper::iterableToArray($value);
+
+        assertSame($expected, $result);
+    }
+}

tools/composer-require-checker/composer.json

@@ -1,6 +1,6 @@
 {
     "require-dev": {
-        "maglnet/composer-require-checker": "^4.7.1"
+        "maglnet/composer-require-checker": "^4.16.1"
     },
     "config": {
         "bump-after-update": "dev"