Skip to content

Commit

Permalink
Rename standard array function parameters to $array
Browse files Browse the repository at this point in the history
This is targeting 8.0.

`$arg` seems like a poor choice of a name,
especially if the function were to have arguments added.

In many cases, the php.net documentation already has $array for these functions.
E.g. https://www.php.net/manual/en/function.array-intersect.php

I'd assume that since named arguments was added to 8.0 near the feature freeze,
PHP's maintainers had planned to make the names consistent
and gradually use the same name for  docs and implementation.
  • Loading branch information
TysonAndre committed Aug 11, 2020
1 parent 10f660f commit 1e9a5c6
Show file tree
Hide file tree
Showing 48 changed files with 1,403 additions and 1,403 deletions.
4 changes: 2 additions & 2 deletions Zend/tests/call_user_func_009.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ var_dump(\call_user_func('sort', []));

?>
--EXPECTF--
Warning: sort(): Argument #1 ($arg) must be passed by reference, value given in %s on line %d
Warning: sort(): Argument #1 ($array) must be passed by reference, value given in %s on line %d
bool(true)

Warning: sort(): Argument #1 ($arg) must be passed by reference, value given in %s on line %d
Warning: sort(): Argument #1 ($array) must be passed by reference, value given in %s on line %d
bool(true)
6 changes: 3 additions & 3 deletions Zend/tests/named_params/internal.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ Named params on internal functions
--FILE--
<?php

var_dump(array_slice(arg: [1, 2, 3, 4, 5], offset: 2, length: 2));
var_dump(array_slice(length: 2, offset: 2, arg: [1, 2, 3, 4, 5]));
var_dump(array_slice(array: [1, 2, 3, 4, 5], offset: 2, length: 2));
var_dump(array_slice(length: 2, offset: 2, array: [1, 2, 3, 4, 5]));

var_dump(array_slice(arg: ['a' => 0, 'b' => 1], offset: 1, preserve_keys: true));
var_dump(array_slice(array: ['a' => 0, 'b' => 1], offset: 1, preserve_keys: true));
var_dump(array_slice(['a' => 0, 'b' => 1], preserve_keys: true, offset: 1));
var_dump(str_pad("foo", 6, pad_type: STR_PAD_LEFT));

Expand Down
2 changes: 1 addition & 1 deletion Zend/tests/named_params/missing_param.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ var_dump(array_keys([41, 42], search_value: 42, strict: true));
?>
--EXPECT--
test(): Argument #2 ($b) not passed
array_keys(): Argument #1 ($arg) not passed
array_keys(): Argument #1 ($array) not passed
array_keys(): Argument #2 ($search_value) must be passed explicitly, because the default value is not known
array(1) {
[0]=>
Expand Down
2 changes: 1 addition & 1 deletion Zend/tests/nullsafe_operator/013.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ string(56) "get_called_class() expects exactly 0 parameters, 1 given"
string(4) "NULL"
string(53) "func_num_args() expects exactly 0 parameters, 1 given"
string(53) "func_get_args() expects exactly 0 parameters, 1 given"
string(67) "array_slice(): Argument #1 ($arg) must be of type array, null given"
string(69) "array_slice(): Argument #1 ($array) must be of type array, null given"
array(1) {
[0]=>
string(3) "foo"
Expand Down
12 changes: 6 additions & 6 deletions ext/reflection/tests/ReflectionParameter_canBePassedByValue.phpt
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ aux('sort');

echo "=> user function:\n\n";

function ufunc(&$arg1, $arg2) {}
function ufunc(&$array1, $array2) {}

aux('ufunc');

Expand All @@ -37,7 +37,7 @@ echo "Done.\n";
--EXPECT--
=> array_multisort:

Name: arr1
Name: array1
Is passed by reference: yes
Can be passed by value: yes

Expand All @@ -49,13 +49,13 @@ Name: sort_flags
Is passed by reference: yes
Can be passed by value: yes

Name: arr2
Name: arrays
Is passed by reference: yes
Can be passed by value: yes

=> sort:

Name: arg
Name: array
Is passed by reference: yes
Can be passed by value: no

Expand All @@ -65,11 +65,11 @@ Can be passed by value: yes

=> user function:

Name: arg1
Name: array1
Is passed by reference: yes
Can be passed by value: no

Name: arg2
Name: array2
Is passed by reference: no
Can be passed by value: yes

Expand Down
2 changes: 1 addition & 1 deletion ext/standard/array.c
Original file line number Diff line number Diff line change
Expand Up @@ -5811,7 +5811,7 @@ PHP_FUNCTION(array_rand)
}

if (num_req <= 0 || num_req > num_avail) {
zend_argument_value_error(2, "must be between 1 and the number of elements in argument #1 ($arg)");
zend_argument_value_error(2, "must be between 1 and the number of elements in argument #1 ($array)");
RETURN_THROWS();
}

Expand Down
110 changes: 55 additions & 55 deletions ext/standard/basic_functions.stub.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ function stream_wrapper_restore(string $protocol): bool {}

function array_push(array &$stack, mixed ...$args): int {}

function krsort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
function krsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}

function ksort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
function ksort(array &$array, int $sort_flags = SORT_REGULAR): bool {}

/** @param array|Countable|null $var */
function count($var, int $mode = COUNT_NORMAL): int {}
Expand All @@ -72,23 +72,23 @@ function count($var, int $mode = COUNT_NORMAL): int {}
*/
function sizeof($var, int $mode = COUNT_NORMAL): int {}

function natsort(array &$arg): bool {}
function natsort(array &$array): bool {}

function natcasesort(array &$arg): bool {}
function natcasesort(array &$array): bool {}

function asort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
function asort(array &$array, int $sort_flags = SORT_REGULAR): bool {}

function arsort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
function arsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}

function sort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
function sort(array &$array, int $sort_flags = SORT_REGULAR): bool {}

function rsort(array &$arg, int $sort_flags = SORT_REGULAR): bool {}
function rsort(array &$array, int $sort_flags = SORT_REGULAR): bool {}

function usort(array &$arg, callable $cmp_function): bool {}
function usort(array &$array, callable $cmp_function): bool {}

function uasort(array &$arg, callable $cmp_function): bool {}
function uasort(array &$array, callable $cmp_function): bool {}

function uksort(array &$arg, callable $cmp_function): bool {}
function uksort(array &$array, callable $cmp_function): bool {}

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

Expand Down Expand Up @@ -117,8 +117,8 @@ function in_array(mixed $needle, array $haystack, bool $strict = false): bool {}

function array_search(mixed $needle, array $haystack, bool $strict = false): int|string|false {}

/** @prefer-ref $arg */
function extract(array &$arg, int $extract_type = EXTR_OVERWRITE, string $prefix = ""): int {}
/** @prefer-ref $array */
function extract(array &$array, int $extract_type = EXTR_OVERWRITE, string $prefix = ""): int {}

function compact($var_name, ...$var_names): array {}

Expand All @@ -133,103 +133,103 @@ function array_fill_keys(array $keys, mixed $val): array {}
*/
function range($low, $high, $step = 1): array {}

function shuffle(array &$arg): bool {}
function shuffle(array &$array): bool {}

function array_pop(array &$stack): mixed {}

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

function array_unshift(array &$stack, mixed ...$vars): int {}

function array_splice(array &$arg, int $offset, ?int $length = null, mixed $replacement = []): array {}
function array_splice(array &$array, int $offset, ?int $length = null, mixed $replacement = []): array {}

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

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

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

function array_replace(array $arr1, array ...$arrays): array {}
function array_replace(array $array1, array ...$arrays): array {}

function array_replace_recursive(array $arr1, array ...$arrays): array {}
function array_replace_recursive(array $array1, array ...$arrays): array {}

function array_keys(array $arg, mixed $search_value = UNKNOWN, bool $strict = false): array {}
function array_keys(array $array, mixed $search_value = UNKNOWN, bool $strict = false): array {}

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

function array_key_last(array $arg): int|string|null {}
function array_key_last(array $array): int|string|null {}

function array_values(array $arg): array {}
function array_values(array $array): array {}

function array_count_values(array $arg): array {}
function array_count_values(array $array): array {}

function array_column(array $arg, int|string|null $column_key, int|string|null $index_key = null): array {}
function array_column(array $array, int|string|null $column_key, int|string|null $index_key = null): array {}

function array_reverse(array $input, bool $preserve_keys = false): array {}

function array_pad(array $arg, int $pad_size, mixed $pad_value): array {}
function array_pad(array $array, int $pad_size, mixed $pad_value): array {}

function array_flip(array $arg): array {}
function array_flip(array $array): array {}

function array_change_key_case(array $input, int $case = CASE_LOWER): array {}

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

function array_intersect_key(array $arr1, array $arr2, array ...$arrays): array {}
function array_intersect_key(array $array1, array $array2, array ...$arrays): array {}

function array_intersect_ukey(array $arr1, array $arr2, ...$rest): array {}
function array_intersect_ukey(array $array1, array $array2, ...$rest): array {}

function array_intersect(array $arr1, array $arr2, array ...$arrays): array {}
function array_intersect(array $array1, array $array2, array ...$arrays): array {}

function array_uintersect(array $arr1, array $arr2, ...$rest): array {}
function array_uintersect(array $array1, array $array2, ...$rest): array {}

function array_intersect_assoc(array $arr1, array $arr2, array ...$arrays): array {}
function array_intersect_assoc(array $array1, array $array2, array ...$arrays): array {}

function array_uintersect_assoc(array $arr1, array $arr2, ...$rest): array {}
function array_uintersect_assoc(array $array1, array $array2, ...$rest): array {}

function array_intersect_uassoc(array $arr1, array $arr2, ...$rest): array {}
function array_intersect_uassoc(array $array1, array $array2, ...$rest): array {}

function array_uintersect_uassoc(array $arr1, array $arr2, ...$rest): array {}
function array_uintersect_uassoc(array $array1, array $array2, ...$rest): array {}

function array_diff_key(array $arr1, array $arr2, array ...$arrays): array {}
function array_diff_key(array $array1, array $array2, array ...$arrays): array {}

function array_diff_ukey(array $arr1, array $arr2, ...$rest): array {}
function array_diff_ukey(array $array1, array $array2, ...$rest): array {}

function array_diff(array $arr1, array $arr2, array ...$arrays): array {}
function array_diff(array $array1, array $array2, array ...$arrays): array {}

function array_udiff(array $arr1, array $arr2, ...$rest): array {}
function array_udiff(array $array1, array $array2, ...$rest): array {}

function array_diff_assoc(array $arr1, array $arr2, array ...$arrays): array {}
function array_diff_assoc(array $array1, array $array2, array ...$arrays): array {}

function array_diff_uassoc(array $arr1, array $arr2, ...$rest): array {}
function array_diff_uassoc(array $array1, array $array2, ...$rest): array {}

function array_udiff_assoc(array $arr1, array $arr2, ...$rest): array {}
function array_udiff_assoc(array $array1, array $array2, ...$rest): array {}

function array_udiff_uassoc(array $arr1, array $arr2, ...$rest): array {}
function array_udiff_uassoc(array $array1, array $array2, ...$rest): array {}

/**
* @param array $arr1
* @param array $array1
* @param int $sort_order
* @param int $sort_flags
* @param array $arr2
* @prefer-ref $arr1
* @param array $array2
* @prefer-ref $array1
* @prefer-ref $sort_order
* @prefer-ref $sort_flags
* @prefer-ref $arr2
* @prefer-ref $arrays
*/
function array_multisort(&$arr1, $sort_order = SORT_ASC, $sort_flags = SORT_REGULAR, &...$arr2): bool {}
function array_multisort(&$array1, $sort_order = SORT_ASC, $sort_flags = SORT_REGULAR, &...$arrays): bool {}

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

function array_sum(array $arg): int|float {}
function array_sum(array $array): int|float {}

function array_product(array $arg): int|float {}
function array_product(array $array): int|float {}

function array_reduce(array $arg, callable $callback, mixed $initial = null): mixed {}
function array_reduce(array $array, callable $callback, mixed $initial = null): mixed {}

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

function array_map(?callable $callback, array $arr1, array ...$arrays): array {}
function array_map(?callable $callback, array $array1, array ...$arrays): array {}

/** @param int|string $key */
function array_key_exists($key, array $search): bool {}
Expand All @@ -240,7 +240,7 @@ function array_key_exists($key, array $search): bool {}
*/
function key_exists($key, array $search): bool {}

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

function array_combine(array $keys, array $values): array {}

Expand Down

0 comments on commit 1e9a5c6

Please sign in to comment.