Functions::containsToken()

[GaryJones]

Idea: have a way to see if a function contains a particular token, or some combination of tokens:

Functions::containsToken( `$function_name`, $token );
// or
Functions::containsToken( $stackPtr, $token );

Perhaps could also handle the logic for Class::methodContainsToken() or similar as well.

[jrfnl]

Would this be for the function the original $stackPtr was found in ? Or another function in the same file ?

[GaryJones]

Specific use case is trying to determine if a filter callback contains T_RETURN or not.

With sensible guard clauses to reduce the amount of time this had to run, I'd expect any Functions::containsToken() call to find the function opener and closer for $function_name, and look at each of the tokens in between to see if matches $token.

It would allow sniff-writers to be less concerned with finding and looping through opener and closer tokens, and be able to ask "Does this function contain a return [token]?"

For a combination of tokens, $token might be an array, and the lookup would allow for T_WHITESPACE in between or something (less of an concrete idea about this bit at the moment).

[jrfnl]

See my side-note about this here: #122 (comment)

[GaryJones]

something like Method::containsToken( [ 'Foo', 'bar' ], T_RETURN ); would still not be reliable as the method may not contain a T_RETURN for all exit paths in the method or could contain a nested closure which has a return, but the function itself does not.

At least for the second one, perhaps the Functions::containsToken() should consider excluding tokens not in the the immediate function scope?