Best way to document (phpdoc) generators (methods that yield)

php generator phpdoc php-5.5
Mat-Locomotive picture Mat-Locomotive · May 6, 2015 · Viewed 8.5k times · Source

What is the best way to document, for phpdocumentor2, a method that is a generator.

I don't think @return really works for yield, but I can't seem to find any proper alternative.

Is it just a matter of waiting for phpdoc to catch up?

Answer

Robbert picture Robbert · Apr 30, 2016

I went with @return Generator|SomeObject[], where SomeObject is the thing being yielded.

PhpStorm handles this well too, as it now normally hints Generator methods and when iterated it hints SomeObject methods.

(Still, I would prefer a native @yield.)

Related questions

What does yield mean in PHP?

I've recently stumbled over this code: function xrange($min, $max) { for ($i = $min; $i <= $max; $i++) { yield $i; } } I've never seen this yield keyword before. Trying to run the code I get Parse error: syntax error, unexpected T_VARIABLE …

Read More
PHP API Key Generator

Does anyone know of any API key generator script/class for PHP? The class should have method generate, that would generate a key and isValid() method, to check if the key is valid.

Read More
PHP brute force password generator

I want to be able to input a number and get a password, built from a string or unique characters. So if I have two characters in the string : $string = "AB"; these are the desired results : -in-|-out- 0 | A 1 | B 2 | …

Read More