Skip to content

Improve error messages for magic methods by appending method's class #5397

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

Improve error messages for magic methods by appending method's class #5397

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
b815046
Reuse constants for lowercase magic methods
carusogabriel Apr 15, 2020
79dfa33
Improve error messages for magic methods by appending method's class
carusogabriel Apr 15, 2020
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
4 changes: 2 additions & 2 deletions Zend/tests/bug61025.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ echo $b->__invoke();

?>
--EXPECTF--
Warning: The magic method __invoke() must have public visibility and cannot be static in %sbug61025.php on line %d
Warning: The magic method InvokeAble::__invoke() must have public visibility and cannot be static in %sbug61025.php on line %d

Warning: The magic method __invoke() must have public visibility and cannot be static in %sbug61025.php on line %d
Warning: The magic method Bar::__invoke() must have public visibility and cannot be static in %sbug61025.php on line %d
Bar
Fatal error: Uncaught Error: Call to private method Bar::__invoke() from context '' in %sbug61025.php:%d
Stack trace:
Expand Down
2 changes: 1 addition & 1 deletion Zend/tests/bug65322.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ eval('class A { private function __invoke() { } }');

?>
--EXPECTF--
string(76) "The magic method __invoke() must have public visibility and cannot be static"
string(%d) "The magic method A::__invoke() must have public visibility and cannot be static"
string(%d) "%s(%d) : eval()'d code"
string(1) "X"
4 changes: 2 additions & 2 deletions Zend/tests/bug67436/bug67436.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ a::staticTest();

$b = new b();
$b->test();
--EXPECT--
string(76) "The magic method __invoke() must have public visibility and cannot be static"
--EXPECTF--
string(%d) "The magic method b::__invoke() must have public visibility and cannot be static"
b::test()
a::test(c::TESTCONSTANT)
2 changes: 1 addition & 1 deletion Zend/tests/bug67436/bug67436_nohandler.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ a::staticTest();
$b = new b();
$b->test();
--EXPECTF--
Warning: The magic method __invoke() must have public visibility and cannot be static in %s on line %d
Warning: The magic method b::__invoke() must have public visibility and cannot be static in %s on line %d
b::test()
a::test(c::TESTCONSTANT)
2 changes: 1 addition & 1 deletion Zend/tests/bug70215.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ $b();

?>
--EXPECTF--
Warning: The magic method __invoke() must have public visibility and cannot be static in %s on line %d
Warning: The magic method A::__invoke() must have public visibility and cannot be static in %s on line %d
A
2 changes: 1 addition & 1 deletion Zend/tests/errmsg_045.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ eval('class A { private function __invoke() { } }');

?>
--EXPECTF--
string(76) "The magic method __invoke() must have public visibility and cannot be static"
string(%d) "The magic method A::__invoke() must have public visibility and cannot be static"
string(%d) "%s(%d) : eval()'d code"

Warning: Undefined variable $undefined in %s on line %d
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_002.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ class foo {

?>
--EXPECTF--
Warning: The magic method __unset() must have public visibility and cannot be static in %s on line %d
Warning: The magic method foo::__unset() must have public visibility and cannot be static in %s on line %d
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_003.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ class foo {

?>
--EXPECTF--
Warning: The magic method __unset() must have public visibility and cannot be static in %s on line %d
Warning: The magic method foo::__unset() must have public visibility and cannot be static in %s on line %d
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_004.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ class foo {

?>
--EXPECTF--
Warning: The magic method __unset() must have public visibility and cannot be static in %s on line %d
Warning: The magic method foo::__unset() must have public visibility and cannot be static in %s on line %d
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_005.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ interface a {

?>
--EXPECTF--
Warning: The magic method __call() must have public visibility and cannot be static in %s on line %d
Warning: The magic method a::__call() must have public visibility and cannot be static in %s on line %d
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_006.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ interface a {

?>
--EXPECTF--
Warning: The magic method __callStatic() must have public visibility and be static in %s on line %d
Warning: The magic method a::__callStatic() must have public visibility and be static in %s on line %d
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_007.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ abstract class b {

?>
--EXPECTF--
Warning: The magic method __set() must have public visibility and cannot be static in %s on line %d
Warning: The magic method b::__set() must have public visibility and cannot be static in %s on line %d

Fatal error: Method b::__set() must take exactly 2 arguments in %s on line %d
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_008.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ class a extends b {

?>
--EXPECTF--
Warning: The magic method __set() must have public visibility and cannot be static in %s on line %d
Warning: The magic method a::__set() must have public visibility and cannot be static in %s on line %d

Fatal error: Access level to a::__set() must be public (as in class b) in %s on line 8
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_009.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ class a {

?>
--EXPECTF--
Warning: The magic method __callStatic() must have public visibility and be static in %s on line %d
Warning: The magic method a::__callStatic() must have public visibility and be static in %s on line %d
2 changes: 1 addition & 1 deletion Zend/tests/magic_methods_010.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ class a {

?>
--EXPECTF--
Warning: The magic method __toString() must have public visibility and cannot be static in %s on line %d
Warning: The magic method a::__toString() must have public visibility and cannot be static in %s on line %d

Fatal error: Method a::__tostring() cannot take arguments in %s on line %d
28 changes: 15 additions & 13 deletions Zend/zend_compile.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6049,16 +6049,18 @@ static void zend_compile_implicit_closure_uses(closure_info *info)
ZEND_HASH_FOREACH_END();
}

static void zend_check_magic_method_attr(uint32_t attr, const char* method, zend_bool is_static) /* {{{ */
static void zend_check_magic_method_attr(uint32_t attr, zend_class_entry *ce, const char* method, zend_bool is_static) /* {{{ */
{
if (is_static) {
if (!(attr & ZEND_ACC_PUBLIC) || !(attr & ZEND_ACC_STATIC)) {
zend_error(E_WARNING, "The magic method %s() must have public visibility and be static", method);
zend_error(E_WARNING,
"The magic method %s::%s() must have public visibility and be static",
ZSTR_VAL(ce->name), method);
}
} else if (!(attr & ZEND_ACC_PUBLIC) || (attr & ZEND_ACC_STATIC)) {
zend_error(E_WARNING,
"The magic method %s() must have public visibility and cannot be static",
method);
"The magic method %s::%s() must have public visibility and cannot be static",
ZSTR_VAL(ce->name), method);
}
}
/* }}} */
Expand Down Expand Up @@ -6138,35 +6140,35 @@ void zend_begin_method_decl(zend_op_array *op_array, zend_string *name, zend_boo
} else if (zend_string_equals_literal(lcname, ZEND_CLONE_FUNC_NAME)) {
ce->clone = (zend_function *) op_array;
} else if (zend_string_equals_literal(lcname, ZEND_CALL_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__call", 0);
zend_check_magic_method_attr(fn_flags, ce, ZEND_CALL_FUNC_NAME, 0);
ce->__call = (zend_function *) op_array;
} else if (zend_string_equals_literal(lcname, ZEND_CALLSTATIC_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__callStatic", 1);
zend_check_magic_method_attr(fn_flags, ce, "__callStatic", 1);
ce->__callstatic = (zend_function *) op_array;
} else if (zend_string_equals_literal(lcname, ZEND_GET_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__get", 0);
zend_check_magic_method_attr(fn_flags, ce, ZEND_GET_FUNC_NAME, 0);
ce->__get = (zend_function *) op_array;
ce->ce_flags |= ZEND_ACC_USE_GUARDS;
} else if (zend_string_equals_literal(lcname, ZEND_SET_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__set", 0);
zend_check_magic_method_attr(fn_flags, ce, ZEND_SET_FUNC_NAME, 0);
ce->__set = (zend_function *) op_array;
ce->ce_flags |= ZEND_ACC_USE_GUARDS;
} else if (zend_string_equals_literal(lcname, ZEND_UNSET_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__unset", 0);
zend_check_magic_method_attr(fn_flags, ce, ZEND_UNSET_FUNC_NAME, 0);
ce->__unset = (zend_function *) op_array;
ce->ce_flags |= ZEND_ACC_USE_GUARDS;
} else if (zend_string_equals_literal(lcname, ZEND_ISSET_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__isset", 0);
zend_check_magic_method_attr(fn_flags, ce, ZEND_ISSET_FUNC_NAME, 0);
ce->__isset = (zend_function *) op_array;
ce->ce_flags |= ZEND_ACC_USE_GUARDS;
} else if (zend_string_equals_literal(lcname, ZEND_TOSTRING_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__toString", 0);
zend_check_magic_method_attr(fn_flags, ce, "__toString", 0);
ce->__tostring = (zend_function *) op_array;
add_stringable_interface(ce);
} else if (zend_string_equals_literal(lcname, ZEND_INVOKE_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__invoke", 0);
zend_check_magic_method_attr(fn_flags, ce, ZEND_INVOKE_FUNC_NAME, 0);
} else if (zend_string_equals_literal(lcname, ZEND_DEBUGINFO_FUNC_NAME)) {
zend_check_magic_method_attr(fn_flags, "__debugInfo", 0);
zend_check_magic_method_attr(fn_flags, ce, "__debugInfo", 0);
ce->__debugInfo = (zend_function *) op_array;
}

Expand Down
2 changes: 1 addition & 1 deletion tests/classes/__call_005.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ $b = new B();
$b->test();
?>
--EXPECTF--
Warning: The magic method __call() must have public visibility and cannot be static in %s__call_005.php on line 3
Warning: The magic method A::__call() must have public visibility and cannot be static in %s__call_005.php on line 3
In A::__call(test1, array(1,a))
object(B)#1 (0) {
}
Expand Down
2 changes: 1 addition & 1 deletion tests/classes/__call_007.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ try {
}
?>
--EXPECTF--
Warning: The magic method __call() must have public visibility and cannot be static in %s on line 3
Warning: The magic method A::__call() must have public visibility and cannot be static in %s on line 3
---> Invoke __call via simple method call.
object(A)#1 (0) {
}
Expand Down