Getting function attributes from $scope

[spaze]

Hi,

first, a bit of a context: as part of my disallowed calls extension, I'm writing a custom rule that would report an error when a function or a method is called in a function based on the attribute on the function.

In the following code, call would be reported as an error in one because there's Attribute, but not in two.

#[\Attribute]
function one(): void
{
	call();
}

function two(): void
{
	call();
}

And here's the problem I'm facing: using $scope, I'm unable to get attributes on functions, while I can get them on methods.

I have tried several things, for example

$this->reflectionProvider->getFunction(new Name($scope->getFunction()->getName()), $scope);

this returns PHPStan\Reflection\Php\PhpFunctionReflection, which even though it has a property of type
PHPStan\BetterReflection\Reflection\Adapter\ReflectionFunction it doesn't use it to call ReflectionFunction::getAttributes, and it is not even marked as @api so not really usable even if a new method would be added.

I have also tried checking PHPStan\Reflection\Php\PhpFunctionFromParserNodeReflection which is what $scope->getFunction() returns, but no way of accessing the attributes. There's FunctionLike property in PhpFunctionFromParserNodeReflection, which could then be used to get the attributes (with FunctionLike::$attrGroups) but the getFunctionLike method in PhpFunctionFromParserNodeReflection is protected.

Strings would be fine, even though the best would be to get the attributes as a list of \PHPStan\BetterReflection\Reflection\Adapter\ReflectionAttribute which is what I get for method attributes with

$scope->getClassReflection()->getNativeReflection()->getMethod($scope->getFunction()->getName())->getAttributes()

Any help is appreciated, thanks.

[spaze]

I'm now using

(new \PHPStan\BetterReflection\Reflection\Adapter\ReflectionFunction($this->reflector->reflectFunction($functionName)))->getAttributes();

which is taken from \PHPStan\Reflection\BetterReflection\BetterReflectionProvider::getCustomFunction and could also be used without the new ...Adapter\ReflectionFunction call (it returns different attribute objects though). Can't use getCustomFunction directly, because just like getFunction it returns \PHPStan\Reflection\Php\PhpFunctionReflection which is non-@api and doesn't return attributes either.

Not sure if this is the best way there is, but couldn't figure out anything better. Would still appreciate an expert insight on this :-)

[ondrejmirtes]

Wouldn't it be nice 🎵 to have easy access to attributes ON EVERYTHING!? Well, I just spent a few hours today on that 😊 phpstan/phpstan-src@a387fa3

You can now call ->getAttributes() on any thinkable reflection object, including $scope->getFunction() and you'll get a new PHPStan's AttributeReflection class: https://apiref.phpstan.org/2.1.x/PHPStan.Reflection.AttributeReflection.html

I'm going to release it in a few days, but you can already require "phpstan/phpstan": "^2.1.3" (alongside minimum-stability: dev and prefer-stable: true) and take advantage of it!

I welcome any feedback about it.

[spaze]

Indeed, that would be nice ☺️ Thank you, this makes the code much nicer and more straightforward. Two questions:

1. Is this going only to 2.x? I'm trying to keep the extension compatible with 1.x but I can live with this being available only in 2.x and provide a compat layer as I already do for some methods.
2. What would be the best way to get attributes on all class methods? I'm using

    	foreach ($scope->getClassReflection()->getNativeReflection()->getMethods() as $method) {
    		$methodAttributes = $method->getAttributes();

   but that returns a list of \PHPStan\BetterReflection\Reflection\Adapter\ReflectionAttribute which is a different object than the new AttributeReflection one. They both have getName() method so that's not a big deal but if I'd like to have that unified I could do new AttributeReflection or use some safe "PHPStan-way" which would hide all the implementation details - because getMethods() is in ondrejmirtes/better-reflection and I'm not sure if that's a good idea to rely on that as that's not covered by the backwards promise (as it's not technically part of PHPStan).

[ondrejmirtes]

Is this going only to 2.x?

Yes. I'm trying my best and still do many things on 1.12.x and merge them to 2.x after, but in this case there would be too many conflicts so I decided it's okay to do this new feature only on 2.1.x.

I recommend you to support only 2.x in new releases of your extension, you'd run into problems sooner or later anyway. Doing a compatibility layer erases all benefits of the nice API I implemented yesterday :)

What would be the best way to get attributes on all class methods?

I deprecated (phpstan/phpstan-src@ca7e9ef) and removed (phpstan/phpstan-src@d2c1446) a way to get all methods on ClassReflection because it's computationally expensive and was often misused.

What are you trying to achieve? Please think that such method if it existed should return all methods including private and parent ones.

You can do $scope->getClassReflection()->getNativeReflection()->getMethods(), filter which methods are you actually interested in, and only on those methods do $scope->getClassReflection->getNativeMethod($name) which will give you PHPStan's reflection with the nice new getAttributes() method.

[spaze]

I recommend you to support only 2.x in new releases of your extension

Tried supporting 1.x as long as it is easy enough, but this may be where I'll draw the line :-)

What are you trying to achieve?

Dis/allow a specified method call only in a class which has a given attribute on any method in the class (a feature request here) so all methods is fine I guess :-)

$scope->getClassReflection->getNativeMethod($name) which will give you PHPStan's reflection with the nice new getAttributes() method.

This is cool, thanks!