implement FunctionReflection/ExtendedMethodReflection returnsByReference()

[staabm]

closes phpstan/phpstan#6005

[staabm]

since return-by-reference cannot be annotated by phpdocs only, I just ignore phpdocs regarding return-by-reference

[phpstan-bot]

This pull request has been marked as ready for review.

[ondrejmirtes]

When you get back to this one, first thing to change is that returnsByReference returns TrinaryLogic. This is necessary for unions and intersections.

[staabm]

When you get back to this one, first thing to change is that returnsByReference returns TrinaryLogic

done

[phpstan-bot]

This pull request has been marked as ready for review.

[staabm]

I tried adding tests for the case of unknown-functions, classes, and/or methods:

There were 5 errors:

1) PHPStan\Reflection\FunctionReflectionTest::testFunctionReturnsByReference with data set #1 ('\someUnknownFunction', PHPStan\TrinaryLogic Object (...))
PHPStan\Broker\FunctionNotFoundException: Function \someUnknownFunction not found while trying to analyse it - discovering symbols is probably not configured properly.

C:\dvl\Workspace\phpstan-src-staabm\src\Reflection\BetterReflection\BetterReflectionProvider.php:238
C:\dvl\Workspace\phpstan-src-staabm\tests\PHPStan\Reflection\FunctionReflectionTest.php:151

2) PHPStan\Reflection\FunctionReflectionTest::testMethodReturnsByReference with data set #0 ('ReturnsByReference\SomeUnknownClass', 'foo', PHPStan\TrinaryLogic Object (...))
PHPStan\Broker\ClassNotFoundException: Class ReturnsByReference\SomeUnknownClass was not found while trying to analyse it - discovering symbols is probably not configured properly.

C:\dvl\Workspace\phpstan-src-staabm\src\Reflection\BetterReflection\BetterReflectionProvider.php:121
C:\dvl\Workspace\phpstan-src-staabm\tests\PHPStan\Reflection\FunctionReflectionTest.php:186

3) PHPStan\Reflection\FunctionReflectionTest::testMethodReturnsByReference with data set #3 ('ReturnsByReference\X', 'someUnknownFunction', PHPStan\TrinaryLogic Object (...))
PHPStan\Reflection\MissingMethodFromReflectionException: Method someUnknownFunction() was not found in reflection of class ReturnsByReference\X.

C:\dvl\Workspace\phpstan-src-staabm\src\Reflection\ClassReflection.php:428
C:\dvl\Workspace\phpstan-src-staabm\tests\PHPStan\Reflection\FunctionReflectionTest.php:193

4) PHPStan\Reflection\FunctionReflectionTest::testMethodReturnsByReference with data set #7 ('ReturnsByReference\SubX', 'someUnknownFunction', PHPStan\TrinaryLogic Object (...))
PHPStan\Reflection\MissingMethodFromReflectionException: Method someUnknownFunction() was not found in reflection of class ReturnsByReference\SubX.

C:\dvl\Workspace\phpstan-src-staabm\src\Reflection\ClassReflection.php:428
C:\dvl\Workspace\phpstan-src-staabm\tests\PHPStan\Reflection\FunctionReflectionTest.php:193

5) PHPStan\Reflection\FunctionReflectionTest::testMethodReturnsByReference with data set #10 ('ReturnsByReference\TraitX', 'someUnknownFunction', PHPStan\TrinaryLogic Object (...))
PHPStan\Reflection\MissingMethodFromReflectionException: Method someUnknownFunction() was not found in reflection of class ReturnsByReference\TraitX.

C:\dvl\Workspace\phpstan-src-staabm\src\Reflection\ClassReflection.php:428
C:\dvl\Workspace\phpstan-src-staabm\tests\PHPStan\Reflection\FunctionReflectionTest.php:193

these run into a exception right now... should this exception be catched and TrinaryLogic::createMaybe() be returned instead?

[ondrejmirtes]

Thank you!

[staabm]

thanks for the in-detail review @ondrejmirtes. much appreciated.