ReflectionGenerator::getTrace

Gets the trace of the executing generator

&reftitle.description; public `array` `ReflectionGenerator::getTrace` `int` `options` `DEBUG_BACKTRACE_PROVIDE_OBJECT`

Get the trace of the currently executing generator.

&reftitle.parameters;

`options`

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

  ## Available options

  Option | Description
  `DEBUG_BACKTRACE_PROVIDE_OBJECT` | Default.
  `DEBUG_BACKTRACE_IGNORE_ARGS` | Don't include the argument information for functions in the stack trace.

&reftitle.returnvalues;

Returns the trace of the currently executing generator.

&reftitle.examples;

### `ReflectionGenerator::getTrace` example

    <?php
    function foo() {
        yield 1;
    }

    function bar()
    {
        yield from foo();
    }

    function baz()
    {
        yield from bar();
    }

    $gen = baz();
    $gen->valid(); // start the generator

    var_dump((new ReflectionGenerator($gen))->getTrace());

&example.outputs.similar;

    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) {
        }
      }
    }

&reftitle.seealso;

- `ReflectionGenerator::getFunction`
- `ReflectionGenerator::getThis`