Как в IDE в PHPDoc для генератора указать тип возвращаемого ресурса?

Question

[Владимир Голубев]

Имеется функция-генератор вида:

/**
     * @return Generator|void
     */
function generator()
{
    foreach($someResource as $object) {
        if ($object instanceOf SomeClass)
            yield $object;
    }
    return;
}

Можно ли указать в первом комментария что-то дополнительное, чтобы IDE понимала, объект какого класса возвращается генератором на каждой итерации?

Comments

[Nik Gubin]

Нет, только список возможных типов данных через "|".
PHPDoc не имеет никакой логики внутри, оно просто подсвечивает несостыковки между запрашиваемым и получаемым, и точно не сможет считать итерации))

[Владимир Голубев]

Nik Gubin: Но ведь тут достаточно явная конструкция, этот генератор на каждой итерации foreach всегда будет возвращать только объекты SomeClass, без вариантов, и чтобы IDE подсвечивала их методы и свойства, ей нужно только влепить где-либо подсказку, странно, что это не поддерживается из коробки...

[Nik Gubin]

Владимир Голубев: так, стоп. Метод возвращает ТОЛЬКО SomeClass или на каждую итерацию "SomeClass{i++}"? Если первый вариант, то почему бы не сделать @return SomeClass, а если второй, то как вы предлагаете идешке ванговать ваши итерации? Пять их, или сто, и где хранить, если это просто комментарий, разобранный IDE для подсветки и подсказок.

[Владимир Голубев]

Nik Gubin: Да, метод возвращает ТОЛЬКО объекты класса SomeClass, но @return SomeClass не работает, поскольку метод не ВОЗВРАЩАЕТ объект, он yield-ит их(не знаю как это перевести), и воспринимается как массив, соответственно, вопрос был про то, что в методе
foreach(generator() as $obj)
ide понимала, что этот генератор возвращает объекты SomeClass.
Собственно, Boris Korobkov дал рабочий вариант ( @return Generator|SomeClass[]), вариант с @return SomeClass[] тоже кстати работает.

[Nik Gubin]

Владимир Голубев:

(не знаю как это перевести)

Сойдёмся на "Производит")) Ну хорошо, что решили. Я с генераторами напрямую редко работаю, сразу в задачу не вник.

Answer 1

[Boris Köln]

К сожалению, нативного @yield нет. Можно только костылить типа @return Generator|SomeClass[]

Comments

[Владимир Голубев]

Так это же как раз то что нужно, спасибо) нативный yield я сразу же проверил, он не сработал, но хорошо хоть такой хак есть)

[Nik Gubin]

Владимир Голубев: а я почему то думал, что свой класс на каждую итерацию, т.е. FooClass для первой, BarClass для второй и т.д) Хорошо, что ответ найден. Но могу включить режим зануды и скинуть ссылочку на доку)) Пригодится всё-равно.

[Владимир Голубев]

Nik Gubin: Я тоже могу включить режим зануды, и рассказать что доку я посетил в первую очередь )))
Но yield я там не нашёл, а в описании return нету упоминания про возможность указания скобок)

[Boris Köln]

в описании return нету упоминания про возможность указания скобок

https://www.phpdoc.org/docs/latest/references/phpd...

array-of-type = type "[]"