Skip to content

Commit b225032

Browse files
committed
docs: add @Used-By
1 parent 629a1c1 commit b225032

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

system/Helpers/Array/ArrayHelper.php

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@
1717
final class ArrayHelper
1818
{
1919
/**
20-
* Searches an array through dot syntax. Supports
21-
* wildcard searches, like foo.*.bar
20+
* Searches an array through dot syntax. Supports wildcard searches,
21+
* like `foo.*.bar`.
22+
*
23+
* @used-by dot_array_search()
2224
*
2325
* @return array|bool|int|object|string|null
2426
*/
@@ -38,8 +40,9 @@ public static function dotSearch(string $index, array $array)
3840
}
3941

4042
/**
41-
* Used by `dotArraySearch()` to recursively search the
42-
* array with wildcards.
43+
* Recursively search the array with wildcards.
44+
*
45+
* @used-by dotSearch()
4346
*
4447
* @return array|bool|float|int|object|string|null
4548
*/
@@ -101,6 +104,8 @@ private static function arraySearchDot(array $indexes, array $array)
101104
/**
102105
* Groups all rows by their index values. Result's depth equals number of indexes
103106
*
107+
* @used-by array_group_by()
108+
*
104109
* @param array $array Data array (i.e. from query result)
105110
* @param array $indexes Indexes to group by. Dot syntax used. Returns $array if empty
106111
* @param bool $includeEmpty If true, null and '' are also added as valid keys to group
@@ -123,10 +128,10 @@ public static function groupBy(array $array, array $indexes, bool $includeEmpty
123128
}
124129

125130
/**
126-
* Used by `arrayGroupBy()` to recursively attach $row to the $indexes path of values found by
127-
* `dot_array_search()`
131+
* Recursively attach $row to the $indexes path of values found by
132+
* `dot_array_search()`.
128133
*
129-
* @internal This should not be used on its own
134+
* @used-by groupBy()
130135
*/
131136
private static function arrayAttachIndexedValue(array $result, array $row, array $indexes, bool $includeEmpty): array
132137
{

0 commit comments

Comments
 (0)