Generator::rewind — Выполняет генератор до первого выражения yield

Назначение Generator::rewind

Generator::rewind: Выполняет генератор до первого выражения yield. Справочная сущность относится к разделу «language». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается Generator::rewind

Эта страница описывает член rewind класса Generator, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: аргументов нет; объявленный результат — void.

Смысловое направление Generator::rewind

Смысловое направление Generator::rewind — «операция rewind». В прикладном коде свяжите вызов Generator::rewind с одним явно сформулированным результатом прикладного сценария. Контрольный набор для этой операции: проверьте штатное выполнение, граничное состояние и документированный отказ. Такой акцент отделяет Generator::rewind от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура Generator::rewind

Структурная запись: public void Generator::rewind(). В ней 0 параметров: аргументов нет. Результат объявлен как void; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры Generator::rewind

Generator::rewind не принимает аргументов: вызов выполняют с пустым списком параметров. Для Generator::rewind фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для Generator::rewind

Generator::rewind не принимает аргументов. Качество вызова определяется состоянием объекта или окружения: зафиксируйте версию PHP, доступность расширения «language» и исходное состояние до выполнения, затем сравните наблюдаемый результат после вызова.

Результат Generator::rewind

Generator::rewind объявляет результат типа void. Generator::rewind объявлена с результатом void. Проверяйте наблюдаемый эффект и диагностику вызова; присваивание результата не подтверждает успешность операции.

Проверочный сценарий для Generator::rewind

Подготовьте объект Generator в минимально допустимом состоянии. Сначала выполните контрольный вызов без аргументов. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «контракт PHP» важно зафиксировать предусловия вызова и не подавлять диагностические сообщения; негативный сценарий должен проверить штатный результат, граничный вход и документированный отказ.

Интеграция Generator::rewind в проект

Храните подготовку Generator и вызов Generator::rewind в одном понятном жизненном цикле; не скрывайте обязательное состояние объекта в глобальной переменной. Для профиля «контракт PHP» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция Generator::rewind не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика Generator::rewind

Сначала запишите точную сигнатуру public void Generator::rewind() и фактические типы переданных значений. Затем проверьте состояние экземпляра Generator непосредственно перед методом Generator::rewind. Если результат неожиданен, сравните его тип с void и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «контракт PHP» применяйте отдельный негативный тест: проверить штатный результат, граничный вход и документированный отказ. В production-коде важно зафиксировать предусловия вызова и не подавлять диагностические сообщения. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать Generator::rewind

Выбор Generator::rewind оправдан, когда одновременно выполнены три условия: 1) объект действительно относится к Generator; 2) вызов не принимает аргументы; 3) вызывающему коду нужен результат void и действие «операция rewind». Для профиля «контракт PHP» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с InternalIterator::rewind: у него другое назначение, владелец или набор входных данных.

Сравнение Generator::rewind с соседними API

Для Generator::rewind базовый ориентир: выполняет генератор до первого выражения yield; аргументов нет; результат void. Совпадение имени rewind не делает методы взаимозаменяемыми: Generator::rewind принадлежит Generator, а InternalIterator::rewind — InternalIterator. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: InternalIterator::rewind: перематывает итератор к первому элементу; вход — аргументов нет; результат — void. Iterator::rewind: возвращает итератор на первый элемент; вход — аргументов нет; результат — void. Generator::next: возобновляет работу генератора; вход — аргументов нет; результат — void. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

Generator::rewind сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для Generator::rewind.

Связанные материалы