• Install now

Rule return_to_yield_from

If the function explicitly returns an array, and has the return type iterable, then yield from must be used instead of return.

Examples

Example #1

--- Original
+++ New
 <?php function giveMeData(): iterable {
-    return [1, 2, 3];
+    yield from [1, 2, 3];
 }

References

• Fixer class: PhpCsFixer\Fixer\ArrayNotation\ReturnToYieldFromFixer

• Test class: PhpCsFixer\Tests\Fixer\ArrayNotation\ReturnToYieldFromFixerTest

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.