ReflectionGenerator::getFunction

Gets the function name of the generator

Description

public ReflectionFunctionAbstract ReflectionGenerator::getFunction()

Enables the function name of the generator to be obtained by returning a class derived from ReflectionFunctionAbstract.

Parameters

This function has no parameters.

Return Values

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

Changelog

Version Description
8.4.0 ReflectionGenerator::getFunction may now be called after the generator finished executing.

Examples

Example #1 ReflectionGenerator::getFunction example

<?php

function gen()
{
    yield 1;
}

$gen = gen();

$reflectionGen = new ReflectionGenerator($gen);

var_dump($reflectionGen->getFunction());

The above example will output something similar to:

object(ReflectionFunction)#3 (1) {
  ["name"]=>
  string(3) "gen"
}

See Also

  • ReflectionGenerator::getThis
  • ReflectionGenerator::getTrace