Invalid Return Type

[widoz]

#12

[gmazzap]

The lines:

if (!$followedBySemicolon) {
   return false;
}

return true;

could just be the single line:

return $followedBySemicolon;

But besides of that, you are forgetting white spaces :)

What could be done instead, is change line 525

$nextToReturn = $file->findNext([T_WHITESPACE], $returnPosition, null, true, null, true);

in

$nextToReturn = $file->findNext([T_WHITESPACE, T_NULL], $returnPosition, null, true, null, true);

So, we search the token after the return *excluding white spaces and null. Which means that we have to return true only if what remain is the end of line...

so line 526 could became just:

return ($tokens[$nextToReturn]['code'] ?? '') === T_SEMICOLON;

We save 10 lines of code, and we make sure that it works also for things like return null; which makes the PR code fail...

[widoz]

followedBySemicolon: I thought reading the variable names the reading get facilitated since we want to known if there we have a valid return statement.

Ok I'll change it.

Regarding the space I was thinking you refered to the space after the return but not the one before the end statement.

Is there a reason why I want to have a space between the null and the ;?
When we search using findNext excluding [T_WHITESPACE, T_NULL] means the T_NULL must be present otherwise the returned value will be incorrect?

[widoz]

When you says

we make sure that it works also for things like return null; which makes the PR code fail...

Trying a fixture using the code below the tests pass.

function hh(): void {
    return null;
}

I missing something?

[gmazzap]

Is there a reason why I want to have a space between the null and the ;?

The things is not if there's a reason. This is an helper that returns true/false if the target function respectively, return null/void or not. You know nothing about where this helper will be used.

Assuming that you have a code like this:

function test(): void {
  return ;
}

and you run this helper to this function, with your old code the the helper had returned false, and the sniff as result had shown an error like "Non-void return for void return type.", which off course is misleading, because the function actually return void like the return type states.

Maybe there will be another sniff that will check for that space and will show a proper warning message if the space is not allowed by the styles... but the responsibility of the helper is to check if the function has a non-void return type, and because PHP ignore white spaces, the helper needs to ignore white spaces as well.