<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Gets the function name of the generator</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectiongenerator.getexecutingline.html">ReflectionGenerator::getExecutingLine</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectiongenerator.getthis.html">ReflectionGenerator::getThis</a></div>
<div class="up"><a href="class.reflectiongenerator.html">ReflectionGenerator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="reflectiongenerator.getfunction" class="refentry">
<div class="refnamediv">
<h1 class="refname">ReflectionGenerator::getFunction</h1>
<p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">ReflectionGenerator::getFunction</span> — <span class="dc-title">Gets the function name of the generator</span></p>
</div>
<div class="refsect1 description" id="refsect1-reflectiongenerator.getfunction-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.reflectionfunctionabstract.html" class="type ReflectionFunctionAbstract">ReflectionFunctionAbstract</a></span> <span class="methodname"><strong>ReflectionGenerator::getFunction</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Enables the function name of the generator to be obtained by returning a
class derived from <a href="class.reflectionfunctionabstract.html" class="classname">ReflectionFunctionAbstract</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-reflectiongenerator.getfunction-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-reflectiongenerator.getfunction-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a <a href="class.reflectionfunctionabstract.html" class="classname">ReflectionFunctionAbstract</a> class. This will
be <a href="class.reflectionfunction.html" class="classname">ReflectionFunction</a> for functions, or
<a href="class.reflectionmethod.html" class="classname">ReflectionMethod</a> for methods.
</p>
</div>
<div class="refsect1 examples" id="refsect1-reflectiongenerator.getfunction-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-6480">
<p><strong>Example #1 <span class="methodname"><strong>ReflectionGenerator::getFunction()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">function </span><span style="color: #0000BB">gen</span><span style="color: #007700">()<br />{<br /> </span><span style="color: #0000BB">yield 1</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$gen </span><span style="color: #007700">= </span><span style="color: #0000BB">gen</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$reflectionGen </span><span style="color: #007700">= new </span><span style="color: #0000BB">ReflectionGenerator</span><span style="color: #007700">(</span><span style="color: #0000BB">$gen</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$reflectionGen</span><span style="color: #007700">-></span><span style="color: #0000BB">getFunction</span><span style="color: #007700">());</span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
object(ReflectionFunction)#3 (1) {
["name"]=>
string(3) "gen"
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-reflectiongenerator.getfunction-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="reflectiongenerator.getthis.html" class="methodname" rel="rdfs-seeAlso">ReflectionGenerator::getThis()</a> - Gets the $this value of the generator</span></li>
<li class="member"><span class="methodname"><a href="reflectiongenerator.gettrace.html" class="methodname" rel="rdfs-seeAlso">ReflectionGenerator::getTrace()</a> - Gets the trace of the executing generator</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectiongenerator.getexecutingline.html">ReflectionGenerator::getExecutingLine</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectiongenerator.getthis.html">ReflectionGenerator::getThis</a></div>
<div class="up"><a href="class.reflectiongenerator.html">ReflectionGenerator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
