The Generator class

The Generator class

Introduction

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

Generator objects are returned from generators.

Caution Generator objects cannot be instantiated via new.

Class synopsis

final class Generator implements Iterator {

/* Methods */

public current(): mixed

public getReturn(): mixed

public key(): mixed

public next(): void

public rewind(): void

public send(mixed $value): mixed

public throw(Throwable $exception): mixed

public valid(): bool

public __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 — Rewind the iterator
• 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

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.generator.php