File: TokyoTyrantQuery.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 (98 lines) | stat: -rw-r--r-- 4,117 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
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="TokyoTyrantQuery" namespace="" name="TokyoTyrantQuery">
  <implements name="Iterator" full="Iterator"/>
  <method name="addCond" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Adds a condition to the query"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="op" optional="false" byreference="false" type="int"/>
    <parameter name="expr" optional="false" byreference="false" type="string"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Construct a new query"/>
      <return type="void"/>
    </docblock>
    <parameter name="table" optional="false" byreference="false" type="object" class="TokyoTyrantTable"/>
  </constructor>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Counts records"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the current element"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="hint" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the hint string of the query"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the current key"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="metaSearch" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve records with multiple queries"/>
      <return type="array"/>
    </docblock>
    <parameter name="queries" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="type" optional="false" byreference="false" type="int"/>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Moves the iterator to next entry"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="out" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes records based on query"/>
      <return type="TokyoTyrantQuery"/>
    </docblock>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewinds the iterator"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="search" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Searches records"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="setLimit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Limit results"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="max" optional="true" byreference="false" type="int"/>
    <parameter name="skip" optional="true" byreference="false" type="int"/>
  </method>
  <method name="setOrder" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Orders results"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="type" optional="false" byreference="false" type="int"/>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks the validity of current item"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>