File: Generator.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 (60 lines) | stat: -rw-r--r-- 2,720 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
48
49
50
51
52
53
54
55
56
57
58
59
60
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Generator" namespace="" name="Generator">
  <implements name="Iterator" full="Iterator"/>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the yielded value"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="getReturn" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the return value of a generator"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the yielded key"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Resume execution of the generator"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind the iterator"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="send" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send a value to the generator">Sends the given value to the generator as the result of the current yield expression and resumes execution of the generator.</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="throw" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Throw an exception into the generator">Throws an exception into the generator and resumes execution of the generator. The behavior will be the same as if the current yield expression was replaced with a throw $exception statement.</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="exception" optional="false" byreference="false" type="object" class="Throwable"/>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if the iterator has been closed"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="__wakeup" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Serialize callback"/>
      <return type="void"/>
    </docblock>
  </method>
</class>