<!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 trace of the executing generator</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectiongenerator.getthis.html">ReflectionGenerator::getThis</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.reflector.html">Reflector</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.gettrace" class="refentry">
<div class="refnamediv">
<h1 class="refname">ReflectionGenerator::getTrace</h1>
<p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">ReflectionGenerator::getTrace</span> — <span class="dc-title">Gets the trace of the executing generator</span></p>
</div>
<div class="refsect1 description" id="refsect1-reflectiongenerator.gettrace-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>ReflectionGenerator::getTrace</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = DEBUG_BACKTRACE_PROVIDE_OBJECT</span></span>
] )</div>
<p class="para rdfs-comment">
Get the trace of the currently executing generator.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-reflectiongenerator.gettrace-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">options</code></dt>
<dd>
<p class="para">
The value of <code class="parameter">options</code> can be any of the following
the following flags.
</p>
<p class="para">
<table class="doctable table">
<caption><strong>Available options</strong></caption>
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>
<strong><code>DEBUG_BACKTRACE_PROVIDE_OBJECT</code></strong>
</td>
<td>
Default.
</td>
</tr>
<tr>
<td>
<strong><code>DEBUG_BACKTRACE_IGNORE_ARGS</code></strong>
</td>
<td>
Don't include the argument information for functions in the stack
trace.
</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-reflectiongenerator.gettrace-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the trace of the currently executing generator.
</p>
</div>
<div class="refsect1 examples" id="refsect1-reflectiongenerator.gettrace-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-6482">
<p><strong>Example #1 <span class="methodname"><strong>ReflectionGenerator::getTrace()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">foo</span><span style="color: #007700">() {<br /> </span><span style="color: #0000BB">yield 1</span><span style="color: #007700">;<br />}<br /><br />function </span><span style="color: #0000BB">bar</span><span style="color: #007700">()<br />{<br /> </span><span style="color: #0000BB">yield from foo</span><span style="color: #007700">();<br />}<br /><br />function </span><span style="color: #0000BB">baz</span><span style="color: #007700">()<br />{<br /> </span><span style="color: #0000BB">yield from bar</span><span style="color: #007700">();<br />}<br /><br /></span><span style="color: #0000BB">$gen </span><span style="color: #007700">= </span><span style="color: #0000BB">baz</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$gen</span><span style="color: #007700">-></span><span style="color: #0000BB">valid</span><span style="color: #007700">(); </span><span style="color: #FF8000">// start the generator<br /><br /></span><span style="color: #0000BB">var_dump</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">))-></span><span style="color: #0000BB">getTrace</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>
array(2) {
[0]=>
array(4) {
["file"]=>
string(18) "example.php"
["line"]=>
int(8)
["function"]=>
string(3) "foo"
["args"]=>
array(0) {
}
}
[1]=>
array(4) {
["file"]=>
string(18) "example.php"
["line"]=>
int(12)
["function"]=>
string(3) "bar"
["args"]=>
array(0) {
}
}
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-reflectiongenerator.gettrace-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="reflectiongenerator.getfunction.html" class="methodname" rel="rdfs-seeAlso">ReflectionGenerator::getFunction()</a> - Gets the function name of the generator</span></li>
<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>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectiongenerator.getthis.html">ReflectionGenerator::getThis</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.reflector.html">Reflector</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>
