docs: add PHPDoc

kenjis · kenjis · commit dce657695e4d · 2023-11-06T10:13:20.000+09:00
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(

Original file line number	Diff line number	Diff line change
`@@ -29,14 +29,21 @@ final class ArrayHelper`
`29`	`29`	`*`
`30`	`30`	`* @used-by dot_array_search()`
`31`	`31`	`*`
	`32`	`+ * @param string $index The index as dot array syntax.`
	`33`	`+ *`
`32`	`34`	`* @return array\|bool\|int\|object\|string\|null`
`33`	`35`	`*/`
`34`	`36`	`public static function dotSearch(string $index, array $array)`
`35`	`37`	`{`
`36`	`38`	`return self::arraySearchDot(self::convertToArray($index), $array);`
`37`	`39`	`}`
`38`	`40`
`39`		`- private static function convertToArray(string $index)`
	`41`	`+ /**`
	`42`	`+ * @param string $index The index as dot array syntax.`
	`43`	`+ *`
	`44`	`+ * @return list<string> The index as an array.`
	`45`	`+ */`
	`46`	`+ private static function convertToArray(string $index): array`
`40`	`47`	`{`
`41`	`48`	`// See https://regex101.com/r/44Ipql/1`
`42`	`49`	`$segments = preg_split(`