File: Swoole_Table.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 (124 lines) | stat: -rw-r--r-- 5,336 bytes parent folder | download | duplicates (2)
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Swoole\Table" namespace="Swoole" name="Table">
  <implements name="Iterator" full="Iterator"/>
  <constant name="TYPE_INT" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_STRING" value="7">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TYPE_FLOAT" value="6">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="column" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the data type and size of the columns."/>
      <return type="ReturnType"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="type" optional="false" byreference="false" type="string"/>
    <parameter name="size" optional="true" byreference="false" type="object" class="integer"/>
  </method>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Count the rows in the table, or count all the elements in the table if $mode = 1."/>
      <return type="integer"/>
    </docblock>
  </method>
  <method name="create" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create the swoole memory table."/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the current row."/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="decr" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Decrement the value in the Swoole table by $row_key and $column_key."/>
      <return type="ReturnType"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
    <parameter name="column" optional="false" byreference="false" type="string"/>
    <parameter name="decrby" optional="true" byreference="false" type="object" class="integer"/>
  </method>
  <method name="del" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Delete a row in the Swoole table by $row_key."/>
      <return type="void"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
  </method>
  <method name="destroy" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Destroy the Swoole table."/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="exist" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if a row is existed by $row_key."/>
      <return type="boolean"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
  </method>
  <method name="get" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the value in the Swoole table by $row_key and $column_key."/>
      <return type="integer"/>
    </docblock>
    <parameter name="row_key" optional="false" byreference="false" type="string"/>
    <parameter name="column_key" optional="false" byreference="false" type="string"/>
  </method>
  <method name="incr" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Increment the value by $row_key and $column_key."/>
      <return type="void"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
    <parameter name="column" optional="false" byreference="false" type="string"/>
    <parameter name="incrby" optional="true" byreference="false" type="object" class="integer"/>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the key of current row."/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Iterator the next row."/>
      <return type="ReturnType"/>
    </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="set" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Update a row of the table by $row_key."/>
      <return type="VOID"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check current if the current row is valid."/>
      <return type="boolean"/>
    </docblock>
  </method>
</class>