Skip to content

Commit a2db922

Browse files
committed
Update array parameter names for named parameter DX.
Change $sort_flags to $flags. Remove $array1 from array_map() Rename $cmp_function to $comparison in user-sorting functions. Change $funcname to the more standard $callback. Remove $array1 from array_replace*(). Simplify array_keys() arguments to be more usefully named. Change array_diff*() and array_intersect*() to have be more logically named parameters. Standardize array_key_exists() on $array, which the docs already use. Switch array_fill*() arguments to be more self-descriptive. Change $vars to $values in array_unshift(), to be more consistent and descriptive. Rename $userdata to $arguments, since that is how it will be used. Change array_replace() to use $substitutions instead. Update more tests. Standardize callback name to $callback. Update tests. Use plurals for variadics. Update another test. Update reflection tests. Fix another test. Use $replacements for substitution values. Update tests.
1 parent 95cf7a0 commit a2db922

File tree

47 files changed

+1287
-1282
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1287
-1282
lines changed

Zend/tests/bug31720.phpt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ try {
1212
?>
1313
--EXPECTF--
1414
Warning: Undefined variable $nonesuchvar in %s on line %d
15-
array_walk(): Argument #2 ($funcname) must be a valid callback, first array member is not a valid class name or object
15+
array_walk(): Argument #2 ($callback) must be a valid callback, first array member is not a valid class name or object

Zend/tests/named_params/missing_param.phpt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ try {
2525
}
2626

2727
// This works fine, as search_value is explicitly specified.
28-
var_dump(array_keys([41, 42], search_value: 42, strict: true));
28+
var_dump(array_keys([41, 42], for_value: 42, strict: true));
2929

3030
?>
3131
--EXPECT--
3232
test(): Argument #2 ($b) not passed
3333
array_keys(): Argument #1 ($array) not passed
34-
array_keys(): Argument #2 ($search_value) must be passed explicitly, because the default value is not known
34+
array_keys(): Argument #2 ($for_value) must be passed explicitly, because the default value is not known
3535
array(1) {
3636
[0]=>
3737
int(1)

ext/reflection/tests/ReflectionParameter_canBePassedByValue.phpt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Name: sort_order
4545
Is passed by reference: yes
4646
Can be passed by value: yes
4747

48-
Name: sort_flags
48+
Name: flags
4949
Is passed by reference: yes
5050
Can be passed by value: yes
5151

@@ -59,7 +59,7 @@ Name: array
5959
Is passed by reference: yes
6060
Can be passed by value: no
6161

62-
Name: sort_flags
62+
Name: flags
6363
Is passed by reference: no
6464
Can be passed by value: yes
6565

ext/spl/tests/arrayObject_asort_basic1.phpt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ object(ArrayObject)#%d (1) {
3636
int(4)
3737
}
3838
}
39-
asort(): Argument #2 ($sort_flags) must be of type int, string given
39+
asort(): Argument #2 ($flags) must be of type int, string given
4040
object(ArrayObject)#%d (1) {
4141
["storage":"ArrayObject":private]=>
4242
array(3) {

ext/spl/tests/arrayObject_ksort_basic1.phpt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ object(ArrayObject)#%d (1) {
3535
int(3)
3636
}
3737
}
38-
ksort(): Argument #2 ($sort_flags) must be of type int, string given
38+
ksort(): Argument #2 ($flags) must be of type int, string given
3939
object(ArrayObject)#2 (1) {
4040
["storage":"ArrayObject":private]=>
4141
array(4) {

ext/standard/basic_functions.stub.php

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ function stream_wrapper_restore(string $protocol): bool {}
5757

5858
/* array.c */
5959

60-
function array_push(array &$stack, mixed ...$args): int {}
60+
function array_push(array &$stack, mixed ...$values): int {}
6161

62-
function krsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
62+
function krsort(array &$array, int $flags = SORT_REGULAR): bool {}
6363

64-
function ksort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
64+
function ksort(array &$array, int $flags = SORT_REGULAR): bool {}
6565

6666
/** @param array|Countable|null $var */
6767
function count($var, int $mode = COUNT_NORMAL): int {}
@@ -76,19 +76,19 @@ function natsort(array &$array): bool {}
7676

7777
function natcasesort(array &$array): bool {}
7878

79-
function asort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
79+
function asort(array &$array, int $flags = SORT_REGULAR): bool {}
8080

81-
function arsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
81+
function arsort(array &$array, int $flags = SORT_REGULAR): bool {}
8282

83-
function sort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
83+
function sort(array &$array, int $flags = SORT_REGULAR): bool {}
8484

85-
function rsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}
85+
function rsort(array &$array, int $flags = SORT_REGULAR): bool {}
8686

87-
function usort(array &$array, callable $cmp_function): bool {}
87+
function usort(array &$array, callable $callback): bool {}
8888

89-
function uasort(array &$array, callable $cmp_function): bool {}
89+
function uasort(array &$array, callable $callback): bool {}
9090

91-
function uksort(array &$array, callable $cmp_function): bool {}
91+
function uksort(array &$array, callable $callback): bool {}
9292

9393
function end(array|object &$arg): mixed {}
9494

@@ -109,9 +109,9 @@ function min(mixed $arg, mixed ...$args): mixed {}
109109

110110
function max(mixed $arg, mixed ...$args): mixed {}
111111

112-
function array_walk(array|object &$input, callable $funcname, mixed $userdata = UNKNOWN): bool {}
112+
function array_walk(array|object &$input, callable $callback, mixed $arguments = UNKNOWN): bool {}
113113

114-
function array_walk_recursive(array|object &$input, callable $funcname, mixed $userdata = UNKNOWN): bool {}
114+
function array_walk_recursive(array|object &$input, callable $callback, mixed $arguments = UNKNOWN): bool {}
115115

116116
function in_array(mixed $needle, array $haystack, bool $strict = false): bool {}
117117

@@ -126,9 +126,9 @@ function extract(array &$array, int $extract_type = EXTR_OVERWRITE, string $pref
126126
*/
127127
function compact($var_name, ...$var_names): array {}
128128

129-
function array_fill(int $start_key, int $num, mixed $val): array {}
129+
function array_fill(int $start_key, int $count, mixed $value): array {}
130130

131-
function array_fill_keys(array $keys, mixed $val): array {}
131+
function array_fill_keys(array $keys, mixed $value): array {}
132132

133133
/**
134134
* @param string|int|float $low
@@ -142,21 +142,21 @@ function array_pop(array &$stack): mixed {}
142142

143143
function array_shift(array &$stack): mixed {}
144144

145-
function array_unshift(array &$stack, mixed ...$vars): int {}
145+
function array_unshift(array &$stack, mixed ...$values): int {}
146146

147-
function array_splice(array &$array, int $offset, ?int $length = null, mixed $replacement = []): array {}
147+
function array_splice(array &$array, int $offset, ?int $length = null, mixed $replacements = []): array {}
148148

149149
function array_slice(array $array, int $offset, ?int $length = null, bool $preserve_keys = false): array {}
150150

151151
function array_merge(array ...$arrays): array {}
152152

153153
function array_merge_recursive(array ...$arrays): array {}
154154

155-
function array_replace(array $array1, array ...$arrays): array {}
155+
function array_replace(array $array, array ...$replacements): array {}
156156

157-
function array_replace_recursive(array $array1, array ...$arrays): array {}
157+
function array_replace_recursive(array $array, array ...$replacements): array {}
158158

159-
function array_keys(array $array, mixed $search_value = UNKNOWN, bool $strict = false): array {}
159+
function array_keys(array $array, mixed $for_value = UNKNOWN, bool $strict = false): array {}
160160

161161
function array_key_first(array $array): int|string|null {}
162162

@@ -178,59 +178,59 @@ function array_change_key_case(array $array, int $case = CASE_LOWER): array {}
178178

179179
function array_unique(array $array, int $flags = SORT_STRING): array {}
180180

181-
function array_intersect_key(array $array1, array $array2, array ...$arrays): array {}
181+
function array_intersect_key(array $array, array $include, array ...$arrays): array {}
182182

183183
/** @param array|callable $rest */
184-
function array_intersect_ukey(array $array1, array $array2, ...$rest): array {}
184+
function array_intersect_ukey(array $array, array $include, ...$rest): array {}
185185

186-
function array_intersect(array $array1, array $array2, array ...$arrays): array {}
186+
function array_intersect(array $array, array $include, array ...$arrays): array {}
187187

188188
/** @param array|callable $rest */
189-
function array_uintersect(array $array1, array $array2, ...$rest): array {}
189+
function array_uintersect(array $array, array $include, ...$rest): array {}
190190

191-
function array_intersect_assoc(array $array1, array $array2, array ...$arrays): array {}
191+
function array_intersect_assoc(array $array, array $include, array ...$arrays): array {}
192192

193193
/** @param array|callable $rest */
194-
function array_uintersect_assoc(array $array1, array $array2, ...$rest): array {}
194+
function array_uintersect_assoc(array $array, array $include, ...$rest): array {}
195195

196196
/** @param array|callable $rest */
197-
function array_intersect_uassoc(array $array1, array $array2, ...$rest): array {}
197+
function array_intersect_uassoc(array $array, array $include, ...$rest): array {}
198198

199199
/** @param array|callable $rest */
200-
function array_uintersect_uassoc(array $array1, array $array2, ...$rest): array {}
200+
function array_uintersect_uassoc(array $array, array $include, ...$rest): array {}
201201

202-
function array_diff_key(array $array1, array $array2, array ...$arrays): array {}
202+
function array_diff_key(array $array, array $exclude, array ...$arrays): array {}
203203

204204
/** @param array|callable $rest */
205-
function array_diff_ukey(array $array1, array $array2, ...$rest): array {}
205+
function array_diff_ukey(array $array, array $exclude, ...$rest): array {}
206206

207-
function array_diff(array $array1, array $array2, array ...$arrays): array {}
207+
function array_diff(array $array, array $exclude, array ...$arrays): array {}
208208

209209
/** @param array|callable $rest */
210-
function array_udiff(array $array1, array $array2, ...$rest): array {}
210+
function array_udiff(array $array, array $exclude, ...$rest): array {}
211211

212-
function array_diff_assoc(array $array1, array $array2, array ...$arrays): array {}
212+
function array_diff_assoc(array $array, array $exclude, array ...$arrays): array {}
213213

214214
/** @param array|callable $rest */
215-
function array_diff_uassoc(array $array1, array $array2, ...$rest): array {}
215+
function array_diff_uassoc(array $array, array $exclude, ...$rest): array {}
216216

217217
/** @param array|callable $rest */
218-
function array_udiff_assoc(array $array1, array $array2, ...$rest): array {}
218+
function array_udiff_assoc(array $array, array $exclude, ...$rest): array {}
219219

220220
/** @param array|callable $rest */
221-
function array_udiff_uassoc(array $array1, array $array2, ...$rest): array {}
221+
function array_udiff_uassoc(array $array, array $exclude, ...$rest): array {}
222222

223223
/**
224224
* @param array $array1
225225
* @param int $sort_order
226-
* @param int $sort_flags
226+
* @param int $flags
227227
* @param array $arrays
228228
* @prefer-ref $array1
229229
* @prefer-ref $sort_order
230-
* @prefer-ref $sort_flags
230+
* @prefer-ref $flags
231231
* @prefer-ref $arrays
232232
*/
233-
function array_multisort(&$array1, $sort_order = SORT_ASC, $sort_flags = SORT_REGULAR, &...$arrays): bool {}
233+
function array_multisort(&$array1, $sort_order = SORT_ASC, $flags = SORT_REGULAR, &...$arrays): bool {}
234234

235235
function array_rand(array $array, int $num_req = 1): int|string|array {}
236236

@@ -242,16 +242,16 @@ function array_reduce(array $array, callable $callback, mixed $initial = null):
242242

243243
function array_filter(array $array, ?callable $callback = null, int $use_keys = 0): array {}
244244

245-
function array_map(?callable $callback, array $array1, array ...$arrays): array {}
245+
function array_map(?callable $callback, array $array, array ...$arrays): array {}
246246

247247
/** @param string|int $key */
248-
function array_key_exists($key, array $search): bool {}
248+
function array_key_exists($key, array $array): bool {}
249249

250250
/**
251251
* @param string|int $key
252252
* @alias array_key_exists
253253
*/
254-
function key_exists($key, array $search): bool {}
254+
function key_exists($key, array $array): bool {}
255255

256256
function array_chunk(array $array, int $size, bool $preserve_keys = false): array {}
257257

0 commit comments

Comments
 (0)