ReflectionGenerator

Since: 7.0

final class ReflectionGenerator (View source)

The ReflectionGenerator class reports information about a generator.

Methods

__construct(Generator $generator)

Constructs a ReflectionGenerator object

int
getExecutingLine()

Gets the currently executing line of the generator

string
getExecutingFile()

Gets the file name of the currently executing generator

array
getTrace(int $options = DEBUG_BACKTRACE_PROVIDE_OBJECT)

Gets the trace of the executing generator

ReflectionFunctionAbstract
getFunction()

Gets the function name of the generator

object|null
getThis()

Gets the function name of the generator

Generator
getExecutingGenerator()

Gets the executing Generator object

bool
isClosed()

Checks if execution finished

Details

at line 20
__construct(Generator $generator)

Since: 7.0

Constructs a ReflectionGenerator object

Parameters

Generator $generator

A generator object.

at line 30
int getExecutingLine()

Since: 7.0

Gets the currently executing line of the generator

Return Value

int

Returns the line number of the currently executing statement in the generator.

at line 41
string getExecutingFile()

Since: 7.0

Gets the file name of the currently executing generator

Return Value

string

Returns the full path and file name of the currently executing generator.

at line 60
array getTrace(int $options = DEBUG_BACKTRACE_PROVIDE_OBJECT)

Since: 7.0

Gets the trace of the executing generator

Parameters

int $options

The value of options can be any of the following the following flags.

Available options:

{\DEBUG_BACKTRACE_PROVIDE_OBJECT} - Default

{\DEBUG_BACKTRACE_IGNORE_ARGS} - Don't include the argument information for functions in the stack trace.

Return Value

array

Returns the trace of the currently executing generator.

at line 72
ReflectionFunctionAbstract getFunction()

Since: 7.0

Gets the function name of the generator

Return Value

ReflectionFunctionAbstract

Returns a {\ReflectionFunctionAbstract} class. This will be {\ReflectionFunction} for functions, or {\ReflectionMethod} for methods.

at line 83
object|null getThis()

Since: 7.0

Gets the function name of the generator

Return Value

object|null

Returns the $this value, or {\null} if the generator was not created in a class context.

at line 93
Generator getExecutingGenerator()

Since: 7.0

Gets the executing Generator object

Return Value

Generator

Returns the currently executing Generator object.

at line 105
bool isClosed()

Since: 8.4

Checks if execution finished

Returns whether the execution reached the end of the function, a return statement or if an exception was thrown.

Return Value

bool