Generator (class)

The Generator class

Introduction

(PHP 5 >= 5.5.0, PHP 7)

Generator objects are returned from generators.

Class synopsis

public mixed current ( void )

public mixed getReturn ( void )

public mixed key ( void )

public void next ( void )

public void rewind ( void )

public mixed send ( mixed $value )

public mixed throw ( Throwable $exception )

public bool valid ( void )

public void __wakeup ( void )

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