Skip to content

Commit 96f2f31

Browse files
Crellsgolemon
authored andcommitted
Update array parameter names for named parameters
* The array "subject" of a function gets called $array. * Further parameters should be self-descriptive if used as a named parameter, and a full word, not an abbreviation. * If there is a "bunch more arrays" variadic, it gets called $arrays (because that's what was already there). * A few functions have a variadic "a bunch more arrays, and then a callable", and were already called $rest. I left those as is and died a little inside. * Any callable provided to an array function that acts on the array is called $callback. (Nearly all were already, I just fixed the one or two outliers.) * array_multisort() is beyond help so I ran screaming.
1 parent 57a4a2c commit 96f2f31

12 files changed

+55
-58
lines changed

Zend/tests/bug31720.phpt

+1-1
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

+2-2
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], filter_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 ($filter_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

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Name: array
5151
Is passed by reference: yes
5252
Can be passed by value: no
5353

54-
Name: sort_flags
54+
Name: flags
5555
Is passed by reference: no
5656
Can be passed by value: yes
5757

ext/spl/tests/arrayObject_asort_basic1.phpt

+1-1
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

+1-1
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

+22-22
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 Countable|array $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 $argument = 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 $argument = 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 $filter_value = UNKNOWN, bool $strict = false): array {}
160160

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

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

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

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

243243
/** @param string|int $key */
244-
function array_key_exists($key, array $search): bool {}
244+
function array_key_exists($key, array $array): bool {}
245245

246246
/**
247247
* @param string|int $key
248248
* @alias array_key_exists
249249
*/
250-
function key_exists($key, array $search): bool {}
250+
function key_exists($key, array $array): bool {}
251251

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

ext/standard/basic_functions_arginfo.h

100755100644
+21-24
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* This is a generated file, edit the .stub.php file instead.
2-
* Stub hash: d1bcbdfe71bdc57680abe391d1ef2859538615c2 */
2+
* Stub hash: 26683100d272e35a6318e0eaece65dc3761b7b03 */
33

44
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_set_time_limit, 0, 1, _IS_BOOL, 0)
55
ZEND_ARG_TYPE_INFO(0, seconds, IS_LONG, 0)
@@ -71,12 +71,12 @@ ZEND_END_ARG_INFO()
7171

7272
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_push, 0, 1, IS_LONG, 0)
7373
ZEND_ARG_TYPE_INFO(1, stack, IS_ARRAY, 0)
74-
ZEND_ARG_VARIADIC_TYPE_INFO(0, args, IS_MIXED, 0)
74+
ZEND_ARG_VARIADIC_TYPE_INFO(0, values, IS_MIXED, 0)
7575
ZEND_END_ARG_INFO()
7676

7777
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_krsort, 0, 1, _IS_BOOL, 0)
7878
ZEND_ARG_TYPE_INFO(1, array, IS_ARRAY, 0)
79-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, sort_flags, IS_LONG, 0, "SORT_REGULAR")
79+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, flags, IS_LONG, 0, "SORT_REGULAR")
8080
ZEND_END_ARG_INFO()
8181

8282
#define arginfo_ksort arginfo_krsort
@@ -104,7 +104,7 @@ ZEND_END_ARG_INFO()
104104

105105
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_usort, 0, 2, _IS_BOOL, 0)
106106
ZEND_ARG_TYPE_INFO(1, array, IS_ARRAY, 0)
107-
ZEND_ARG_TYPE_INFO(0, cmp_function, IS_CALLABLE, 0)
107+
ZEND_ARG_TYPE_INFO(0, callback, IS_CALLABLE, 0)
108108
ZEND_END_ARG_INFO()
109109

110110
#define arginfo_uasort arginfo_usort
@@ -140,8 +140,8 @@ ZEND_END_ARG_INFO()
140140

141141
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_walk, 0, 2, _IS_BOOL, 0)
142142
ZEND_ARG_TYPE_MASK(1, input, MAY_BE_ARRAY|MAY_BE_OBJECT, NULL)
143-
ZEND_ARG_TYPE_INFO(0, funcname, IS_CALLABLE, 0)
144-
ZEND_ARG_TYPE_INFO(0, userdata, IS_MIXED, 0)
143+
ZEND_ARG_TYPE_INFO(0, callback, IS_CALLABLE, 0)
144+
ZEND_ARG_TYPE_INFO(0, argument, IS_MIXED, 0)
145145
ZEND_END_ARG_INFO()
146146

147147
#define arginfo_array_walk_recursive arginfo_array_walk
@@ -171,13 +171,13 @@ ZEND_END_ARG_INFO()
171171

172172
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_fill, 0, 3, IS_ARRAY, 0)
173173
ZEND_ARG_TYPE_INFO(0, start_key, IS_LONG, 0)
174-
ZEND_ARG_TYPE_INFO(0, num, IS_LONG, 0)
175-
ZEND_ARG_TYPE_INFO(0, val, IS_MIXED, 0)
174+
ZEND_ARG_TYPE_INFO(0, count, IS_LONG, 0)
175+
ZEND_ARG_TYPE_INFO(0, value, IS_MIXED, 0)
176176
ZEND_END_ARG_INFO()
177177

178178
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_fill_keys, 0, 2, IS_ARRAY, 0)
179179
ZEND_ARG_TYPE_INFO(0, keys, IS_ARRAY, 0)
180-
ZEND_ARG_TYPE_INFO(0, val, IS_MIXED, 0)
180+
ZEND_ARG_TYPE_INFO(0, value, IS_MIXED, 0)
181181
ZEND_END_ARG_INFO()
182182

183183
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_range, 0, 2, IS_ARRAY, 0)
@@ -194,16 +194,13 @@ ZEND_END_ARG_INFO()
194194

195195
#define arginfo_array_shift arginfo_array_pop
196196

197-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_unshift, 0, 1, IS_LONG, 0)
198-
ZEND_ARG_TYPE_INFO(1, stack, IS_ARRAY, 0)
199-
ZEND_ARG_VARIADIC_TYPE_INFO(0, vars, IS_MIXED, 0)
200-
ZEND_END_ARG_INFO()
197+
#define arginfo_array_unshift arginfo_array_push
201198

202199
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_splice, 0, 2, IS_ARRAY, 0)
203200
ZEND_ARG_TYPE_INFO(1, array, IS_ARRAY, 0)
204201
ZEND_ARG_TYPE_INFO(0, offset, IS_LONG, 0)
205202
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, length, IS_LONG, 1, "null")
206-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, replacement, IS_MIXED, 0, "[]")
203+
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, replacements, IS_MIXED, 0, "[]")
207204
ZEND_END_ARG_INFO()
208205

209206
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_slice, 0, 2, IS_ARRAY, 0)
@@ -220,15 +217,15 @@ ZEND_END_ARG_INFO()
220217
#define arginfo_array_merge_recursive arginfo_array_merge
221218

222219
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_replace, 0, 1, IS_ARRAY, 0)
223-
ZEND_ARG_TYPE_INFO(0, array1, IS_ARRAY, 0)
224-
ZEND_ARG_VARIADIC_TYPE_INFO(0, arrays, IS_ARRAY, 0)
220+
ZEND_ARG_TYPE_INFO(0, array, IS_ARRAY, 0)
221+
ZEND_ARG_VARIADIC_TYPE_INFO(0, replacements, IS_ARRAY, 0)
225222
ZEND_END_ARG_INFO()
226223

227224
#define arginfo_array_replace_recursive arginfo_array_replace
228225

229226
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_keys, 0, 1, IS_ARRAY, 0)
230227
ZEND_ARG_TYPE_INFO(0, array, IS_ARRAY, 0)
231-
ZEND_ARG_TYPE_INFO(0, search_value, IS_MIXED, 0)
228+
ZEND_ARG_TYPE_INFO(0, filter_value, IS_MIXED, 0)
232229
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, strict, _IS_BOOL, 0, "false")
233230
ZEND_END_ARG_INFO()
234231

@@ -341,13 +338,13 @@ ZEND_END_ARG_INFO()
341338

342339
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_map, 0, 2, IS_ARRAY, 0)
343340
ZEND_ARG_TYPE_INFO(0, callback, IS_CALLABLE, 1)
344-
ZEND_ARG_TYPE_INFO(0, array1, IS_ARRAY, 0)
341+
ZEND_ARG_TYPE_INFO(0, array, IS_ARRAY, 0)
345342
ZEND_ARG_VARIADIC_TYPE_INFO(0, arrays, IS_ARRAY, 0)
346343
ZEND_END_ARG_INFO()
347344

348345
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_array_key_exists, 0, 2, _IS_BOOL, 0)
349346
ZEND_ARG_INFO(0, key)
350-
ZEND_ARG_TYPE_INFO(0, search, IS_ARRAY, 0)
347+
ZEND_ARG_TYPE_INFO(0, array, IS_ARRAY, 0)
351348
ZEND_END_ARG_INFO()
352349

353350
#define arginfo_key_exists arginfo_array_key_exists
@@ -746,7 +743,7 @@ ZEND_END_ARG_INFO()
746743
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_setrawcookie, 0, 1, _IS_BOOL, 0)
747744
ZEND_ARG_TYPE_INFO(0, name, IS_STRING, 0)
748745
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, value, IS_STRING, 0, "\'\'")
749-
ZEND_ARG_TYPE_MASK(0, expires_or_options, MAY_BE_ARRAY|MAY_BE_LONG, "0")
746+
ZEND_ARG_INFO_WITH_DEFAULT_VALUE(0, expires_or_options, "0")
750747
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, path, IS_STRING, 0, "\'\'")
751748
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, domain, IS_STRING, 0, "\'\'")
752749
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, secure, _IS_BOOL, 0, "false")
@@ -935,9 +932,9 @@ ZEND_END_ARG_INFO()
935932

936933
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_substr_replace, 0, 3, MAY_BE_STRING|MAY_BE_ARRAY|MAY_BE_FALSE)
937934
ZEND_ARG_TYPE_MASK(0, str, MAY_BE_ARRAY|MAY_BE_STRING, NULL)
938-
ZEND_ARG_TYPE_MASK(0, replace, MAY_BE_ARRAY|MAY_BE_STRING, NULL)
939-
ZEND_ARG_TYPE_MASK(0, start, MAY_BE_ARRAY|MAY_BE_LONG, NULL)
940-
ZEND_ARG_TYPE_MASK(0, length, MAY_BE_ARRAY|MAY_BE_LONG|MAY_BE_NULL, "null")
935+
ZEND_ARG_TYPE_MASK(0, replace, MAY_BE_STRING|MAY_BE_ARRAY, NULL)
936+
ZEND_ARG_INFO(0, start)
937+
ZEND_ARG_INFO_WITH_DEFAULT_VALUE(0, length, "null")
941938
ZEND_END_ARG_INFO()
942939

943940
#define arginfo_quotemeta arginfo_base64_encode
@@ -1773,7 +1770,7 @@ ZEND_END_ARG_INFO()
17731770

17741771
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_password_needs_rehash, 0, 2, _IS_BOOL, 0)
17751772
ZEND_ARG_TYPE_INFO(0, hash, IS_STRING, 0)
1776-
ZEND_ARG_TYPE_MASK(0, algo, MAY_BE_STRING|MAY_BE_LONG|MAY_BE_NULL, NULL)
1773+
ZEND_ARG_TYPE_MASK(0, algo, MAY_BE_STRING|MAY_BE_LONG, NULL)
17771774
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, options, IS_ARRAY, 0, "[]")
17781775
ZEND_END_ARG_INFO()
17791776

ext/standard/tests/array/array_fill_error.phpt

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ try {
1818
?>
1919
--EXPECT--
2020
*** Testing array_fill() : error conditions ***
21-
array_fill(): Argument #2 ($num) must be greater than or equal to 0
21+
array_fill(): Argument #2 ($count) must be greater than or equal to 0

ext/standard/tests/array/array_map_variation10.phpt

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,5 +83,5 @@ array(3) {
8383
NULL
8484
}
8585
-- passing NULL as 'array1' --
86-
array_map(): Argument #2 ($array1) must be of type array, null given
86+
array_map(): Argument #2 ($array) must be of type array, null given
8787
Done

ext/standard/tests/array/array_walk_recursive_variation8.phpt

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ bool(true)
3535
-- With 'min' built-in function --
3636
bool(true)
3737
-- With 'echo' language construct --
38-
array_walk_recursive(): Argument #2 ($funcname) must be a valid callback, function "echo" not found or invalid function name
38+
array_walk_recursive(): Argument #2 ($callback) must be a valid callback, function "echo" not found or invalid function name
3939
Done

ext/standard/tests/array/array_walk_variation8.phpt

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ bool(true)
3535
-- With 'min' built-in function --
3636
bool(true)
3737
-- With 'echo' language construct --
38-
array_walk(): Argument #2 ($funcname) must be a valid callback, function "echo" not found or invalid function name
38+
array_walk(): Argument #2 ($callback) must be a valid callback, function "echo" not found or invalid function name
3939
Done

ext/standard/tests/array/bug74345.phpt

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ try {
4040
?>
4141
===DONE===
4242
--EXPECT--
43-
array_map(): Argument #2 ($array1) must be of type array, null given
44-
array_map(): Argument #2 ($array1) must be of type array, null given
43+
array_map(): Argument #2 ($array) must be of type array, null given
44+
array_map(): Argument #2 ($array) must be of type array, null given
4545
preg_replace_callback(): Argument #3 ($subject) must be of type array|string, stdClass given
4646
===DONE===

0 commit comments

Comments
 (0)