File: Mongo.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 (156 lines) | stat: -rw-r--r-- 6,789 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Mongo" namespace="" name="Mongo">
  <extends name="MongoClient" full="MongoClient"/>
  <method name="connectUtil" abstract="false" static="false" visibility="protected" final="false">
    <docblock>
      <description compact="Connects with a database server"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getPoolSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get pool size for connection pools"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getSlave" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the address being used by this for slaveOkay reads">This finds the address of the secondary currently being used for reads. It is a read-only method: it does not change anything about the internal state of the object.</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getSlaveOkay" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get slaveOkay setting for this connection"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="poolDebug" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns information about all connection pools"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="setPoolSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the size for future connection pools"/>
      <return type="bool"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setSlaveOkay" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Change slaveOkay setting for this connection"/>
      <return type="bool"/>
    </docblock>
    <parameter name="ok" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="switchSlave" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Choose a new secondary for slaveOkay reads">This choses a random secondary for a connection to read from. It is called automatically by the driver and should not need to be used. It calls MongoClient::getHosts (to refresh the status of hosts) and Mongo::getSlave (to get the return value).</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="close" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
    <parameter name="connection" optional="true" byreference="false" type="object" class="boolean|string"/>
  </method>
  <method name="connect" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="dropDB" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="array"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="__get" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="MongoDB"/>
    </docblock>
    <parameter name="dbname" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getConnections" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getHosts" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getReadPreference" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getWriteConcern" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="killCursor" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
    <parameter name="server_hash" optional="false" byreference="false" type="string"/>
    <parameter name="id" optional="false" byreference="false" type="object" class="int|MongoInt64"/>
  </method>
  <method name="listDBs" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="selectCollection" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="MongoCollection"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="collection" optional="false" byreference="false" type="string"/>
  </method>
  <method name="selectDB" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="MongoDB"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setReadPreference" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
    <parameter name="read_preference" optional="false" byreference="false" type="string"/>
    <parameter name="tags" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="setWriteConcern" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
    <parameter name="w" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="wtimeout" optional="true" byreference="false" type="int"/>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="string"/>
    </docblock>
  </method>
</class>