Arrays: searchKey() silently renamed to getKeyOffset()

Author: dg

src/Utils/Arrays.php

@@ -84,12 +84,21 @@ public static function mergeTree(array $array1, array $array2): array
 	 * @param  string|int  $key
 	 * @return int|null offset if it is found, null otherwise
 	 */
-	public static function searchKey(array $array, $key): ?int
+	public static function getKeyOffset(array $array, $key): ?int
 	{
 		return Helpers::falseToNull(array_search(self::toKey($key), array_keys($array), true));
 	}
 
 
+	/**
+	 * @deprecated  use  getKeyOffset()
+	 */
+	public static function searchKey(array $array, $key): ?int
+	{
+		return self::getKeyOffset($array, $key);
+	}
+
+
 	/**
 	 * Inserts the contents of the $inserted array into the $array immediately after the $key.
 	 * If $key is null (or does not exist), it is inserted at the end.

tests/Utils/Arrays.getKeyOffset().phpt

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * Test: Nette\Utils\Arrays::getKeyOffset()
+ */
+
+declare(strict_types=1);
+
+use Nette\Utils\Arrays;
+use Tester\Assert;
+
+
+require __DIR__ . '/../bootstrap.php';
+
+
+$arr = [
+	'' => 'first',
+	0 => 'second',
+	7 => 'third',
+	1 => 'fourth',
+];
+
+Assert::same(3, Arrays::getKeyOffset($arr, '1'));
+Assert::same(3, Arrays::getKeyOffset($arr, 1));
+Assert::same(2, Arrays::getKeyOffset($arr, 7));
+Assert::same(1, Arrays::getKeyOffset($arr, 0));
+Assert::same(0, Arrays::getKeyOffset($arr, null));
+Assert::same(0, Arrays::getKeyOffset($arr, ''));
+Assert::null(Arrays::getKeyOffset($arr, 'undefined'));