docs: add PHPDoc

codeigniter4 · Nov 6, 2023 · dce6576 · dce6576
1 parent 3c4b238
commit dce6576
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/system/Helpers/Array/ArrayHelper.php b/system/Helpers/Array/ArrayHelper.php
@@ -29,14 +29,21 @@ final class ArrayHelper
  *
  * @used-by dot_array_search()
  *
+ * @param string $index The index as dot array syntax.
+ *
  * @return array|bool|int|object|string|null
  */
  public static function dotSearch(string $index, array $array)
  {
  return self::arraySearchDot(self::convertToArray($index), $array);
  }
 
- private static function convertToArray(string $index)
+ /**
+ * @param string $index The index as dot array syntax.
+ *
+ * @return list<string> The index as an array.
+ */
+ private static function convertToArray(string $index): array
  {
  // See https://regex101.com/r/44Ipql/1
  $segments = preg_split(