Error Identifier: generator.outOfFunction
Every error reported by PHPStan has an error identifier. Here’s a list of all error identifiers. In PHPStan Pro you can see the error identifier next to each error and filter errors by their identifiers.
Code example #
<?php declare(strict_types = 1);
yield 1;
yield from doFoo();
Why is it reported? #
The yield and yield from expressions can only be used inside a function or method body. Using them at the top level of a script or in a non-function context is not valid PHP. Generators require a function scope because PHP needs to create a Generator object from the function’s execution context.
How to fix it #
Wrap the yield expression inside a function or method:
-yield 1;
-yield from doFoo();
+function generateValues(): \Generator
+{
+ yield 1;
+ yield from doFoo();
+}
Non-ignorable error #
This error cannot be ignored using @phpstan-ignore or the ignoreErrors configuration. Non-ignorable errors indicate code that would cause a crash or a fatal error at runtime, or a fundamental problem in the analysed code that must be addressed.
Rules that report this error #
- PHPStan\Rules\Generators\YieldInGeneratorRule [1]