Is there a way to document that a particular function calls exit()?
The use case is that we have a function that is responsible for handling redirects (checks for already sent headers, set the response code, etc...) and then crucially calls exit(). Unfortunately, PHPStorm has no idea that this particular function terminates execution and thus suggests further warnings as if this function has returned when in practice, it never would.
At the moment it's not possible.
https://youtrack.jetbrains.com/issue/WI-10673 -- watch this ticket (star/vote/comment) to get notified on progress.
ATM I may only suggest placing explicit die() or exit() calls after such function calls.
I know it's too old but now you can describe a function or method that calls die() or exit() by using @return never in PHPDoc:
/**
* @return never
*/
function dead_inside(): void
{
die();
}
UPD: Looks like they changed something or that's my fault. @return never doesn't work now as described here, so you should use either @return never-return or @return never-returns (thanks to Lucian P.). Do not forget to declare void as return type just to keep code clean.
@return never and void return definition to every function that call a function that calls a function ... that calls a function that calls die() or exit()void return type AND @return never PHPDoc or PHPStorm will show "Unreachable statement" warning below your dead_inside() function call
@return never-returns and @return never-return as requested, while @return never is ignored.