The Generator class

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

Introduction

Generator objects are returned from generators.

Caution

Generator objects cannot be instantiated via new.

Class synopsis

final class Generator implements Iterator {

/* Methods */

public function current(): mixed

public function getReturn(): mixed

public function key(): mixed

public function next(): void

public function rewind(): void

public function send(mixed $value): mixed

public function throw(Throwable $exception): mixed

public function valid(): bool

public function __wakeup(): void

}

See Also

See also object iteration.

Table of Contents

Generator::current — Get the yielded value
Generator::getReturn — Get the return value of a generator
Generator::key — Get the yielded key
Generator::next — Resume execution of the generator
Generator::rewind — Execute the generator up to and including the first yield
Generator::send — Send a value to the generator
Generator::throw — Throw an exception into the generator
Generator::valid — Check if the iterator has been closed
Generator::__wakeup — Serialize callback