8000 [Debug] UndefinedMethodFatalErrorHandler - Handle anonymous classes by SpacePossum · Pull Request #21010 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Debug] UndefinedMethodFatalErrorHandler - Handle anonymous classes #21010

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

[Debug] UndefinedMethodFatalErrorHandler - Handle anonymous classes #21010

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0947105
Handle anonymous class without methods correctly.
SpacePossum Dec 21, 2016
591b2ca
Update after review.
SpacePossum Dec 27, 2016
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
Next Next commit
Handle anonymous class without methods correctly.
  • Loading branch information
@SpacePossum
SpacePossum committed Dec 27, 2016
commit 094710572cf055011680b42d39f34c59457d5723
6 changes: 5 additions & 1 deletion src/Symfony/Component/Debug/FatalErrorHandler/UndefinedMethodFatalErrorHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,12 @@ public function handleError(array $error, FatalErrorException $exception)

$message = sprintf('Attempted to call an undefined method named "%s" of class "%s".', $methodName, $className);

if (null === $methods = get_class_methods($className)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking at the comments below, this could be turned to: if (!class_exists($className, false)), isn'it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would decrease the number of failures indeed.
However the docs of get_class_methods state it will return null on error, not that it will only return null when passing a "class name" of an anonymous class. Checking the return value of get-class-methods for null seems to me the safe bet.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we know any other condition that could make this return null? if not, it'd be more readable to use class_exists, don't you thing?

Copy link
Contributor Author
@SpacePossum SpacePossum Dec 27, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't check the implementation of get_class_methods, however the API docs. leave it open on when an error can happen. I've update the code in a way we've the best of the two solutions, i.e. we do the class_exists check first but still check the result of get_class_methods. This way the code will keep working even if get_class_methods might return null later on because of changes in the implementation. Let me know what you think!

return new UndefinedMethodException($message, $exception);
}

$candidates = array();
foreach (get_class_methods($className) as $definedMethodName) {
foreach ($methods as $definedMethodName) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could simply be

foreach ((array) get_class_methods($className) as $definedMethodName) {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👎
I think code should be as explicit as possible. Here we want to iterate methods if there are any. We don't want to cast the result to an array and iterate that and be depended on the result of the cast. To me it makes no sense that (array) null result in an empty array, I would expect an error. Another side effect of always casting is that it would be done even when not needed.

Copy link
Contributor
@ogizanagi ogizanagi Dec 21, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Casting to an array is something commonly used in the Symfony codebase, even in more critical paths where micro optimizations would matter more. To me the intention is clear, but I hear your arguments.

Also the issue here is more about class@anonymous not being a class name, which is why get_class_methods returns null as a way to notify there is an issue with the function call, not as I first thought a PHP inconsistency due to an anonymous class without any method. You don't access the generated internal class name here nor the instance, so it's expected to get null.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, micro optimizations are not needed here as it is already in error/exception path so fast execution is not that important.

Yes, sadly we cannot access the instance of the anonymous class here to figure out what methods are on there, so I guess this is the best we can do.

Let me know if the array cast is a deal breaker for the PR to be merged, always happy to agree to disagree and update a PR if the end-result is better than the current state :)

$lev = levenshtein($methodName, $definedMethodName);
if ($lev <= strlen($methodName) / 3 || false !== strpos($definedMethodName, $methodName)) {
$candidates[] = $definedMethodName;
Expand Down
9 changes: 9 additions & 0 deletions src/Symfony/Component/Debug/Tests/FatalErrorHandler/UndefinedMethodFatalErrorHandlerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ public function provideUndefinedMethodData()
),
"Attempted to call an undefined method named \"offsetFet\" of class \"SplObjectStorage\".\nDid you mean to call e.g. \"offsetGet\", \"offsetSet\" or \"offsetUnset\"?",
),
array(
array(
'type' => 1,
'message' => 'Call to undefined method class@anonymous::test()',
'file' => '/home/possum/work/symfony/test.php',
'line' => 11,
),
'Attempted to call an undefined method named "test" of class "class@anonymous".',
),
);
}
}
0