Skip to content

Fix missing "Optional parameter before required" deprecation on union null type #11497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Fix missing "Optional parameter before required" deprecation on union null type #11497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98c5cf9
Fix missing "Optional parameter before required" deprecation on union…
iluuu1994 Jun 21, 2023
d071559
Add test for intersection type, remove redundant line
iluuu1994 Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Zend/tests/gh11488.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
--TEST--
GH-11488: "Optional parameter before required" warning for union nullable type
--FILE--
<?php
function a(
string|null $a = null,
$b,
) {}

function b(
Foo&Bar $c = null,
$d,
) {}
?>
--EXPECTF--
Deprecated: Optional parameter $a declared before required parameter $b is implicitly treated as a required parameter in %s on line %d
61 changes: 36 additions & 25 deletions Zend/zend_compile.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6500,8 +6500,10 @@ static void zend_is_type_list_redundant_by_single_type(zend_type_list *type_list
}
}

static zend_type zend_compile_typename(
zend_ast *ast, bool force_allow_null) /* {{{ */
static zend_type zend_compile_typename(zend_ast *ast, bool force_allow_null);

static zend_type zend_compile_typename_ex(
zend_ast *ast, bool force_allow_null, bool *forced_allow_null) /* {{{ */
{
bool is_marked_nullable = ast->attr & ZEND_TYPE_NULLABLE;
zend_ast_attr orig_ast_attr = ast->attr;
Expand Down Expand Up @@ -6704,6 +6706,10 @@ static zend_type zend_compile_typename(
zend_error_noreturn(E_COMPILE_ERROR, "null cannot be marked as nullable");
}

if (force_allow_null && !is_marked_nullable && !(type_mask & MAY_BE_NULL)) {
*forced_allow_null = true;
}

if (is_marked_nullable || force_allow_null) {
ZEND_TYPE_FULL_MASK(type) |= MAY_BE_NULL;
type_mask = ZEND_TYPE_PURE_MASK(type);
Expand All @@ -6722,6 +6728,12 @@ static zend_type zend_compile_typename(
}
/* }}} */

static zend_type zend_compile_typename(zend_ast *ast, bool force_allow_null)
{
bool forced_allow_null;
return zend_compile_typename_ex(ast, force_allow_null, &forced_allow_null);
}

/* May convert value from int to float. */
static bool zend_is_valid_default_value(zend_type type, zval *value)
{
Expand Down Expand Up @@ -6951,28 +6963,6 @@ static void zend_compile_params(zend_ast *ast, zend_ast *return_type_ast, uint32
zend_const_expr_to_zval(
&default_node.u.constant, default_ast_ptr, /* allow_dynamic */ true);
CG(compiler_options) = cops;

if (last_required_param != (uint32_t) -1 && i < last_required_param) {
/* Ignore parameters of the form "Type $param = null".
* This is the PHP 5 style way of writing "?Type $param", so allow it for now. */
bool is_implicit_nullable =
type_ast && !(type_ast->attr & ZEND_TYPE_NULLABLE)
&& Z_TYPE(default_node.u.constant) == IS_NULL;
if (!is_implicit_nullable) {
zend_ast *required_param_ast = list->child[last_required_param];
zend_error(E_DEPRECATED,
"Optional parameter $%s declared before required parameter $%s "
"is implicitly treated as a required parameter",
ZSTR_VAL(name), ZSTR_VAL(zend_ast_get_str(required_param_ast->child[1])));
}

/* Regardless of whether we issue a deprecation, convert this parameter into
* a required parameter without a default value. This ensures that it cannot be
* used as an optional parameter even with named parameters. */
opcode = ZEND_RECV;
default_node.op_type = IS_UNUSED;
zval_ptr_dtor(&default_node.u.constant);
}
} else {
opcode = ZEND_RECV;
default_node.op_type = IS_UNUSED;
Expand All @@ -6990,12 +6980,13 @@ static void zend_compile_params(zend_ast *ast, zend_ast *return_type_ast, uint32
);
}

bool forced_allow_nullable = false;
if (type_ast) {
uint32_t default_type = *default_ast_ptr ? Z_TYPE(default_node.u.constant) : IS_UNDEF;
bool force_nullable = default_type == IS_NULL && !property_flags;

op_array->fn_flags |= ZEND_ACC_HAS_TYPE_HINTS;
arg_info->type = zend_compile_typename(type_ast, force_nullable);
arg_info->type = zend_compile_typename_ex(type_ast, force_nullable, &forced_allow_nullable);

if (ZEND_TYPE_FULL_MASK(arg_info->type) & MAY_BE_VOID) {
zend_error_noreturn(E_COMPILE_ERROR, "void cannot be used as a parameter type");
Expand All @@ -7014,6 +7005,26 @@ static void zend_compile_params(zend_ast *ast, zend_ast *return_type_ast, uint32
ZSTR_VAL(name), ZSTR_VAL(type_str));
}
}
if (last_required_param != (uint32_t) -1
&& i < last_required_param
&& default_node.op_type == IS_CONST) {
/* Ignore parameters of the form "Type $param = null".
* This is the PHP 5 style way of writing "?Type $param", so allow it for now. */
if (!forced_allow_nullable) {
zend_ast *required_param_ast = list->child[last_required_param];
zend_error(E_DEPRECATED,
"Optional parameter $%s declared before required parameter $%s "
"is implicitly treated as a required parameter",
ZSTR_VAL(name), ZSTR_VAL(zend_ast_get_str(required_param_ast->child[1])));
}

/* Regardless of whether we issue a deprecation, convert this parameter into
* a required parameter without a default value. This ensures that it cannot be
* used as an optional parameter even with named parameters. */
opcode = ZEND_RECV;
default_node.op_type = IS_UNUSED;
zval_ptr_dtor(&default_node.u.constant);
}

opline = zend_emit_op(NULL, opcode, NULL, &default_node);
SET_NODE(opline->result, &var_node);
Expand Down