File: ReflectionGenerator.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (47 lines) | stat: -rw-r--r-- 2,082 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ReflectionGenerator" namespace="" name="ReflectionGenerator">
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a ReflectionGenerator object"/>
      <return type="void"/>
    </docblock>
    <parameter name="generator" optional="false" byreference="false" type="object" class="Generator"/>
  </constructor>
  <method name="getExecutingFile" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the file name of the currently executing generator"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getExecutingGenerator" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the executing Generator object"/>
      <return type="Generator"/>
    </docblock>
  </method>
  <method name="getExecutingLine" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the currently executing line of the generator"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getFunction" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the function name of the generator"/>
      <return type="ReflectionFunctionAbstract"/>
    </docblock>
  </method>
  <method name="getThis" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the $this value of the generator"/>
      <return type="object"/>
    </docblock>
  </method>
  <method name="getTrace" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the trace of the executing generator"/>
      <return type="array"/>
    </docblock>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </method>
</class>