File::contains*()

[GaryJones]

Idea: a way to check if the current file contains a class, interface, trait, function, assignment to a global constant and perhaps other items.

These would be stepping stones to then having other code which could then analyse them - for instance:

if ( File::containsClass( 'Foo' ) && Class:containsMethod( 'Foo', 'bar' ) ) {
	$has_return = Method::containsToken( [ 'Foo', 'bar' ], T_RETURN );
}

Maybe some of these utility methods take stack pointers rather than strings for classes, methods, etc., but the idea is that those less familiar with writing standards can think in terms of the PHP structures that they are familiar with, rather than tokens - PHPCSUtils can handle that layer between PHP structures and tokens.

[jrfnl]

I think I can guess your use-case for this question: checking if functions used as filters in WP have a return statement... Correct ?

I'm not keen on those kind of methods as they would always be highly inefficient. Those kind of things would be better handled by setting up an (abstract) sniff which listens to the right tokens.

Note: and would still not handle cross-file sniffing.

[GaryJones]

As highlighted by that use case, the focus of the sniff may not be just about "Does this file contain X or not?", so an abstract sniff is not suitable, but it is one of the parts of the logic needed for a deeper look at whether, in this case, "Does a function have a return?".

I'm not keen on those kind of methods as they would always be highly inefficient.

Maybe, but that's all the more reason for PHPCSUtils to find what is the most efficient way, and explain the types of guard clauses that could be used, rather than everyone struggling to come up with their own version that is even more inefficient.

[jrfnl]

I'll have a think about this. Let me sleep on it. It may be a while before I get to these.

[jrfnl]

Side-note: 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.